db_connection_types.conf.spec

The db_connection_types.conf file lists the supported database types, driver parameters, and test queries.

Compared to version 2.x, in DB Connect 3, the fields

• cwallet_location and oracle_cipher_suites have been merged into connection_propperties.
• sslConnectionType has been removed.

# @copyright@
# The file contains the specification for database connection types

[<name>]

serviceClass = <string>
# required
# java class that serves the jdbc service for this type.


supportedVersions = <string>
# optional
# list (comma separated) supported verions(majorVersion.minorVersion) of JDBC driver implemented by serviceClass
# installed driver major version must == MajorVersion and minor version >= MinorVersion for a driver to be considered supported


jdbcUrlFormat = <string>
# required
# java jdbc URL to connect to this database template. It can contains following variables: host, port, database, informixserver.


jdbcUrlSSLFormat = <string>
# optional
# java jdbc URL for SSL connecting to this database. It can contains following variables: host, port, database, informixserver.


jdbcUseSSL = true | false
# optional
# default is false, whether this type of connection will use SSL connection.


jdbcDriverClass = <string>
# optional
# java jdbc vendor driver class.


testQuery = <string>
# optional
# simple SQL to test validation for this database type. This parameter is only necessary for non JDBC 4 compliant driver.


displayName = <string>
# optional
# the name displayed in UI.


database = <string>
# required only when other parameters refer to.
# the default database or schema used for this type.
# Possible variable from jdbcUrlFormat and jdbcUrlSSLFormat.


port = <int>
# required only when other parameters refer to.
# The TCP port number that the host database server is listening to for connections
# Possible variable from jdbcUrlFormat and jdbcUrlSSLFormat.


useConnectionPool = true | false
# optional, default is true, we intend to use pooled connections as possible.
# The connection pooling is based on Hikari, refer to https://github.com/brettwooldridge/HikariCP


ui_default_catalog = <string>
# optional


ui_default_schema = <string>
# optional


maxConnLifetimeMillis = <value>
# optional, default is 120000 = 120 seconds
# valid when useConnectionPool = true
# The maximum lifetime in milliseconds of a connection. After this time is exceeded the connection will fail the next activation, passivation or validation test.
# A value of zero or less means the connection has an infinite lifetime.


maxWaitMillis = <value>
# optional, default is 30000 = 30 seconds
# valid when useConnectionPool = true
# The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception
# [250, 300000] milliseconds is a reasonable value to wait to establish a connection.  The max wait time is 300000 millisenconds (300 seconds).


maxTotalConn = <value>
# optional, default is 8 connections
# valid when useConnectionPool = true
# The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit.


connection_properties = <string>
# optional, json format, differs via different databases.