Google CloudSQL PostgreSQL Connection

The Google CloudSQL PostgreSQL connection was introduced in CDAP 6.7.0.

Use this connection to access data in a CloudSQLPostgreSQL database using JDBC.

Property	Macro Enabled?	Version Introduced	Description

Property	Macro Enabled?	Version Introduced	Description
Name	No		Required. Name of the connection. Connection names must be unique in a namespace.
Description	No		Optional. Description of the connection.
JDBC Driver name	Yes		Required. Select the JDBC driver to use.
Database	Yes (6.10.0)		Required. CloudSQL PostgreSQL database name.
CloudSQL Instance Type	No		Whether the CloudSQL instance to connect to is private or public. Default is Public.
Connection Name	Yes (6.10.0)		Required. The CloudSQL instance to connect to in the format <PROJECT_ID>:\<REGION>:<INSTANCE_NAME>. Can be found in the instance overview page.
Port	Yes	6.10.0	Optional. Port that PostgreSQL is running on. Default is 5432.
Username	Yes		User identity for connecting to the specified database. Required for databases that need authentication. Optional for databases that do not require authentication.
Password	Yes		Password to use to connect to the specified database.
Connection Arguments	Yes		Optional. A list of arbitrary string tag/value pairs as connection arguments. These arguments will be passed to the JDBC driver, as connection arguments, for JDBC drivers that may need additional configurations. This is a semicolon-separated list of key-value pairs, where each pair is separated by a equals ‘=’ and specifies the key and value for the argument. For example, ‘key1=value1;key2=value’ specifies that the connection will be given arguments ‘key1’ mapped to ‘value1’ and the argument ‘key2’ mapped to ‘value2’.

Path of the connection

To browse, get a sample from, or get the specification for this connection through Pipeline Microservices, the path property is required in the request body. It can be in the following form :

/{schema}/{table} This path indicates a table. A table is the only one that can be sampled. Browse on this path to return the specified table.
/{schema} This path indicates a schema. A schema cannot be sampled. Browse on this path to get all the tables under this schema.
/ This path indicates the root. A root cannot be sampled. Browse on this path to get all the schemas visible through this connection.

Examples

Connecting to a public CloudSQL PostgreSQL instance

Suppose you want to read data from CloudSQL PostgreSQL database named “prod”, as “postgres” user with “postgres” password (Get the latest version of the CloudSQL socket factory jar with driver and dependencies here), then configure plugin with:

Name: "connection1"
Driver Name: "cloudsql-postgresql"
Database: "prod"
Connection Name: [PROJECT_ID]:[REGION]:[INSTANCE_NAME]
CloudSQL Instance Type: "Public"
Username: "postgres"
Password: "postgres"

Connecting to a private CloudSQL PostgreSQL instance

If you want to connect to a private CloudSQL PostgreSQL instance, create a Compute Engine VM that runs the CloudSQL Proxy docker image using the following command

# Set the environment variables
export PROJECT=[project_id]
export REGION=[vm-region]
export ZONE=`gcloud compute zones list --filter="name=${REGION}" --limit
1 --uri --project=${PROJECT}| sed 's/.*\///'`
export SUBNET=[vpc-subnet-name]
export NAME=[gce-vm-name]
export POSTGRESQL_CONN=[postgresql-instance-connection-name]

# Create a Compute Engine VM
gcloud beta compute --project=${PROJECT_ID} instances create ${INSTANCE_NAME}
--zone=${ZONE} --machine-type=g1-small --subnet=${SUBNE} --no-address
--metadata=startup-script="docker run -d -p 0.0.0.0:3306:3306
gcr.io/cloudsql-docker/gce-proxy:1.16 /cloud_sql_proxy
-instances=${POSTGRESQL_CONNECTION_NAME}=tcp:0.0.0.0:3306" --maintenance-policy=MIGRATE
--scopes=https://www.googleapis.com/auth/cloud-platform
--image=cos-69-10895-385-0 --image-project=cos-cloud

Optionally, you can promote the internal IP address of the VM running the Proxy image to a static IP using

# Get the VM internal IP
export IP=`gcloud compute instances describe ${NAME} --zone ${ZONE} |
grep "networkIP" | awk '{print $2}'`

# Promote the VM internal IP to static IP
gcloud compute addresses create postgresql-proxy --addresses ${IP} --region
${REGION} --subnet ${SUBNET}

# Note down the IP to be used in MySQL or PostgreSQL JDBC 
# connection string
echo Proxy IP: ${IP}

echo "JDBC Connection strings:"
echo "jdbc:postgresql://${IP}:5432/{PostgreSQL_DB_NAME}"
echo "jdbc:mysql://${IP}:3306/{MySQL_DB_NAME}"

Get the latest version of the CloudSQL socket factory jar with driver and dependencies from here, then configure plugin with: