ADO.NET Provider for SybaseIQ

Build 24.0.9175

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 connecting, see Establishing a Connection.

Authentication


PropertyDescription
AuthSchemeThe scheme used for authentication. Accepted entries are Password, Kerberos.
ServerThe name of the server running the SybaseIQ or SAP SQL Anywhere Database.
PortThe port of the SybaseIQ database.
DatabaseThe name of the SybaseIQ or SAP SQL Anywhere database.
UserSpecifies the user ID of the authenticating SybaseIQ user account.
PasswordSpecifies the password of the authenticating user account.
UseSSLThis field sets whether SSL is enabled, it is only available when ConnectionType is 'SQLAnywhere'.
CharsetCharset name to communicate with server.
ConnectionTypeThis option specifies whether to connect to a SybaseIQ server or a SQLAnywhere server.

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
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Logging


PropertyDescription
LogfileSpecifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSizeSpecifies 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.
MaxLogFileCountSpecifies 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.

Schema


PropertyDescription
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Caching


PropertyDescription
AutoCacheSpecifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProviderThe namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheConnectionThe connection string for the specified cache database.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance, in seconds, for stale data in the specified cache database.
OfflineGet the data from the specified cache database instead of live SybaseIQ data.
CacheMetadataDetermines whether the provider caches table metadata to a file-based cache database.

Miscellaneous


PropertyDescription
BatchSizeSpecifies the maximum number of rows included in each batch operation. Set to 0 to submit the entire batch as a single request.
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. Set to 0 or leave empty for no time limit.
IncludeSystemObjectsWhether to include system objects while retrieving metadata.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
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.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool. The default value is 100. Set to 0 or a negative value to disable pooling.
PoolMinSizeSpecifies the minimum number of connections maintained in the connection pool. The default value is 1.
PoolWaitTimeSpecifies 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. The default is 60 seconds.
QueryPassthroughThis option passes the query to the SybaseIQ server as is.
ReadonlyToggles read-only access to SybaseIQ from the provider.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. Use this property only in environments where the standard licensing method is unsupported or requires a runtime key.
TimeoutA timeout for the provider.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175