JDBC connection properties
The JDBC driver supports the following connection properties. If the same property occurs more than once in the connection string, the last entry takes precedence. Property names are not case sensitive.
| Property names | Description |
|---|---|
| AdabasColumnNameCorrelationIds
Alias: ABCN |
Support ADABAS column name correlation IDs.
Required: false Default value: false Valid values: [true, false] |
| AlternateServers | An alternate database server to which the driver tries to connect if the primary database server is unavailable. Specifying a value for this connection string attribute enables connection failover for the driver. |
| ApplicationName
Alias: APNA |
Application name that is sent to the host as part of logon for connection tracking.
Required: false (maximum of 16 characters in length) |
| AuthenticationMechanism
Alias: ATHM |
Mechanism for encrypting passwords.
Required: false Default value: DEFAULT Valid values: [DEFAULT, AES] |
| BindInetSocketAddressList
Alias: BISAL |
A single local name or IP address to bind a socket, or a comma-separated IP address list (used with MapReduce), or AutoDetect to detect NIC IP addresses automatically.
Required: false Default value: No |
| CatalogPrefix
Alias: CPFX |
Database catalog prefix, SYSPROC for DB2, SQLENG for DVS, SDBMAP for the others.
Required: false Default value: SYSPROC Valid values: [SYSIBM, SYSPROC, SDBMAP, SQLENG] |
| CertificateHostName
Alias: HostNameInCertificate |
Host name for certificate validation when SSL encryption and validation is enabled.
Required: false |
| Charset
Alias: CS, CodePage, CP, Encoding, ENC |
The database character encoding.
To get a complete list the charsets that are available on a particular JVM, call the Charset.availableCharsets() API, where charsetName is one of the available Java character sets. The list of available character sets that are returned depends on the specific version and supplier of Java, as well as the availability of the ICU jar files on the classpath. Names with the 'x-' prefix indicate that a charset is not registered at the Internet Assigned Numbers Authority (IANA). For more information, see https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html and https://ssl.icu-project.org/icu-bin/convexp. Required: false Default value: IBM037 Valid values: For a list of supported character sets, see Character sets. |
| CicsTransactionName
Alias: TRNA |
CICS transaction name.
Required: false Default value: (maximum of eight characters in length) |
| CompressionLevel | Compression level (ZLib only), -1 (default), 1 (best speed) ... 9 (best compression).
Required: false Default value: -1 Valid values: [-1, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
| CompressionThresholdBytes | Compression threshold in bytes. The driver compresses data for buffers larger than this size. This value can be post-fixed with a unit like KB (K) or MB (M). For example, the following values are all equal: 1048576, 1024 K, 1024 KB, 1 MB.
Required: false Default value: 0 |
| CompressionType | The type of compression used.
Required: false Default value: UNCOMPRESSED Valid values: [ZLIB_NO_WRAP, CMBU, CMBV, UNCOMPRESSED] |
| ConnectionType | Connection wire type.
Required: false Default value: SOCKET Valid values: [SOCKET, SOCKET_CHANNEL] |
| CountTraceEnter | Counts JDBC API calls.
Required: false Default value: false Valid values: [true, false] |
| DatabaseRequestModule
Alias: DBRM |
Database request module.
Required: false Default value: OPRXSQ (maximum of eight characters in length) |
| DatabaseType
Alias: DBTY |
The database type to connect to after connecting to the Data Virtualization Manager server.
Required: false Default value: DRDAorDB2 Valid values:
|
| EncodeUserName | When set to true, the user name is encoded when establishing the server connection. Support of this feature can be controlled using server parameters USERIDENCODEREQUIRE and USERIDENCODEALLOW.
Required: false Default value: false Valid values: [true, false] |
| EncryptionMethod | Encryption method.
Required: false Default value: NONE Valid values: [NOENCRYPTION, NONE, SSL] |
| GetTablesSchemaFilter
Alias: DP |
Filter to use for getTables() DB2 metadata schema.
Required: false |
| HexDumpBytesPerLine | Bytes per line in the hexadecimal dump.
Required: false Default value: 16 |
| HexDumpBytesPerWord | Bytes per word in the hexadecimal dump.
Required: false Default value: 4 |
| Host | Host name or IP address.
Required: true |
| IniFile
Alias: INI |
Loads properties from this INI file (overrides IniFileEnvVar).
Required: false. |
| IniFileCharset
Alias: INICS |
The INI file Charset.
Required: false Default value: UTF-8. |
| IniFileDataSourceName
Alias: DSN |
Loads properties from a section name to an INI file.
Required: false. |
| IniFileEnvVar
Alias: INIEV |
Loads properties from the INI file to this environment variable.
Required: false. Default value: DV_INI |
| InitialCurrentDegree
Alias: SEDG |
Initial current degree (DB2).
Required: false Valid values: [ANY, 1] |
| InitialCurrentPackageSet
SEPK |
Initial current package set (DB2).
Required: false |
| InitialCurrentRules
Alias: SERL |
Initial current rules (DB2).
Required: false Valid values: [DB2, STD] |
| InitializationString | Initialization string, use ';' to separate statements, wrap the string in '(' and ')' when used in a connection string.
Required: false |
| KeyPassword
Alias: KP |
The SSL key password.
Required: false |
| KeyStore
Alias: KS |
The SSL keystore.
Required: false |
| KeyStorePassword
Alias: KSP |
The SSL keystore password.
Required: false |
| LegacySqlPrepareEnabled
Alias: WRPR |
This flag controls the behavior of SQLPrepare for non-DB2 data sources such as ADABAS, VSAM, IMSDB, and VSAM CICS. When this keyword is set to true (which is the default), a request is always sent to the host at SQLPrepare time to obtain metadata for the SQL statement. For applications that access non-DB2 data sources and do NOT require metadata after the SQLPrepare, it is recommended to set WRPR to false for better performance since this will eliminate a network roundtrip whenever a SQLPrepare is executed. Required: false Default value: true Valid values: [true, false] |
| LGID
Alias: LanguageID |
This setting is for backward compatibility. It is recommended to use Charset instead.
Each language code corresponds to a charset used for byte conversion. If a key has no value, the driver will use the default. The mappings are as follows: {ARB=IBM420, CHS=, CHT=, DAN=IBM01142, DEU=IBM01141, DFT=IBM037, ENC=IBM1047, ENG=IBM285, ENU=IBM037, ESN=IBM01145, ESP=IBM284, FIN=IBM01143, FRA=IBM01147, FRC=IBM037, ISL=IBM01149, ITA=IBM01144, JNL=IBM1390, JNX=IBM1399, JPL=IBM5026, JPX=IBM5035, KOR=IBM037, KRN=x-IBM833, MDI=, NGN=IBM01142, NLD=IBM037, NOR=IBM01142, PPS=, PTG=IBM037, SVE=IBM278, SWE=IBM01143, TUR=IBM1026} Required: false Default value: ENU Valid values (31): [ARB, CHS, CHT, DAN, DEU, DFT, ENC, ENG, ENU, ESN, ESP, FIN, FRA, FRC, ISL, ITA, JNL, JNX, JPL, JPX, KOR, KRN, MDI, NGN, NLD, NOR, PPS, PTG, SVE, SWE, TUR] |
| LogConfiguration
Alias: LOGCONFIG |
Sets the Log4j 2 configuration file.
Required: false |
| LogThreadsState
Alias: LTS |
Logs the state of a thread.
Required: false Default value: false Valid values: [true, false] |
| LogThreadsStatePeriodMillis | Logs the state period for a thread in milliseconds.
Required: false Default value: 1000 |
| LoginTimeoutMillis | Login timeout in milliseconds (0 = system default if there is one, or no limit.)
Required: false Default value: 0 |
| LoginTimeoutSeconds
Alias: LOGINTIMEOUT |
Login timeout in seconds.
Required: false Default value: 0 |
| MapReduceClient
Alias: MRC, MapReduce |
Use MapReduceClient (MRC) to read query results in parallel from different connections. When enabled, the driver creates one master connection and N worker connections (instances of JDBC connections).
Required: false Default value: false Valid values: [true, false, list] To distribute MapReduce on a single server, select from the following methods:
To distribute MapReduceClient over multiple servers, set MapReduceClient: MRC=(host1, port1, taskCount1), (host2, port2, taskCount2),... If you are using MapReduceClient with RDBMS or IMS, you must complete the metadata repository configuration requirements. See "MapReduce" in the Administrator's Guide. |
| MapReduceClientCount
Alias: MRCC |
The single-connection MapReduceClientCount. This value is only set for use with MRCN. The MRCC default setting is 0.
Required: false Default value: 0 |
| MapReduceClientNumber
Alias: MRCN |
To enable highly-parallel client applications to control concurrent MapReduce connections, from which queries are executed as a single thread, set the MapReduceClientCount (MRCN) value for each MapReduceClientCount (MRCC).
The following example shows a connection string used to connect to the first of four available connections:
To disable this feature, set MapReduceClientCount to 0 (MRCC=0) and set MapReduceClient to false (MRC=false). |
|
MapReduceFillValueMaximumInitialSize
Alias: MRFVMIS |
This value specifies the initial capacity of the result row pre-fetch cache for a given buffer that is used after the MapReduce or Parallel IO read queue exceeds the value set for MapReduceFillValueThreshold.
Required: false Default value: 20,000 (rows per buffer) |
|
MapReduceFillValueThreshold
Alias: MRFVT |
When using Parallel IO or MapReduce, this value specifies the number of buffers on the parallel IO thread that must be exceeded before pre-filling the column values (converting mainframe row bytes to Java object representations).
Required: false Default value: -1 (off). |
|
MapReducePollTimeOutMillis
Alias: MRPTO |
The MapReduce and Parallel IO inter-thread poll timeout, in milliseconds.
Required: false Default value: 50 |
|
MapReduceQueueStats
Alias: MRQS |
Gathers statistics for MapReduce result sets.
Required: false Default value: false Valid values: [true, false] |
| MaximumBufferSize
Alias: MXBU |
Maximum server-side communication buffer size in bytes. This value can be post-fixed with a unit like KB (K) or MB (M). For example, the following values are all equal: 1048576, 1024 K, 1024 KB, 1 MB. The minimum value is 40960.
Required: false Default value: 262144 |
| MaximumFieldSize
Aliases: MFS, MaxFieldSize |
Maximum field size to return.
Required: false Default value: 2147483647 |
| MaximumRows
Alias: MR |
Maximum number of rows to return.
Required: false Default value: 0 |
| MetaDataCharset
Alias: MDCS |
The database metadata character encoding. Available encodings depends on the runtime. See the Charset property.
Required: false Default value: IBM037 |
|
NetworkTimeoutMillis
Alias: NTOM |
Network timeout in milliseconds.
Required: false Default value: 0 |
|
NetworkTimeoutSeconds
Alias: NETWORKTIMEOUT |
Network timeout in seconds.
Required: false Default value: 0 |
| ParrallelIoBufferCount
Alias: PIOBC |
When the value of the Parallel IO buffer count is > 0 (where the buffer size = MXBU), a background thread reads the rows from the server as the main thread consumes them. This memory is re-usable.
For example, if MXBU is set to 4 MB and PIOBC is set to 10, the driver uses 40 MB of memory as the read-ahead buffer (10 x 4 MB buffers). Required: false. Default value: 0. |
| Password
Alias: PWD, PassPhrase |
Password or password phrase.
Required: false |
| PasswordToUpperCase
Alias: UCLC |
Converts passwords to uppercase. This property is ignored when a password phrase has been specified.
Required: false Default value: true Valid values: [true, false] |
| Plan | The DB2 plan name used for a DB2 connection. This is used when the subsystem is set to a valid DB2 subsystem name.
Required: false Default value: SDBC1010 (maximum of eight characters in length) |
| Port | Server port.
Required: false Default value: 1200 |
| PrepareMetadataSQL | Determines how the SQL statement metadata calls are handled.
Required: false Default value: false Valid values: [true, false] If set to true, the driver prepares the SQL statements for metadata calls. If set to false, the driver builds and executes the SQL statements for metadata calls dynamically, which can be susceptible to SQL injection attacks. |
| QueryTimeoutMillis
Alias: QTOM |
Query timeout in milliseconds.
Required: false Default value: 0 |
| QueryTimeoutSeconds
Alias: QUERYTIMEOUT |
Query timeout in seconds.
Required: false Default value: 0 |
| SelectForReadOnly
Alias: RO |
Appends FOR FETCH ONLY to JDBC read-only SQL query statements.
Required: false Default value: true Valid values: [true, false] |
| ServerCertificateStrategy | Server certificate strategy.
Required: false Default value: Validate Valid values: [Validate, AcceptSelfSigned, Trust] |
| SocketKeepAlive
Alias: SKA |
Socket keep alive.
Required: false Default value: false Valid values: [true, false] |
| SocketReceiveBufferSize
Alias: SRBS |
Socket receive buffer size hint in bytes. This value can be post-fixed with a unit like KB (K) or MB (M). For example, the following values are all equal: 1048576, 1024 K, 1024 KB, 1 MB.
Required: false Default value: 0 |
| SocketSendBufferSize
Alias: SSBS |
Socket send buffer size hint in bytes. This value can be post-fixed with a unit like KB (K) or MB (M). For example, the following values are all equal: 1048576, 1024 K, 1024 KB, 1 MB.
Required: false Default value: 0 |
| SocketTcpNoDelay
Alias: STCPND |
Socket TCP NoDelay.
Required: false Default value: false Valid values: [true, false] |
| SqlAuthorizationId
Alias: ALUS |
SQL authorization ID.
Required: false |
| SslContextProtocol
Alias: SSLPROTOCOL |
SSL context protocol.
Required: false Default value: TLS |
| StrictJdbcCompliance | Indicates whether the driver complies strictly with the JDBC spec.
Required: false Default value: false Valid values: [true, false] |
| SubSystem
Alias: SUBSYS |
The database subsystem name.
If the data source is DB2 (DatabaseType=DRDAorDB2), enter the DB2 subsystem name as it exists on the mainframe. If the data source is a non-DB2 database (where If the data source is DVS, the subsystem name should be set to NONE. Required: false Default value: NONE Valid values: 1 - 4 alphanumeric characters |
| ThrowUnsupportedAll | [Development tool] Throws an exception when an API is not supported.
Required: false Default value: true Valid values: [true, false] |
| TraceBrowseAppender | To collect JDBC driver server trace log information, add the name of the collection appender to the log4j configuration file.
The following example shows the collection name tag:
Where the name of the collection appender (TB in this example) is the name you choose. Add the The server parameter Required: false |
| TruncateCallLiteral
Alias: TRLT |
Truncate CALL string.
Required: false Default value: true Valid values: [true, false] |
| TrustStore | The SSL trust store.
Required: false |
| TrustStorePassword | The SSL trust store password.
Required: false |
| UpperCaseAllCharacters |
This field controls if all character data sent to the host should be converted to upper case or not. If this field is set to true, then all character data will be converted to upper case. If this field is set to false, then character data will not be converted to upper case. Required: false Default value: false Valid values: [true, false] |
| UpperCaseNonLiterals |
This flag controls if all non-literal values in SQL statements passed to the driver should be converted to upper case or not. If this flag is set to true, then strings not in single or double quotes will be converted to upper case. Required: false Default value: true Valid values: [true, false] |
| URL | Use to specify connection properties.
Required: false |
| user
Alias: UID |
The user name or identifier. |
| UserParm
Alias: UserParm |
Sent in the logon information to complete logon to a host security system and/or database. Maximum of 100 characters in length. |
| ValidateServerCertificate | Validate server certificate or not.
Required: false Default value: true Valid values: [true, false] |
| VpdGroupMemberCount | Virtual Parallel Data group member count.
Required: false Default value: 0-255 |
| VpdGroupName | Virtual Parallel Data group name. Maximum of eight characters in length.
Required: false Default value: |
| VpdGroupOpenTimeoutSeconds | Virtual Parallel Data group open timeout in seconds.
Required: false Default value: 0 |
| VpdIoThreadCount | Virtual Parallel Data I/O thread count.
Required: false Default value: 0-255 |
| XaEnabled
Alias: XAEN |
Set to true to enable XA transactions. Required: false Default value: false Valid values: [true, false] |
| XaTransactionManager
Alias: XAOP |
The type of transaction manager used for XA operations. Required: false Valid value: JTS |
Character sets
The list of available character sets that are returned depends on the specific version and supplier of Java, as well as the availability of the ICU jar files on the classpath.
The following Charsets (CS) are supported:
| Charsets |
|---|
|
|