Versions Compared

Key

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

The MariaDB Batch source plugin is available in the Hub.

Plugin version: 1.7.0

Reads from a MariaDB instance using a configurable SQL query. Outputs one record for each row returned by the query.

...

Property

Macro Enabled?

Version Introduced

Description

Reference Name

No

Required. This will be used to uniquely identify this source for lineage, annotating metadata, etc.

Host

Yes

Required. Host that MariaDB is running on.

Default is localhost.

Port

Yes

Required. Port that MariaDB is running on.

Default is 3306.

Database

Yes

Required. MariaDB 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-By Field Name field limits specified by the bounding query. The ‘$CONDITIONS’ string is not required if Number of Splits to Generate is set to 1.

Bounding Query

Yes

Required. Bounding Query should return the min and max of the values of the ‘splitBy’ field. For example, ‘SELECT MIN(id),MAX(id) FROM table’. Not required if numSplits is set to one.

Split-By Field Name

Yes

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

Number of Splits to Generate

Yes

Optional. Number of splits to generate.

Fetch Size

Yes

6.6.0/1.57.40

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.

Username

Yes

Optional. User identity for connecting to the specified database.

Password

Yes

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

Use SSL

No

Optional. Turns on SSL encryption. The connection will fail if SSL is not available.

Default is if available.

Keystore URL

No

Optional. URL to the client certificate KeyStore (if not specified, use defaults). Must be accessible at the same location on host where CDAP Master is running and all hosts on which at least one HDFS, MapReduce, or YARN daemon role is running.

Keystore Password

No

Optional. Password for the client certificates KeyStore.

Truststore URL

No

Optional. URL to the trusted root certificate KeyStore (if not specified, use defaults). Must be accessible at the same location on host where CDAP Master is running and all hosts on which at least one HDFS, MapReduce, or YARN daemon role is running.

Truststore Password

No

Optional. Password for the trusted root certificates KeyStore.

Driver Name

No

Optional. Name of the JDBC driver to use.

Default is mariadb.

Use Compression

No

Optional. Use zlib compression when communicating with the server. Select this option for WAN connections.

Default is No.

Use ANSI Quotes

No

Optional. Treats “ as an identifier quote character and not as a string quote character.

Connection Arguments

No

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.

Auto Reconnect

No

Optional. Should the driver try to re-establish stale and/or dead connections.

Default is No.

Output Schema

No

The schema of records output by the source. This will be used in place of whatever schema comes back from the query. However, it must match the schema that comes back from the query, except it can mark fields as nullable and can contain a subset of the fields.

...