Connection Properties
The connection 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 settings for this provider. Click the links for further details.
For more information on establishing a connection, see Getting Started.
| Property | Description |
| ConnectionType | Connection properties to use for authentication. Accepted entries are Server, OracleTNS, LDAP. |
| Server | The host name or IP of the server hosting the Oracle database. |
| Port | The port used to connect to the server hosting the Oracle database. |
| ServiceName | The service name of the Oracle database. |
| User | The Oracle OCI user account used to authenticate. |
| Password | The password used to authenticate the user. |
| DataSource | Oracle Net Services Name, Connect Descriptor (known also as TNS Connect String), or an easy connect naming that identifies the database to which to connect. |
| LDAPUri | LDAP uri to connect the LDAP server. |
| LDAPUser | The User account for LDAP server. |
| LDAPPassword | The password for the LDAP user. |
| LDAPVersion | The LDAP version used to connect to and communicate with the server. |
| Wallet | The location of the client's wallet that os required to setup secure TCPS connection. |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| IncludeSynonyms | Query metadata 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 | Query meta data from DBA_.. system views instead of ALL_.. system views. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheProvider | The name of the provider to be used to cache data. |
| CacheDriver | The database driver used to cache data. |
| CacheConnection | The 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. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| AllowPreparedStatement | Prepare a query statement before its execution. |
| BatchSize | The maximum size of each batch operation to submit. |
| DefaultDomain | This property is used for the Oracle Database Gateway for ODBC. |
| EnableForeignKeyDetection | Whether to detect the foreign keys in ODBC. |
| IncludeDualTable | Set this property to mock the Oracle DUAL table for better compatibility with Oracle database. |
| LimitKeySize | The maximum length of a primary key column. |
| MapBigintToVarchar | This property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default. |
| MapToInt | This property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default. |
| MapToLongVarchar | This property controls whether or not a column is returned as SQL_LONGVARCHAR. |
| MapToWVarchar | This property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default. |
| MaximumColumnSize | The maximum column size. |
| MaxLobSize | The volume in numbers of bytes or UTF-8 chars which is allowed to query by non-parameterized SELECT query. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| NativeFolder | The path to the directory containing the native dlls the provider works with. This property is effective on the Windows and macOS platforms only. |
| Other | These hidden properties are used only in specific use cases. |
| QueryPassthrough | This option passes the query to the Oracle OCI server as is. |
| Readonly | You can use this property to enforce read-only access to Oracle OCI from the provider. |
| ReconnectTimeout | The sleep time, in seconds, before retrying to reconnect to the server on a maximum idle time exceeded error. |
| ReconnectTries | The number of retry to connect server when a maximum idle time exceeded error is reported by server. |
| ReturnCatalog | When set to False, this will return null for catalog when querying getCatalogs, getSchemas, getTables, getViews, getProcedures, getColumns, getProcedureParameters or getIndex. |
| RTK | The runtime key used for licensing. |
| UpperCaseIdentifiers | This property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway. |