Versions Compared

Key

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

...

Property

Macro Enabled?

Version Introduced

Description

Use Connection

No

6.7.0/1.8.0

Optional. Whether to use an existing connection. If you use a connection, connection related properties do not appear in the plugin properties.

Connection

Yes

6.7.0/1.8.0

Optional. Name of the connection to use. Project and service account information will be provided by the connection. You can also use the macro function ${conn(connection_name)}

JDBC Driver Name

No

Required. Name of the JDBC driver to use.

Default is cloudsql-mysql.

CloudSQL Instance Type

No

Optional. 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.9.0/1.10.05

Optional. Port that MySQL is running on.

Default is 3306.

Username

Yes

Optional. User identity for connecting to the specified database.

Password

Yes

Optional. Password to use to connect to the specified database.

Connection Arguments

Yes

Optional. A list of arbitrary string key/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.

Reference Name

No

Required. Name used to uniquely identify this source for lineage, annotating metadata, etc.

Database

Yes
(6.10.0/1.10.5)

Required. MySQL database name.

Import Query

Yes

Required. The SELECT query to use to import data from the specified table. You can specify an arbitrary number of columns to import, or import all columns using *. The Query should contain the ‘$CONDITIONS’ string. For example, ‘SELECT * FROM table WHERE $CONDITIONS’. The ‘$CONDITIONS’ string will be replaced by Split Column field limits specified by the Bounding Query. The ‘$CONDITIONS’ string is not required if Number of Splits is set to 1.

Bounding Query

Yes

Bounding Query should return the minimum and maximum of the values of the Split Column field. For example, ‘SELECT MIN(id),MAX(id) FROM table’. Not required if Number of Splits is set to 1.

Split Column

Yes

Field Name which will be used to generate splits. Not required if Number of Splits is set to 1.

Number of Splits

Yes

Number of splits to generate.

Fetch Size

Yes

6.6.0/1.7.0

Optional. The number of rows to fetch at a time per split. Larger Fetch Size can result in faster import with the trade-off of higher memory usage.

Default is 1000.

...