MySQL Dynamic Account

MySQL Dynamic Account

In this article

Overview

Use this account type to connect MySQL Snaps with datasources that use MySQL Dynamic accounts. This account deals with the dynamically calculated values. You can specify the account properties as expressions referencing pipeline parameters. The values for dynamic accounts are not stored; hence, use them when requested.

Loading


Prerequisites

To ensure compatibility, we recommend that you use matching versions of MySQL driver and MySQL server for configuring your account. For example, when using server version 8.0.22, ensure that the driver version is also 8.0.22. For details, see the official MySQL article on version compatibility. 


Known Issues

  • When using MariaDB JDBC driver version 2.7.2 or lower, providing username and password as JDBC URL parameters does not function as expected. To use this feature, use a MariaDB JDBC driver version of at least 2.7.3.

  • When using MariaDB JDBC driver, tables using spatial data types may not function as expected.
    Workaround: Use the MySQL JDBC driver or limit spatial data type usage to the GEOMETRY type instead of more specific spatial data types.

Account Settings

 

Parameter NameData TypeDescriptionDefault ValueExample 
Label*StringRequired. The name for the account. Preferably, update the account name if your project includes more than one account of the same type.N/AMySQL_DynamicAccount
JDBC URL SourceString

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.

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.

Snap Generated User Provided
JDBC driver class String The class name of the JBDC driver.N/Acom.mysql.jdbc.Driver
JDBC JARs

List of JDBC JAR files to be loaded. Click the + button on the right of the field to add a row.

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 driverString

Upload the JDBC driver and other JAR files that you want to use into SLDB. For more information about JDBC drivers and downloading the appropriate driver for your account, see Downloading the JDBC Driver.

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.

N/AProject Spaces/my_diagnostic_space/my_diagnostic /sqljdbc4-2.0.jar
Account properties*FieldsetRequired. Input required for the application to connect to the database.

Hostname*String/Expression

Required. Appears when the JDBC URL Source is Snap Generated

The Server address to which the application must connect.

N/A_hostname
Port number*Integer/Expression

Required. Appears when the JDBC URL Source is Snap Generated

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

3306_port
Database name*String/Expression

Required. Appears when the JDBC URL Source is Snap Generated

The database name to which the application must connect.

N/A_database 
Username*String/Expression

Required. Appears when the JDBC URL Source is Snap Generated

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.

N/A_username
Password*String/Expression

Required. Appears when the JDBC URL Source is Snap Generated

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.

N/A_passsword
Custom JDBC URLString

Appears when the JDBC URL Source is User Provided.

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

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

N/A jdbc:mariadb://a.com:3306,b.com:3306/db
Configure SSH TunnelCheckbox/Expressions

Select this checkbox if Snap must create an SSH tunnel dynamically to connect 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.

Not selectedN/A
SSH Auth ModeDropdown List/Expressions

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.

PasswordPassword
SSH hostname*Strings/Expressions

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.

N/A_sshhostname
         SSH username*

Strings/Expressions

The SSH username for connecting to the tunnel. 

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

N/A_sshusername
         SSH password*

Strings/Expressions

The password associated with the SSH user name. This field is required if Auth Mode is Password.

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

N/A_sshuserpassword
KeyStore

Strings/Expressions

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.

N/A_keystorepath
KeyStore password

Strings/Expressions

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

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

N/A_keystorepassword
Key alias

Strings/Expressions

The identifier or label of the private key to be used from the keystore. 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.

N/A_keyalias
Private key passphraseStrings/Expressions

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.

N/AN/A
Advanced propertiesFieldsetAdvanced input required for connecting to the database.

Auto commitCheckbox/ExpressionsAuto-commit property for the database. 

When selected, each of the batches is committed immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

When deselected, the Snap execution output is committed only after all the batches are executed. 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.

SelectedSelected
Batch size*Integer/Expressions
RequiredBatch size defines how many SQL statements can be executed 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.

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.

Select queries are not batched.

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.

5050
Fetch size*Integer/Expressions

RequiredNumber of rows to fetch at a time when executing a query.

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

100100
Max pool size*Integer/ExpressionsRequiredMaximum number of concurrent connections a pool will maintain at a time. The number of max pool size depends on how many 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.5050
Max lifetime (minutes)*Integer/ExpressionsRequired. 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.3030
Idle timeout (minutes)*Integer/ExpressionsRequiredThe maximum time (in seconds) a connection is allowed to sit idle in the pool. A value of 0 indicates that idle connections are never removed from the pool.55
Checkout timeout (milliseconds)*Integer/Expressions

Required. The number of milliseconds to wait for a connection to be available when the pool is exhausted. A value of 0 waits forever. An exception will be thrown after the wait time has expired.

Loading

1000010000
URL propertiesN/AInput regarding URL properties.N/AN/A

URL property name


String/Expression

URL property nameN/AzeroDateTimeBehavior

URL property value


String/Expression

URL property valueN/AconvertToNull