B Connection String Option Descriptions : Sybase Data Provider Connection String Options

Sybase Data Provider Connection String Options
The following connection option descriptions are listed alphabetically by the connection string option name. The ConnectionStringBuilder property name is listed immediately underneath the GUI name.
The connection string option name and the property name are the same; however, the spaces in the connection string option name are required.
Alternate Servers
Property
AlternateServers
Description
Specifies a list of alternate database servers to which the data provider tries to connect if the primary database server is unavailable. Specifying a value for this connection string option enables connection failover for the data provider.
The value you specify must be in the form of a string that defines connection information for each alternate server. You must specify the name or the IP address of each alternate server and the port number; alternatively, you can specify the Server connection string option.
See “Using Connection Failover” for a discussion of connection failover and information about other connection string options that you can set for this feature.
Valid Values
"Host=hostvalue;Port=portvalue[, ...]"
Example
The following Alternate Servers value defines two alternate servers for connection failover:
Host=server2;Port=4100, server=server_name\server_instance
Default
An empty string
Category
Failover
Application Name
Property
ApplicationName
Description
Specifies the name that the Sybase server uses to identify the client application. This option sets the clientapplname and program_Name column values in the systprocessess table.
Valid Values
string
where string is the name of the application.
Default
An empty string
Category
Client Monitoring
Authentication Method
Property
AuthenticationMethod
Description
Determines which authentication method the data provider uses when establishing a connection.
Valid Values
EncryptedPassword | Kerberos | UserIDPassword
If set to EncryptedPassword, the data provider encrypts the user's password as it is sent to a Sybase server that has password encryption enabled. The data provider uses the encryption algorithm required by the Sybase server. This encryption capability is used only for the password at connect time and only when sending the password across the network to the server.
If set to Kerberos, the data provider uses Kerberos authentication. The data provider ignores any user ID or password specified.
If set to UserIDPassword, the data provider uses the Sybase UserID/Password authentication. If the User ID connection string option is not specified, the data provider generates an exception.
Default
UserIDPassword
Category
Security
Batch Update Behavior
Property
BatchUpdateBehavior
Description
Determines how the data provider optimizes batch processing during update operations. The BatchUpdateSize property must be set to an integer greater than 1 (see “SybaseDataAdapter Class” for more information).
Valid Values
ArrayBindWhenPossible | ArrayBindOnlyInserts | NoOptimizations
If set to ArrayBindWhenPossible, the data provider attempts to use array binding to optimize batch updates. Use this value if your application 1) uses batch operations for inserts, updates, or deletes and 2) performs these operations on many values in the same columns. In this case, set the Batch Update Behavior connection string option.
If set to ArrayBindOnlyInserts, the data provider can use array binding to optimize batch inserts. Use this value if your application 1) uses batch operations for inserts only and 2) inserts many values in the same columns.
If set to NoOptimizations, no optimizations are used during DataAdapter update operations.
Default
ArrayBindWhenPossible
Category
Performance
Batch Update Parameter Limit
Property
BatchUpdateParameterLimit
Description
Specifies the maximum number of parameters that can be contained in a set DataAdapter batch update. When set, the data provider divides the DataAdapter batch into smaller batches.
The value can be any integer from 0 to 65535.
NOTE: Setting this option is useful only when the SybaseDataAdapter UpdateBatchSize property is enabled (see “SybaseDataAdapter Class”).
Valid Values
Any integer from 0 to 65535
If set to 0, batches have no parameter limit.
Default
0
Category
Advanced
Client Host Name
Property
ClientHostName
Description
Specifies the name that the Sybase server uses to identify the client workstation name. This sets the clienthostname and hostname column values in the sysprocesses table.
Alias
Workstation ID connection string option.
Valid Values
string
where string is the host name of the client machine.
Default
An empty string
Category
Client Monitoring
Clone Connection if Needed
Property
CloneConnectionifNeeded
Description
Determines whether the data provider clones the existing connection if another active result set is not currently possible on the existing Sybase connection and the application requires one. This connection string option can affect performance. See “Performance Considerations” for more information.
Valid Values
True | False
If set to True, the data provider clones the connection.
If set to False, the data provider does not clone the connection.
Default
False
Category
Performance
Common Work Arounds
Property
WorkArounds
Description
This option is reserved. Enter values only when directed by Progress customer support.
Default
0
Category
Advanced
Connection Pool Behavior
Property
ConnectionPoolBehavior
Description
Specifies the order in which a connection is removed from the connection pool for reuse, based on how frequently or how recently the connection has been used.
Valid Values
LeastRecentlyUsed | MostRecentlyUsed | LeastFrequentlyUsed | MostFrequentlyUsed
If set to MostRecentlyUsed, the data provider uses a Last In First Out (LIFO) approach to return the connection that was returned to the pool most recently.
If set to LeastRecentlyUsed, the data provider uses a First In First Out (FIFO) approach to return the connection that has been in the pool for the longest time. This value ensures a balanced use of connections in the pool.
If set to MostFrequentlyUsed, the data provider returns the connection with the highest use count. This value enables applications to give preference to the most seasoned connection.
If set to LeastFrequentlyUsed, the data provider returns the connection with the lowest use count. This value ensures a balanced use of connections in the pool.
Default
LeastRecentlyUsed
Category
Connection Pooling
Connection Reset
Property
ConnectionReset
Description
Specifies whether a connection that is removed from the connection pool for reuse by an application will have its state reset to the initial configuration settings of the connection.
Valid Values
True | False
If set to True, the state of connections removed from the connection pool for reuse by an application is reset to the initial configuration of the connection. Resetting the state impacts performance because the new connection must issue additional commands to the server, for example, resetting the current database to the value specified at connect time.
If set to False, the state of connections is not reset.
Default
False
Category
Connection Pooling
Connection Retry Count
Property
ConnectionRetryCount
Description
Specifies the number of times the data provider tries to connect to the primary server, and, if specified, the alternate servers after the initial unsuccessful attempt.
Valid Values
0 | x
where x is a positive integer from 1 to 65535.
If set to 0, the data provider does not try to reconnect after the initial unsuccessful attempt.
If set to x, the data provider attempts to connect the specified number of times. If a connection is not established during the retry attempts, the data provider returns an error that is generated by the last server to which it attempted to connect.
Default
0
Category
Failover
Connection Retry Delay
Property
ConnectionRetryDelay
Description
Specifies the number of seconds the data provider waits after the initial unsuccessful connection attempt before retrying a connection to the primary server, and, if specified, the alternate servers.
NOTE: This option has no effect unless the Connection Retry Count connection string option is set to an integer value greater than 0.
Valid Values
0 | x
where x is a positive integer from 1 to 65535.
If set to 0, there is no delay between retrying the connection.
If set to x, the data provider waits the specified number of seconds between connection retry attempts.
Default
3
Category
Failover
Connection Timeout
Property
ConnectionTimeout
Description
Specifies the number of seconds after which the attempted connection to the database server fails if not yet connected. If connection failover is enabled, this option applies to each connection attempt. A value of 0 means that the data provider never times out on a connection attempt.
NOTE: This property is not supported with the Sybase Entity Framework data provider. Instead, the data provider uses the ADO.NET Entity Framework programming contexts.
Valid Values
0 | x
where x is a positive integer greater than 1.
Default
15
Category
Connection Pooling
Database Name
Property
DatabaseName
Alias
Database. If both the Database and Database Name connection string options are specified, the value specified for the Database Name is used.
Description
Specifies the name of the database to which you want to connect. If you do not specify a value, the default is the database defined by the system administrator for each user.
Valid Values
string
where string is the name of a database.
Default
An empty string
Category
Standard Connection
Enable Quoted Identifiers
Property
EnableQuotedIdentifiers
Description
Specifies whether the connection supports quoted identifiers.
Valid Values
True | False
If set to True, the connection supports quoted identifiers.
If set to False, quoted identifiers are not supported.
Default
False
Category
Standard Connection
Enable Trace
Property
EnableTrace
Description
Specifies whether tracing is enabled.
Valid Values
0 | x
Where x is a positive integer 1 or higher.
If set to x, tracing is enabled.
If set to 0, tracing is not enabled.
Default
0
Category
Tracing
Enable XA
Property
EnableXA
Description
Enables a workaround that provides limited support for tools such as Visual Studio LightSwitch that assume that the underlying data provider can promote a local transaction to a fully-distributed transaction on an as-needed basis. Currently, the data provider cannot promote a local transaction to a fully-distributed transaction.
Valid Values
True | False
When set to True and Enlist is set to True, distributed transactions are supported and calls to Connection.EnlistTransaction function normally. See “Performance Considerations” for information about using distributed transactions.
When set to False, the connection cannot be enlisted in a distributed transaction. Calls to Connection.EnlistTransaction start a local transaction.
NOTE: When set to False and Enlist is set to True, the data provider returns an error.
Default
True
Category
Advanced
Encryption Method
Property
EncryptionMethod
Description
Defines how the data provider encrypts data sent between the data provider and the data source. The data provider supports client authentication for SSL. Client authentication uses the user ID of the user logged onto the system on which the data provider is running to authenticate the user to the database.
Valid Values
NoEncryption | SSL
If set to NoEncryption, data sent between the data provider and the Sybase server is not encrypted.
If set to SSL, all data sent between the data provider and the server is encrypted with SSL. The data provider checks the value of the Validate Server Certification connection string option to perform the necessary server authentication if required.
When SSL is enabled, the following connection string options also apply:
NOTES:
Default
NoEncryption
Category
Security
Enlist
Property
Enlist
Description
Specifies whether the data provider automatically attempts to enlist the connection in creating the thread’s current transaction context.
Valid Values
True | False
If set to True, the data provider automatically attempts to enlist the connection.
If set to False, the data provider does not automatically attempt to enlist the connection.
See “Performance Considerations” for information about configuring this option for optimal performance.
Default
False
Category
Performance
Fetch Buffer Size
Property
FetchBufferSize
Description
Specifies the number of bytes of data to prefetch to the client machine when executing a statement that produces a result set. Fetch Buffer Size can limit the actual connection to one active result set if its value is not large enough to hold the entire result set. Having a large buffer is only useful if your application uses more than one active result set per connection, an unusual situation in the .NET programming model.
This connection string option can affect performance for the ADO.NET data provider. See “Performance Considerations” for more information.
NOTE: This property is useful for standard ADO.NET applications. However, it is not accessible from the ADO.NET Entity Framework. Instead, the data provider uses the Entity Framework programming contexts.
Valid Values
An integer from 1 to 2147483648
Default
1024. We recommend using the default unless your application uses more than one active result set per connection.
Category
Performance
GSS Client
Property
GSSClient
Description
Specifies the full path of the third party GSS client library that the data provider uses to communicate with the Key Distribution Center (KDC) during authentication in an MIT Kerberos environment.
NOTE: This option is ignored unless the Authentication Method connection string option is set to Kerberos.
Valid Values
An empty string | path_to_GSS_client_library
If set as an empty string, the data provider uses the GSS client that ships with the operating system. The data provider uses the standard shared library path for loading the specified client library.
Example
The GSS client library that you can download from the MIT Web site.
Default
An empty string
Category
Security
Host
Property
Host
Description
Specifies either the name or the IP address of the server to which you want to connect.
Valid Values
string
where string is a valid host name or IP address.
To use a Sybase server running on the local machine as the application, specify localhost.
If your network supports named servers, you can specify a server name such as Sybaseserver. Or, you can specify an IP address in IPv4 or IPv6 format or a combination of both. See “Using IP Addresses” for information about using IP addresses.
Default
An empty string
Category
Standard Connection
Host Name In Certificate
Property
HostNameInCertificate
Description
Specifies a host name for certificate validation when SSL encryption is enabled (Encryption Method=SSL) and validation is enabled (Validate Server Certificate=True). This connection string option provides additional security against man-in-the-middle (MITM) attacks by ensuring that the server that the data provider is connecting to is the server that was requested.
Valid Values
empty string | host_name
If no host name is specified, the data provider compares the value specified for the Host option to the Common Name (CN) parts of the certificate’s Subject name. If the values do not match, the connection fails and the data provider throws an exception.
NOTE: If multiple CN parts are present, the data provider validates the host name against each CN part. If any one validation succeeds, a connection is established.
If SSL or validation is not enabled, this option is ignored.
Default
An empty string
Category
Security
Include Procedure Row Count
Property
IncludeProcedureRowCount
Description
Specifies whether the data provider counts the number of rows changed, inserted, or deleted by SQL statements executed within a stored procedure.
Valid Values
True | False
If set to True, the data provider counts the number of rows changed, inserted, or deleted.
If set to False, the data provider does not count the number of rows changed, inserted, or deleted.
Default
True
Category
Advanced
Initial Command Timeout
Property
InitialCommandTimeout
Description
Specifies the default wait time (timeout in seconds) before the data provider terminates the attempt to execute the command and generates an error. This option provides the same functionality as the SybaseCommand class’s CommandTimeout property without the need to make changes to the application code. Subsequently, an application can use the CommandTimeout property to override the Initial Command Timeout connection string option.
NOTE: This property is useful for standard ADO.NET applications. However, it is ignored for ADO.NET Entity Framework applications. Instead, the Entity Framework data provider uses the Entity Framework programming contexts to determine the default wait time.
Valid Values
0 or x
where x is any positive integer
If set to 0, the query never times out.
NOTE: Set the Initial Command Timeout option to a value that is greater than the largest default deadlock detection and timeout value on the server. This ensures that the application receives a more meaningful reply in case of a timeout.
Example
For example, in the following C# code fragment, the connection string instructs the application to wait 60 seconds before terminating the attempt to execute the command. The application then specifies a CommandTimeout of 45 seconds, which overrides the value set in the connection string:
SybaseCommand command = new SybaseCommand();
SybaseConnection conn = new SybaseConnection("…; Initial Command Timeout=60; …");
conn .Open();
command.Connection = connection;
// command.CommandTimeout returns 60;
command.CommandTimeout = 45;
// command.CommandTimeout returns 45
command = new SybaseCommand();
command.CommandTimeout = 45;
command.Connection = conn;
// command.CommandTimeout still returns 45
Default
30
Category
Advanced
Initialization String
Property
InitializationString
Description
Specifies one or more Sybase commands that are issued immediately after connecting to the database to manage session settings.
NOTE: If the statement fails to execute for any reason, the connection to the Sybase server fails. The data provider throws an exception that contains the error returned from the Sybase server.
Valid Values
command
where command is a Sybase command.
Example
The following example is surrounded by double quotation marks because one command contains single quotation marks:
"set ansinull off set ClientName 'SysAdmin' set clienthostname 'DDTEK2345' set clientapplname 'TESTAPP'";…"
Default
An empty string
Category
Standard Connection
Interfaces File
Property
InterfacesFile
Description
Specifies the fully-qualified path name or the URL of the Interfaces file. The Interfaces file, SQL.INI, lists the Sybase server name specified in the Server Name connection string option.
NOTE: If you do not specify a value for Interfaces File, but specify a value for the Server Name connection string option, the data provider looks for the path name of the Interfaces file in the Registry under HKEY_LOCAL_MACHINE\SOFTWARE\DataDirect\InterfacesFile. If this Registry value is empty, then the data provider attempts to open the SQL.INI file found in the same directory as the data provider and use it as the Interfaces file.
Valid Values
A fully-qualified path name or the URL of the Interfaces file.
Default
An empty string
Category
Standard Connection
License Path
Property
LicensePath
Description
Specifies the fully qualified path to the DDTek.lic license file. The license file is installed by default in the product installation directory.
Valid Values
A fully-qualified path
If set to an empty string the data provider looks for the license file in the application’s current directory. If the license file is not found, the data provider checks for keys placed in the registry during the installation process; then, the data provider looks for the license key in the installation directory. If the license key is not found, the data provider fails to connect.
Example
C:\install_dir\DDTek.lic
Default
An empty string
Category
Advanced
Load Balance Timeout
Property
LoadBalanceTimeout
Description
Specifies the minimum number of seconds to keep connections in a connection pool before destroying them. The Min Pool Size option can cause some connections to ignore this value.
Valid Values
0 | x
where x is a positive integer from 1 to 65535.
If set to 0, the lifetime is never limited by time.
See “Removing Connections from a Pool” for a discussion of connection lifetimes.
Alias
Connection Lifetime
Default
0
Category
Connection Pooling
Load Balancing
Property
LoadBalancing
Description
Determines whether the data provider uses client load balancing in its attempts to connect to primary and alternate database servers. The list of alternate servers is specified by the Alternate Servers connection option.
Valid Values
True | False
If set to True, the data provider attempts to connect to the database servers in random order. See “Client Load Balancing” for more information about load balancing.
If set to False, client load balancing is not used and the data provider connects to each server based on its sequential order (primary server first, then, alternate servers in the order they are specified).
NOTE: This option has no effect unless alternate servers are defined for the “Alternate Servers” connection string option.
The Load Balancing connection string option is an optional setting that you can use in conjunction with connection failover. See “Using Connection Failover” for a discussion of connection failover and for information about other connection options that you can set for this feature.
Default
False
Category
Failover
Max Pool Size
Property
MaxPoolSize
Description
Specifies the maximum number of connections within a single pool. When the maximum number is reached, no additional connections can be added to the connection pool. The Max Pool Size Behavior option can cause this option to be ignored during periods of high demand.
See “Creating a Connection Pool” for more information.
Valid Values
An integer from 1 to 65535.
Example
If set to 20, the maximum number of connections allowed in the pool is 20.
Default
100
Category
Connection Pooling
Max Pool Size Behavior
Property
MaxPoolSizeBehavior
Description
Specifies whether the data provider can exceed the number of connections specified by the Max Pool Size option when all connections in the connection pool are in use.
See “Creating a Connection Pool” for more information.
Valid Values
SoftCap | HardCap
If set to SoftCap, when all connections are in use and another connection is requested, a new connection is created, even when the connection pool exceeds the number set by the MaxPoolSize option. If a connection is returned and the pool is full of idle connections, the pooling mechanism selects a connection to be discarded so the connection pool never exceeds the Max Pool Size.
If set to HardCap, when the maximum number of connections allowed in the pool are in use and a new connection is requested, the connection request is queued. If no connection becomes available before the Connection Timeout is reached, the data provider terminates the attempt and generates an error.
Default
HardCap
Category
Connection Pooling
Max Statement Cache Size
Property
MaxStatementCacheSize
Description
Specifies the maximum number of cached statements that can be associated with the current connection.
Valid Values
0 | x
where x is a positive integer greater than 1.
If set to 0, statement caching is disabled.
This connection string option can affect performance. See “Performance Considerations” for more information.
Default
10
Category
Performance
Min Pool Size
Property
MinPoolSize
Description
Specifies the number of connections created when a connection pool is initialized and the minimum number of connections that will be kept in the pool. The connection pool retains this number of connections, even when some connections exceed their Load Balance Timeout value.
See “Removing Connections from a Pool” for a discussion of connection lifetimes.
Valid Values
0 | x
where x is a positive integer from 1 to 65535.
If set to 0, no additional connections are placed in the connection pool when it is created.
Default
0
Category
Connection Pooling
Packet Size
Property
PacketSize
Description
Determines the number of bytes for each packet transferred from the database server to the client machine. Adjusting the packet size can improve performance. The optimal value depends on the typical size of data inserted, updated, or retrieved by the application, and the environment in which it running. Typically, larger packet sizes work better for large amounts of data. For example, if an application regularly retrieves character values that are 10,000 characters in length, using a value of 32 (16 KB) typically results in improved performance.
To take advantage of this connection string option, you must configure the Sybase server for a maximum packet size greater than or equal to the value you specified for Packet Size.
For example:
sp_configure "maximum network packet size", 5120reconfigureRestart Sybase Server
This connection string option can affect performance. See “Performance Considerations” for more information.
Valid Values
-1 | 0 | x
where x is a positive integer from 1 to 65024.
If set to -1, the data provider computes the maximum packet size that the database server accepts.
If set to 0, the data provider uses the default packet size configured on the database server.
If set to an integer from 1 to 127, the data provider uses a multiple of 512 bytes (for example, PacketSize=6 means to set the packet size to 6 * 512 = 3072 bytes).
If set to an integer from 128 to 65024, the value indicates the byte count, rounded up to the nearest multiple of 512 if necessary (for example, a value of 175 is rounded up to 512; a value of 1024 requires no rounding).
Default
0
Category
Performance
Parameter Mode
Property
ParameterMode
Description
Specifies the behavior of native parameter markers and binding. This allows applications to reuse provider-specific SQL code and simplifies migration to the DataDirect data providers.
Valid Values
ANSI | BindByOrdinal | BindByName
If set to ANSI, the ? character is processed as a parameter marker and bound as ordinal. Applications can toggle the behavior of the BindByName property on a per-command basis.
If set to BindByOrdinal, native parameter markers are used and are bound as ordinal for stored procedures and standard commands.
If set to BindByName, native parameter markers are used and are bound by name for stored procedures and standard commands.
NOTE: When the BindByName property of the SybaseCommand class is set to True and this connection string option is defined as BindByName or BindByOrdinal, the value defined in the connection string is overridden for the lifetime of the SQLServerCommand Class.
Default
For the ADO.NET data provider, the default is ANSI.
For the ADO.NET Entity Framework data provider, the only supported value is BindByName.
Category
Advanced
Password
Property
Password
Description
Specifies the case-insensitive password used to connect to your Sybase database.
Valid Values
string
where string is a valid password.
Default
An empty string
Category
Security
Persist Security Info
Property
PersistSecurityInfo
Description
Specifies whether to display security information such as the password in clear text in the connection string.
Valid Values
True | False
If set to True, the value of the Password connection string option is displayed in clear text.
If set to False, the data provider does not display the password in clear text in the connection string.
Default
False
Category
Security
Pooling
Property
Pooling
Description
Specifies whether connections are pooled.
Valid Values
True | False
If set to False, connection pooling is not enabled.
If set to True, connection pooling is enabled. See “Using Connection Pooling” for a discussion of connection pooling.
Default
True
Category
Connection Pooling
Port
Property
Port
Description
Specifies the TCP port of the Sybase listener.
Valid Values
port
where port is the port number.
Default
4100
Category
Standard Connection
Program ID
Property
ProgramID
Description
Specifies the value of the hostProcess column in the sysprocesses table.
Valid Values
string
where string is a value that identifies the Client Product Version/ID on the server.
Default
An empty string
Category
Client Monitoring
Reader Close Behavior
Property
ReaderCloseBehavior
Description
Determines whether a Cancel is sent to prevent the server from sending additional rows when Close() is called and the result set has not been fully processed. This option is ignored when the command is a stored procedure.
Valid Values
0 | 1
If set to 1, a Cancel is not sent to prevent the server from sending additional rows.
If set to 0, a Cancel is sent to prevent the server from sending additional rows.
Default
0
Category
Advanced
Schema Collection Timeout
Property
SchemaCollectionTimeout
Description
Specifies the number of seconds after which an attempted schema collection operation fails if it is not yet completed.
Valid Values
A positive integer 1 or higher.
Default
120
Category
Schema Information
Schema Options
Property
SchemaOptions
Description
Specifies additional database metadata that can be returned. By default, the data provider prevents the return of some available database metadata to optimize performance. If your application needs this database metadata even though returning it is performance-expensive, specify the name or hexadecimal value of the metadata.
This option can affect performance (see “Performance Considerations”).
Valid Values
If set to ShowParameterDirections or 0x10, parameter directions are returned.
If set to ShowProcedureDefinitions or 0x20, procedure definitions are returned.
If set to ShowViewDefinitions or 0x40, view definitions are returned.
If set to ShowAll or 0xFFFFFFFF, all database metadata is returned.
To show more than one piece of the omitted metadata, specify either a comma-separated list of the names, or the sum of the hexadecimal values of the metadata that you want to return.
See Table B-4 for a list of the names and hexadecimal values you can specify to increase the amount of database metadata returned.
 
Example
To return procedure definitions and view definitions (hexadecimal values 0x20 and 0x40, respectively), specify
Schema Option=ShowProcedureDefinitions, ShowViewDefinitions or Schema Options=0x60.
To show more than one piece of the omitted metadata, specify either a comma-separated list of the names, or the sum of the hexadecimal values of the metadata that you want to return.
For example, to return procedure definitions and view definitions (hexadecimal values 0x20 and 0x40, respectively), specify one of the following:
Schema Option=ShowProcedureDefinitions, ShowViewDefinitions
Schema Options=0x60
Default
0x10 or ShowParameterDirections
Category
Schema Information
Select Method
Property
SelectMethod
Description
Determines whether server-side database cursors are used for Select statements.
This connection string option can affect performance. See “Performance Considerations” for more information.
Valid Values
Cursor | Direct
If set to Cursor, server-side database cursors are used.
If set to Direct, Select statements are issued without using server-side database cursors. Direct can be used with multiple open statements and manual transactions. However, if the statement contains a result set larger than the value set in the Fetch Buffer Size option, the connection may have only one active result set. We recommend that you use the default unless you need database cursors.
Default
Direct
Category
Performance
Server Name
Property
ServerName
Description
Specifies the name of the section in the Interfaces file that contains the network connection information for the Sybase database you want to access. The section name typically is the host name of the server that contains the Sybase database you want to access.
Use Server Name in combination with Interfaces File in the connection string.
Valid Values
string
where string is the name of the section in the Interfaces file that contains the network connection information.
Default
An empty string
Category
Standard Connection
Service Principal Name
Property
ServicePrincipalName
Description
Specifies the service principle name of the Sybase server to which you want to connect and the Kerberos realm to which the Sybase server belongs.
Valid formats are one of the following:
servicePrincipalName
servicePrincipalName@realm
where servicePrincipalName is the service principal name of the Sybase server to be connected to a realm, and realm is the Kerberos realm to which the Sybase server belongs. If no realm is specified, the default Kerberos realm is used.
If this option is not specified or is an empty string, the data provider uses the value of the Host option and the default Kerberos realm as the service principal name and the realm.
NOTE: If the Authentication Method connection string option is not set to Kerberos, the value of the Service Principal Name option is ignored.
Valid Values
servicePrincipalName | servicePrincipalName@realm
Default
An empty string
Category
Security
Statement Cache Mode
Property
StatementCacheMode
Description
Specifies the statement caching mode for the lifetime of the connection. See “Using Statement Caching” for more information.
Valid Values
Auto | ExplicitOnly
If set to Auto, statement caching is enabled for statements marked as Implicit by the Command property StatementCacheBehavior. These commands have a lower priority than that of explicitly marked commands, that is, if the statement pool reaches its maximum number of statements, the statements marked implicit are removed from the statement pool first to make room for statements marked Cache.
If set to ExplicitOnly, only commands that are marked Cache by the StatementCacheBehavior property are cached.
NOTES:
This connection string option can affect performance. See “Performance Considerations” for more information.
Default
ExplicitOnly
Category
Performance
Text Size
Property
TextSize
Description
Specifies a value that limits the number of bytes of data that can be returned from any single TEXT or IMAGE column in a result set. If the values of the TEXT or IMAGE columns in your application exceed 1 MB, increase this setting to exceed the maximum TEXT or IMAGE value size that you expect.
This connection string option can affect performance. See “Performance Considerations” for more information.
Valid Values
A positive integer from 1 to 247483647.
Default
1048576
Category
Performance
Tightly Coupled Transactions
Property
TightlyCoupledTransactions
Description
Determines whether the data provider uses tightly coupled distributed transactions when connected to Sybase 12 or higher database.
This connection string option is valid only when the data provider is enlisted in a distributed transaction or when it is connected to a Sybase 12 or higher database. Otherwise, this connection string option is ignored.
Valid Values
True | False
If set to True, the overall performance of the data provider is better. However, locking problems may occur with multiple connections within the same distributed transaction. See “Performance Considerations” for more information.
If set to False, the data provider uses tightly coupled transactions; multiple connections within the same distributed transaction do not obey each other’s locks.
Default
True
Category
Advanced
Trace File
Property
TraceFile
Description
Specifies the path and name of the trace file. If the specified trace file does not exist, the data provider creates it.
Valid Values
A valid path name
Example
\SybaseTrace.txt
Default
An empty string
Category
Tracing
Use Current Schema
Property
UseCurrentSchema
Description
Specifies whether the results are restricted to tables or views in the current schema of the GetSchema method of the DbConnection object.
Valid Values
True | False
If set to True, the results returned from any GetSchema call are restricted to tables and views in the current schema.
If set to False, the results returned from a GetSchema call are not restricted to tables and views in the current schema unless the call includes Restrictions parameters.
Default
False
Category
Schema Information
User ID
Property
UserID
Description
Specifies the default user name used to connect to your Oracle database.
Valid Values
string
where string is a valid user name.
Example
Scott
Default
An empty string
Category
Security
Validate Server Certificate
Property
ValidateServerCertificate
Description
Specifies whether the data provider must verify the server certificate as valid according to a Certificate Authority.
Valid Values
True | False
If set to True, the data provider validates the server certificate during authentication.
If set to False, no certificate verification is required during authentication.
Default
True
Category
Security
Work Arounds
Property
WorkArounds
Description
This option is reserved. Enter values only when directed by Progress Customer Support.
Default
0
Category
Advanced
Functionality Differences for the Entity Framework Data Provider
NOTE: Some connection string options are not supported in the ADO.NET Entity Framework. However, the functionality is provided a different way. For more information, see the following sections: