Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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

No

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

No

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 :

  1. /{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.

  2. /{schema} This path indicates a schema. A schema cannot be sampled. Browse on this path to get all the tables under this schema.

  3. / 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

...