Connecting to MariaDB

The following properties can be specified when loading data from a MariaDB connection.

Not all properties listed here may be necessary when creating the data connection. However, at a minimum, basic information must be provided.

Basic Information

• Title - The name of the connection.

• Description - The description (optional) of the connection.

• Host - The IP address or host name of the storage system.

• Port - The network port number through which the storage system connects.

• Database - The name of the database containing the data to be added.

• Username - The user account used to authenticate access to the storage system.

• Password - The password corresponding to the user account.

MariaDB Options

• Timezone
• Autocommit
• Use MySQL Metadata - Force DatabaseMetadata.getDatabaseProductName() to return "MySQL" (for compatibility reason).
• Create Database If Not Exist - The specified database in the url will be created if nonexistent. Default: false
• Default Fetch Size - The driver will call setFetchSize(n) with this value on all newly-created Statements. Default: 0.
• Max Query Size To Log - Only the first characters corresponding to this options size will be displayed in logs. Default: 1024
• Max Allowed Packet
• Geometry Default Type
• Restricted Auth
• Init SQL
• Transaction Isolation
• Socket Factory
• Connect Timeout - The connect timeout value, in milliseconds, or zero for no timeout.
• Pipe
• Local Socket
• TCP Keep Alive - Sets corresponding option on the connection socket. Default: True
• TCP Keep Idle - Permit setting socket TCP_KEEPIDLE value. Only valid for Java 11+ (for previous version, this option will have no use). (Integer) Default: null.
• TCP Keep Count - Permit setting socket TCP_KEEPCOUNT value. Only valid for Java 11+ (for previous version, this option will have no use). (Integer) Default: null.
• TCP Keep Interval - Permit setting socket TCP_KEEPINTERVAL value. Only valid for Java 11+ (for previous version, this option will have no use). (Integer) Default: null.
• TCP Abortive Close - This option can be used in environments where connections are created and closed in rapid succession. Often, it is not possible to create a socket in such an environment after a while, since all local "ephemeral" ports are used up by TCP connections in TCP_WAIT state. Using tcpAbortiveClose works around this problem by resetting TCP connections (abortive or hard close) rather than doing an orderly close. It is accomplished by using socket.setSoLinger(true,0) for abortive close.
• Local Socket Address
• Socket Timeout - Defines the network socket timeout (SO_TIMEOUT) in milliseconds. Value of 0 disables this timeout.
• User Ead Ahead Input - Use a buffered inputSteam that read socket available data. This cost a bit more in CPU, but permit returning result-set faster. Default true.
• TLS Socket Type
• SSL Mode - Indicate SSL demand. Possible values: disable, trust (no certificate and hostname validation), verify-ca (Encryption, certificates validation, BUT no hostname verification), verify-full (Standard SSL use: Encryption, certificate validation and hostname).
• Server SSL Cert
• Key Store
• Key Store Password
• Key Store Type
• Enabled SSL Cipher Suites
• Enabled SSL Protocol Suites
• Allow Multi Queries - Permit multi-queries like insert into ab (i) values (1); insert into ab (i) values (2). Default: false.
• Allow Local Infile - Indicate if LOAD DATA LOCAL INFILE commands are permitted. This will disable all pipelining implementation. Default false.
• Use Compression - Compress the exchange with the database through gzip. This permits better performance when the database is not in the same location.
• Use Affected Rows - If false (default), use "found rows" for the row count of statements. This corresponds to the JDBC standard. If true, use "affected rows" for the row count. This changes the behavior of, for example, UPDATE... ON DUPLICATE KEY statements.
• Use Bulk Stmts - Use dedicated COM_STMT_BULK_EXECUTE protocol for batch insert when possible. (batch without Statement.RETURN_GENERATED_KEYS and streams) to have faster batch. (significant only on >= MariaDB 10.2.7). Default: false.
• Cache Prep Stmts - Enable/disable prepare Statement cache. When enabled, PreparedStatement.close will not close prepare immediately, keeping a pool of most used prepared results.
• Prep Stmt Cache Size - If useServerPrepStmts = true, defines the prepared statement cache size that option `cachePrepStmts` use. Default: 250.
• Use Server Prep Stmts - PrepareStatement are prepared on the server side before executing. The applications that repeatedly use the same queries have value to activate this option, but the general case is to use the direct command (text protocol). If rewriteBatchedStatements is set to true, this option will be set to false.
• Credential Type
• Session Variables
• Connection Attributes
• Service Principal Name
• Blank Table Name Meta - Resultset metadata getTableName always return blank. This option is mainly for ORACLE db compatibility.
• Tiny Int 1is Bit - Datatype mapping flag, handle MySQL Tiny as BIT(boolean).
• Transformed Bit Is Boolean - Indicate for TINYINT(1) in column metadata that type is BOOLEAN in place of BIT.
• Year Is Date Type - Year is date type, rather than numerical.
• Dump Queries On Exception - If set to 'true', an exception is thrown during query execution containing a query string.
• Include Innodb Status In Deadlock Exceptions - Add "SHOW ENGINE INNODB STATUS" result to exception trace when having a deadlock exception.
• Include Thread Dump In Deadlock Exceptions - Add thread dump to exception trace when having a deadlock exception.
• Retries All Down - When the connector is performing a failover and all hosts are down, this parameter defines the maximum number of connection attempts the connector will make before throwing an exception. Default: 120 seconds.
• Galera Allowed State
• Transaction Replay - When having a failover, can current transaction being re-executed, having a completely transparent failover. All commands must be idempotent. Default: false.
• Transaction Replay Size - Replay cache buffer maximum size. If a transaction has more command that this size and a failover occurs, transaction will then not be replayed, just throwing an exception error. (Integer) Default: 64.
• Pool - Use pool. This option is useful only if not using a DataSource object, but only a connection object. Default: false.
• Pool Name
• Max Pool Size - The maximum number of physical connections that the pool should contain. Default: 8.
• Min Pool Size - When connections are removed due to not being used for longer than than "maxIdleTime", connections are closed and removed from the pool. "minPoolSize" indicates the number of physical connections the pool should keep available at all times. Should be less or equal to maxPoolSize.
• Max Idle Time - The maximum amount of time in seconds that a connection can stay in the pool when not used. This value must always be below @wait_timeout value - 45s. Default: 600 in seconds (=10 minutes), minimum value is 60 seconds.
• Register JMX Pool - Register JMX monitoring pools. Default: true.
• Pool Valid Min Delay - When asking a connection to pool, the pool will validate the connection state. "poolValidMinDelay" permits disabling this validation if the connection has been borrowed recently avoiding useless verifications in case of frequent reuse of connections. 0 means validation is done each time the connection is asked. Default: 1000 (in milliseconds).
• User Eset Connection - When a connection is closed, the pool resets the connection state. Setting this option, the prepare command will be deleted, session variables changed will be reset, and user variables will be destroyed when the server permits it (>= MariaDB 10.2.4, >= MySQL 5.7.3), permitting saving memory on the server if the application make extensive use of variables. Must not be used with the useServerPrepStmts option. Default: false.
• Server Rsa Public Key File
• Allow Public Key Retrieval - Authorize client to retrieve RSA server public key when serverRsaPublicKeyFile is not set (for sha256_password and caching_sha2_password authentication password). Default: false.

Additional Options

Connection Properties

• Property Name - The name of a connection property.
• Property Value - The value of the connection property.

Encrypted Properties

• Encrypted Property Name - The name of an encrypted property.
• Encrypted Property Value - The value of the encrypted connection property.

Advanced

Concurrency Control

• Maximum Allowed Concurrency - The overall limit on concurrent executions used to process the source.
• Number of Nodes - The number of nodes to use when processing the source.
• Executors per Node - The number of executors to use per node when processing the source.
• Maximum Request Rate - The maximum aggregate request rate against the source (e.g., 100 / s, 480 / minute).

Localization Settings

• Locale - The locale to use when parsing dates and numbers (e.g., ar-SA, en-US, ja-JP).
• Character Encoding - The default character encoding used by the connection (e.g., EBCDIC, UTF-8).
• Timezone - The timezone to use for dates and times that don't contain one (e.g., GMT+2, PST).

Data Formats

• Recognize only the configured formats - Specifies whether only those formats configured here should be recognized.
• DateTime Formats - How date and time values should be encoded (e.g., yyyy-MM-dd'T'HH:mm:ss, MM/dd/yyyy HH:mm, dd-MMM-yyyy HH:mm:ss).
• Date Formats - How calendar dates without time information should be encoded (e.g., yyyy-MM-dd, MM/dd/yyyy, dd-MMM-yyyy).
• Time Formats - How time-of-day values should be encoded (e.g., HH:mm:ss, hh:mm a, HH:mm:ss.SSS).
• Boolean Formats - How true/false or binary logical values should be encoded (e.g., true/false, 1/0, Y/N).
• Double Formats - How double-precision floating values should be encoded (e.g., ##,##0.00, $, %).
• Float Formats - How single-precision floating-point values should be encoded (e.g., ##,##0.00, %, e).
• Integer Formats - How whole numbers should be encoded (e.g., #, #,###,##0).
• Long Formats - How long integer values exceeding the range of standard integers should be encoded (e.g., #, #,###,##0).
• Month Formats - How standalone month values should be encoded (e.g., MM, MMMM).
• Year Month Formats - How combined month and year values should be encoded (e.g., yyyy MM, yyyy-MMM).
• Month Day Formats - How combined month/day values should be encoded (e.g., MM-dd, MMM dd, MM/dd)
• Year Formats - How standalone year values are encoded (e.g., yyyy, YY).