/
MySQL Database Account

MySQL Database Account

In this article

Overview

This account type can be used to connect MySQL Snaps with data sources that use MySQL database accounts.

mysql-db-account.png

 

Prerequisite

Important

The account must have the JDBC JAR file. The default JAR file does not support connectivity to MYSQL8. To connect to MYSQL8, you must upload JAR mysql-connector-java (v8). Learn more about version compatibility in the MySQL article.

To ensure compatibility, we recommend that you use the same versions of MySQL driver and MySQL server for configuring your MySQL account. For example, when using server version 8.0.22, ensure that the driver version is also 8.0.22.  If you do not add any JDBC JARs, a default JDBC JAR file is loaded.

 

Limitation

  • Currently, the MySQL Snap Pack does not fully support MariaDB version 3.x, and some use cases may not function as expected. If you need to use version 3.x, we recommend that you use the JDBC Snap Pack.

Account Settings

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

String

Required. The user-provided name for the account. Preferably, update the account name if your project includes more than one account of the same type.


Default value: N/A
Example: MySQL_DatabaseAccount

JDBC driver class

String

The class name of the JBDC driver. 


Default value: N/A
Example: com.mysql.jdbc.Driver

JDBC URL Source

 

 

String

Select the source of the JDBC URL. 

  • Snap Generated: The JDBC URL that SnapLogic generates using the details you provide in the Account Settings dialog. If you choose this option, the Host Name, Port Number, and Database Name fields are displayed.

  • User Provided: Allows you to specify custom JDBC URLs. When you choose this option the Custom JDBC URL field appears.

Default Value: Snap Generated
Example: User Provided

jdbc:mysql scheme compatibility with MariaDB driver 3.0.0+

  • To use MariaDB JDBC driver version 3.0 or above, you must select User Provided as the JDBC URL source and provide a Custom JDBC URL that uses the jdbc:mariadb: protocol.

  • This Snap Pack does not support MariaDB driver version 3.x when using either Snap generated JDBC URLs or Custom JDBC URLs using the jdbc:mysql: protocol.

JDBC JARs

List of JDBC JAR files to be loaded.

If you do not add any JDBC JARs, a default JDBC JAR file is loaded. The default JAR file does not support connectivity to MYSQL8. To connect to MYSQL8, you must upload JAR mysql-connector-java (v5.1.47 or v8).

JDBC driver

String

Upload the JDBC driver and other JAR files that you want to use into SLDB. Click 

 to add a new row. Add each JDBC JAR file in a separate row.  For more information about JDBC drivers and downloading the appropriate driver for your account, see Downloading the JDBC Driver.

Default value: N/A
Example: Project Spaces/my_diagnostic_space/my_diagnostic /sqljdbc4-2.0.jar

When you use the relative path for the JDBC JAR file in accounts across different projects, the pipelines fail with the JAR FILE NOT FOUND error. Therefore, you must use the absolute path for the JDBC JAR file to run your pipelines successfully.

Account properties*

Required. Use this field set to specify the account properties required to connect to the database.

Hostname*

String/Expression

Appears when the JDBC URL Source is Snap Generated. 

Specify the server address to which the application must connect.

If you need to connect to an on-premise server, specify the domain name or the IP address. For example, test.mydbserver.com or 190.159.0.124.


Default value: N/A
Example:

Port number*

Integer/Expression

Appears when the JDBC URL Source is Snap Generated. 

Specify the database server's port number to which the application must connect.


Default Value:1521
Example:1521

Database name*

String/Expression

Appears when the JDBC URL Source is Snap Generated. 

Specify the database name to which the application must connect.


Default value: N/A
Example: MYDB

Username

String/Expression

Appears when the JDBC URL Source is Snap Generated. 

Specify the user name that is allowed to connect to the database. It is used as the default user name when retrieving connections. The user name must be valid in order to set up the data source.


Default value: N/A
Example: EricJones

Password

String/Expression

Appears when the JDBC URL Source is Snap Generated. 

Specify the password used to connect to the data source. It is used as the default password when retrieving connections. The password must be valid in order to set up the data source.


Default value: N/A
Example: p$wd!009*

Custom JDBC URL

String

Appears when the JDBC URL Source is User Provided.

Specify the JDBC URLs that you want to use to connect to your MySQL Account.


Default Value: N/A
Example: jdbc:mariadb://a.com:3306,b.com:3306/db

Use this option if you want to use complex JDBC URLs (involving multiple hosts and advanced options) to connect to your MySQL instance. For example, if you want to connect to MariaDB, you can enter a JDBC URL like the one below:

jdbc:mariadb://test1sp007.hq.xyz.com:6519,test1sp007.hq.company.com:6519/example

Configure SSH Tunnel

Checkbox/Expression

Select this checkbox if the Snap must create an SSH tunnel dynamically for connecting the JCC node to the MySQL server. Once the operation is completed, the tunnel is closed.

If selected, the configuration details of the SSH Tunnel must be provided.


Default status: Deselected

SSH Auth Mode

Dropdown List

Select the mode for authenticating the user on the SSH tunnel. The associated properties are displayed. 

The valid options are:

  • Password: If selected, the SSH Hostname, SSH Username, and the SSH Password properties must be configured.

  • KeyFile: If selected, the SSH Hostname, SSH Username, KeyStore, KeyStore Password, Key alias, and Private Key Passphrase properties must be configured. 

This value is considered only if the Configure SSH Tunnel check box is selected.


Default value: Password
Example: Password

SSH hostname*

Strings/Expression

Specify the IP address or the domain name of the SSH server to which you want to connect.

This value is considered only if the Configure SSH Tunnel check box is selected.


Default value: N/A
Example: mysql-tunnel-qa.snaplogic.com

         SSH username*

Strings/Expression

Specify the SSH username for connecting to the tunnel. 

This value is considered only if the Configure SSH Tunnel check box is selected.


Default value: N/A
Example: guestuser

         SSH password*

Strings/Expression

Specify the password associated with the SSH username. This field is required if SSH Auth Mode is Password.

This value is considered only if the Configure SSH Tunnel check box is selected.

Default value: N/A
Example: Zx9!Lm#45qRt%

    KeyStore

Strings/Expression

Specify the location of the keystore file. This field is required if SSH Auth Mode is KeyFile.

The file can be in SLDB, on the host machine that is hosting the JCC, or at any other remote location. For a local file, click

 to select the appropriate file using the file browser. You can also upload the file using any protocol such as https, ftp, sldb, and sftp.

This value is considered only if the Configure SSH Tunnel check box is selected.

Default value: N/A
Example: x590_certificate.jks

KeyStore password

Strings/Expression

Specify the password to access the keystore file. This field is required if the SSH Auth Mode is KeyFile.

This value is considered only if the Configure SSH Tunnel check box is selected.

Default value: N/A
Example: Xy9!aP3r$7LmQ2zT

Key alias

Strings/Expression

Specify the identifier or label of the private key to be used from the keystore. This field is required if SSH Auth Mode is KeyFile.

This value is considered only if the Configure SSH Tunnel check box is selected.

Default value: N/A
Example: 1

Private key passphrase

Strings/Expressions

Specify the password associated with the private key. If no value is provided, the keystore password is used. 

This value is considered only if the Configure SSH Tunnel check box is selected.

Default value: N/A
Example:

Advanced properties

Use this field set to set advanced properties required for connecting to the database.

Auto commit

Checkbox/Expression

Select this checkbox to auto-commit batches immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

Deselect this checkbox to commit only after all the batches are executed.

Default status: Selected

If the Snap fails, the entire transaction is rolled back, unless the Snap finds invalid input data before it sends the insert request to the server, and routes the error documents to the Error view.

Batch size*

Integer/Expression

Specify the batch size to indicate the number of SQL statements to execute in a single batch. For example, when inserting 100 records with batch size as 40, there will be 100 insert statements, and they are executed in 3 batches, the first and second batches contain 40 insert statements each and the third batch contains 20.

  • If the Batch Size is one, the query is executed as-is, that is the Snap skips the batch (non-batch execution).

  • If the Batch Size is greater than one, the Snap performs the regular batch execution.

Default value: 50
Example: 50

  • Select queries are not batched.

  • It is part of the JDBC standard, there is no maximum limit on the batch size. However, the JDBC drivers do not necessarily follow the standard and could throw exceptions if the batch size is too large for a specific driver. Reduce the batch size if you see an exception saying that the batch size is too large.

Using a large batch size could use up the JDBC placeholder limit of 2100. If the batch size is too large, sending a single batch request to the database server can take too long and it would time out. You should test and monitor the performance with different batch sizes and decide the best batch size.

Fetch size*

Integer/Expressions

Specify the number of rows to fetch at a time when executing a query.

Default value: 100
Example: 50

Large values could cause the server to run out of memory.

Max pool size*

Integer/Expressions

Specify the maximum number of concurrent connections a pool maintains at a time. The number of max pool size depends on the number of concurrent connections you need. Each MySQL Snap holds a separate connection when running. For a pipeline that has 4 MySQL Insert, 2 MySQL Execute, and 1 MySQL Update Snaps, the max pool size should be no less than 7 to make sure that the pipeline is executed successfully.

Default value: 50
Example: 50

Max lifetime (minutes)*

Integer/Expression

Specify the maximum time (in minutes) of a connection in the pool. Ensure that the value you enter is a few seconds shorter than any database or infrastructure-imposed connection time limit. A value of 0 indicates an infinite lifetime, subject to the Idle Timeout value. An in-use connection is never retired. Connections are removed only after they are closed.


Default value: 30
Example: 30

Idle timeout (minutes)*

Integer/Expression

Specify the maximum time (in seconds) a connection is allowed to remain idle in the pool. A value of 0 indicates that idle connections are never removed from the pool.


Default value: 5
Example: 5

Checkout timeout (milliseconds)*

Integer/Expression

Specify the number of milliseconds to wait for a connection to be available when the pool is exhausted. 

Default value: 10000
Example: 10000

URL properties

Use this field set to define the URL properties.

You can define the time zone values in this field set. The server time zone is important to convert date and time values stored in the database to the time zone set in the application server. You must configure either the database server or JDBC driver (by passing the serverTimeZone in the Url property name field) to use a specific time zone value for time zone support.

  • The Connector/J8.0 performs time offset adjustments on date-time values; however, the adjustments require either of the following conditions to be true:

    • MySQL server must be configured with a canonical time zone that is recognizable by Java (for example, Europe/Paris and UTC.)

    • Connector/J connection property serverTimezone must be set (for example, serverTimezone=America/New York) to override the server's time zone.

URL property name



Strings/Expression

Specify the name of the URL property name.


Default value: N/A
Example: zeroDateTimeBehavior

URL property value



Strings/Expression

Specify the value for the URL property defined above.


Default value: N/A
Example: convertToNull

Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2025 SnapLogic, Inc.