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.
| Property | Description |
| ConnectionType | Specifies the method used to connect to Oracle OCI data. |
| Server | The host name or IP of the server hosting the Oracle database you want to connect to. |
| Port | The port on which the Oracle OCI database service specified in the ServiceName connection property is hosted. |
| ServiceName | The service name of the Oracle database you want to connect to. |
| SID | The unique system identifier (SID) of the Oracle OCI database instance you want to connect to. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| DataSource | Specifies the Oracle database to connect to, using the Net Services Name, Connect Descriptor (TNS Connect String), or connection name. |
| LDAPUri | LDAP URI associated with the LDAP server you want to connect to. |
| LDAPUser | The name of the user account on the specified LDAP server that you want to use to connect to Oracle OCI data. |
| LDAPPassword | The password associated with the LDAP user specified in the LDAPUser connection property. |
| LDAPVersion | The LDAP version used to connect to and communicate with the Oracle OCI server. |
| Wallet | The directory where the client's Oracle Wallet is located. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| IncludeSynonyms | Specifies whether metadata is queried for synonyms as though they are the original tables. |
| ShowMetadataDescriptions | Controls whether table and column descriptions are returned via the platform metadata APIs and sys_tables / sys_views / sys_tablecolumns. |
| UseDBAMetadataViews | Specifies whether to obtain metadata from system views prefixed with 'ALL' or those prefixed with 'DBA'. |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheDriver | The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live Oracle OCI data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| AllowPreparedStatement | Prepare a query statement before its execution. |
| BatchSize | Specifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 . |
| ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. |
| ConnectOnOpen | Specifies whether the provider establishes a connection to Oracle OCI immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary. |
| MaxLobSize | The maximum number of bytes to display in records for fields of LOB data types. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| NativeFolder | The path to the directory containing the native assemblies (.dll) the provider works with. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True. |
| PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. |
| PoolMinSize | Specifies the minimum number of connections to be maintained in the connection pool at all times. |
| PoolWaitTime | Specifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. |
| QueryPassthrough | This option passes the query to the Oracle OCI server as is. |
| Readonly | Toggles read-only access to Oracle OCI from the provider. |
| ReconnectTimeout | The sleep time, in seconds, before attempting reconnect to the server after exceeding the maximum idle time for a connection attempt. |
| ReconnectTries | The number of reconnection attempts that are made after exceeding the maximum idle time for an initial connection attempt. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |