JDBC Driver for Oracle

Build 23.0.8839

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.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
ConnectionTypeConnection properties to use for authentication. Accepted entries are Server, OracleTNS, LDAP.
ServerThe host name or IP of the server hosting the Oracle database.
PortThe port used to connect to the server hosting the Oracle database.
ServiceNameThe service name of the Oracle database.
UserThe Oracle OCI user account used to authenticate.
PasswordThe password used to authenticate the user.
DataSourceOracle Net Services Name, Connect Descriptor (known also as TNS Connect String), or an easy connect naming that identifies the database to which to connect.
LDAPUriLDAP uri to connect the LDAP server.
LDAPUserThe User account for LDAP server.
LDAPPasswordThe password for the LDAP user.
LDAPVersionThe LDAP version used to connect to and communicate with the server.
WalletThe location of the client's wallet that os required to setup secure TCPS connection.

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
IncludeSynonymsQuery metadata for synonyms as though they are the original tables.
ShowMetadataDescriptionsControls whether table and column descriptions are returned via the platform metadata APIs and sys_tables / sys_views / sys_tablecolumns.
UseDBAMetadataViewsQuery meta data from DBA_.. system views instead of ALL_.. system views.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheDriverThe database driver used to cache data.
CacheConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Miscellaneous


PropertyDescription
AllowPreparedStatementPrepare a query statement before its execution.
BatchSizeThe maximum size of each batch operation to submit.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpenThis property specifies whether to connect to the Oracle OCI when the connection is opened.
MaxLobSizeThe volume in numbers of bytes or UTF-8 chars which is allowed to query by non-parameterized SELECT query.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
NativeFolderThe path to the directory containing the native dlls the provider works with. This property is effective on the Windows and macOS platforms only.
OtherThese hidden properties are used only in specific use cases.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
QueryPassthroughThis option passes the query to the Oracle OCI server as is.
ReadonlyYou can use this property to enforce read-only access to Oracle OCI from the provider.
ReconnectTimeoutThe sleep time, in seconds, before retrying to reconnect to the server on a maximum idle time exceeded error.
ReconnectTriesThe number of retry to connect server when a maximum idle time exceeded error is reported by server.
RTKThe runtime key used for licensing.
UseConnectionPoolingThis property enables connection pooling.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839