ODBC Driver for Oracle

Build 22.0.8462

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.

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.

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 meta data for synonyms as they are being the reqular 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.

Miscellaneous


PropertyDescription
AllowPreparedStatementPrepare a query statement before its execution.
BatchSizeThe maximum size of each batch operation to submit.
DefaultDomainThis property is used for the Oracle Database Gateway for ODBC.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
IncludeDualTableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
LimitKeySizeThe maximum length of a primary key column.
MapBigintToVarcharThis property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default.
MapToIntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
MapToLongVarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
MapToWVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
MaximumColumnSizeThe maximum column size.
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 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.
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.
ReturnCatalogWhen set to False, this will return null for catalog when querying getCatalogs, getSchemas, getTables, getViews, getProcedures, getColumns, getProcedureParameters or getIndex.
RTKThe runtime key used for licensing.
UpperCaseIdentifiersThis 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.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462