Connection Properties
The connection string properties describe the various options that can be used to establish a connection.
Adapter
CData.BizTalk.SybaseAdapter.dll
Remarks
The connection string can be set to a series of "option=value" pairs, separated by semicolons. If a connection string property value has special characters such as semicolons, single quotes, spaces, etc., then you must quote the value using either single or double quotes.
Connection options are case insensitive.
Connecting to Sybase
To connect to the Sybase, specify the following connection properties:
- Server: Set this to the name or network address of the Sybase database instance.
- Database: Set this to the name of the Sybase database running on the specified Server.
Optionally, you can also secure your connections with TLS/SSL by setting UseSSL to true.
Authenticating to Sybase
Sybase supports several methods for authentication including basic, Kerberos, and, LDAP.
Connect Using Basic Authentication
Set the AuthScheme to Basic and set the following connection properties to use Sybase authentication.
- User: Set this to the username of the authenticating Sybase user.
- Password: Set this to the username of the authenticating Sybase user.
Connect using LDAP Authentication
To connect with LDAP authentication, you will need to configure Sybase server-side to use the LDAP authentication mechanism.
After configuring Sybase for LDAP, you can connect using the same credentials as basic authentication.
Connect Using Kerberos Authentication
To leverage Kerberos authentication, begin by enabling it via the following connection property:
- AuthScheme: Set to Kerberos will be used for authentication to Sybase.
You can find an example connection string below:
Server=MyServer;Port=MyPort;User=SampleUser;Password=SamplePassword;Database=MyDB;Kerberos=true;KerberosKDC=MyKDC;KerberosRealm=MYREALM.COM;KerberosSPN=server-name
Connection String Options
The connection string options available in this provider are divided into the following categories. Click on the links for further details.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are Password, Kerberos. |
| Server | The name of the server running Sybase Database. |
| Port | The port of the Sybase database. |
| Database | The name of the Sybase database. |
| User | The Sybase user account used to authenticate. |
| Password | The password used to authenticate the user. |
| Charset | Chaeset name to communicate with server. |
| UseSSL | This field sets whether SSL is enabled. |
| AlternateServers | This 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. |
| Property | Description |
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosRealm | The Kerberos Realm used to authenticate the user with. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | The Kerberos realm of the service. |
| KerberosServiceKDC | The Kerberos KDC of the service. |
| KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| Logfile | A filepath which designates the name and location of 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. |
| Property | Description |
| EncryptPassword | This field sets whether password encryption is enabled. |
| IgnoreGroupNumber | Whether to return group number (like ';num') of procedure when list procedures. |
| MaxRows | Limits 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. |
| MaxTDSPacketSize | The 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. |
| Other | These hidden properties are used only in specific use cases. |
| QueryPassthrough | This option passes the query to the Sybase server as is. |
| Readonly | You can use this property to enforce read-only access to Sybase from the provider. |
| RTK | The runtime key used for licensing. |
| SwitchMode | This property allows you to specify a switching mode to select a server from AlternateServers as the active server. |
| SwitchStrategy | This property allows you to specify a switching strategy to select a server from AlternateServers as the active server. |
| Timeout | A timeout for the provider. |