ODBC Driver for Sybase

Build 24.0.9060

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
AuthSchemeThe scheme used for authentication. Accepted entries are Password, Kerberos.
ServerThe name of the server running Sybase Database.
PortThe port of the Sybase database.
DatabaseThe name of the Sybase database.
UserThe Sybase user account used to authenticate.
PasswordThe password used to authenticate the user.
CharsetChaeset name to communicate with server.
UseSSLThis field sets whether SSL is enabled.
AlternateServersThis property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.

Kerberos


PropertyDescription
KerberosKDCThe Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosRealmThe Kerberos Realm used to authenticate the user.
KerberosSPNThe service principal name (SPN) for the Kerberos Domain Controller.
KerberosUserThe principal name for the Kerberos Domain Controller. Used in the format host/user@realm.
KerberosKeytabFileThe Keytab file containing your pairs of Kerberos principals and encrypted keys.
KerberosServiceRealmThe Kerberos realm of the service.
KerberosServiceKDCThe Kerberos KDC of the service.
KerberosTicketCacheThe full file path to an MIT Kerberos credential cache file.

SSL


PropertyDescription
SSLClientCertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertTypeThe type of key store containing the TLS/SSL client certificate.
SSLClientCertPasswordThe password for the TLS/SSL client certificate.
SSLClientCertSubjectThe subject of the TLS/SSL client certificate.
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

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.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheProviderThe name of the provider to be used to cache data.
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
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.
EncryptPasswordThis field sets whether password encryption is enabled.
IgnoreGroupNumberWhether to return group number (like ';num') of procedure when list procedures.
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.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MaxTDSPacketSizeThe protocol sending and receiving buffer size. For the lower version, it's from 512 to 512. For the newer version, it's from 512 to 2048.
OtherThese hidden properties are used only in specific use cases.
QueryPassthroughThis option passes the query to the Sybase server as is.
ReadonlyYou can use this property to enforce read-only access to Sybase from the provider.
RTKThe runtime key used for licensing.
SwitchModeThis property allows you to specify a switching mode to select a server from AlternateServers as the active server.
SwitchStrategyThis property allows you to specify a switching strategy to select a server from AlternateServers as the active server.
TextSizeSELECT statements return text, image, and unitext data up to the limit specified in this property.
TimeoutA timeout for the provider.
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) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060