CData Python Connector for DB2

Build 20.0.7745

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.


Allow Prepared StatementPrepare a query statement before its execution.
Auth SchemeThe authentication mechanism that the provider will use to authenticate with DB2.
Browsable SchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
DatabaseThe name of the DB2 database.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
PasswordThe user's password.
PortThe port used to connect to the server hosting the DB2 database.
Query PassthroughThis option passes the query to the DB2 server as is.
ReadonlyYou can use this property to enforce read-only access to DB2 from the provider.
RTKThe runtime key used for licensing.
ServerThe name of the DB2 server.
SSH Auth ModeThe authentication method to be used to log on to an SFTP server.
SSH Client CertA certificate to be used for authenticating the user.
SSH Client Cert PasswordThe password of the SSHClientCert certificate if it has one.
SSH Client Cert SubjectThe subject of the SSH client certificate.
SSH Client Cert TypeThe type of SSHClientCert certificate.
SSH PasswordThe SSH password.
SSH PortThe SSH port.
SSH ServerThe SSH server.
SSH Server FingerprintThe SSH server fingerprint.
SSH UserThe SSH user.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
UserA database user.
Use SSHUse SSH.
Use SSLThis field sets whether SSL is enabled.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 20.0.7745