Using connection parameters

Following is a list of connection parameters that can be supplied to the ASE OLE DB Provider.

Table 2-1: Connection parameters

Property names

Description

Required

Default value

User ID, UserID, UID

A case-sensitive user ID required to connect to the ASE server.

Yes

None

PWD, Password

A case-sensitive password to connect to the ASE server.

No, if the user name does not require a password.

Empty

Server

The name or the IP address of the ASE server.

No, if data source is specified.

Empty

Port

The port number of the ASE server.

No, if data source is specified.

Empty

AnsiNull

Strict compliance where you cannot use “= NULL.” Instead, you must use “IsNull.”

No

1

ApplicationName

The name ASE uses to identify the client application.

No

Empty

BufferCacheSize

Keeps the input and output buffers in pool. When large results will occur, increase this value to boost performance.

No

20

CharSet

The designated character set. The specified character set must be installed on the ASE server.

Starting with version 15.0, the charset behavior has changed. If you want to use the ASE server's charset, you must specify it in the connection properties with Charset=ServerDefault. Otherwise, the driver picks up the charset which the client specifies, or gets it from the system environment variables in the order of LC_CTYPE and LANG. If both the environment variables have not been defined, it uses the value iso_1.

No

Empty

ClientHostName

The name of the client host passed in the login record to the server.

No

Empty

ClientHostProc

The identity of the client process on this host machine passed in the login record to the server.

No

Empty

CRC

By default, the driver returns the total records updated when multiple update statements are executed in a stored procedure. This count will also include all updates happening as part of the triggers set on an update or an insert.

Set this property to 0 if you want the driver to return only the last update count.

No

1

DataIntegrity

Enables Kerberos Data Integrity.

No

0 (disabled)

Data Source

The Data Source you want to connect in Server:Port format.

No, if server and port are specified.

Empty

DSPassword

The password used to authenticate on the LDAP server, if the LDAP server does not allow anonymous access. The password can be specified in the DSURL as well.

No

Empty

DSPrincipal

The user name used to authenticate on the LDAP server, if the LDAP server does not allow anonymous access. The Principal can be specified in the DSURL as well.

No

Empty

DSURL

The URL to the LDAP server.

No

Empty

DynamicPrepare

When set to 1, the driver sends SQLPrepare calls to ASE to compile/prepare. This can boost performance if you use the same query repeatedly.

No

0

EnableServerPacketSize

Allows ASE server versions 15.0 or later to choose the optimal packetsize.

No

1

EncryptedPassword

Specifies if password encryption is enabled: 0 indicates password encryption is disabled, 1 indicates password encryption is enabled.

No

0

Encryption

The designated encryption. Possible values: ssl.

No

Empty

HASession

Specifies if high availability is enabled: 0 indicates high availability disabled, 1 high availability enabled.

No

0

Initial Catalog, Database

The database to which you want to connect.

No

Empty

Language

The language in which ASE returns error messages.

No

Empty – ASE uses English by default.

LoginTimeOut

Number of seconds to wait for a login attempt before returning to the application. If set to 0, the timeout is disabled and a connection attempt waits for an indefinite period of time.

No

10

MutualAuthentication

Enables Kerberos Mutual Authentication.

No

0 (disabled)

PacketSize

The number of bytes per network packet transferred between ASE and the client.

No

Server determined when driver is connected to ASE 15.0 or later. For older ASE servers the default is 512.

QuotedIdentifier

Specifies if ASE treats character strings enclosed in double quotes as identifiers: 0 indicates do not enable quoted identifiers, 1 indicates enable quoted identifiers.

No

0

ReplayDetection

Enables Kerberos Replay Detection.

No

0

RestrictMaximum PacketSize

If the you have memory constraints when EnableServerPacketSize is set to 1, then set this property to an int value in multiples of 512 to a maximum of 65536.

No

0

SecondaryPort

The port number of the ASE server acting as a failover server in an active-active or active-passive setup.

Yes, if HASession is set to 1

Empty

SecondaryServer

The name or the IP address of the ASE server acting as a failover server in an active-active or active-passive setup.

Yes, if HASession is set to 1

Empty

ServerInitiated Transactions

When SQL_ATTR_AUTOCOMMIT is set to “1,” Adaptive Server starts managing transactions as needed. The driver issues a set chained on command on the connection. Older ODBC Drivers do not use this feature and manage the job of starting transactions. Set this property to’'0’ if you want to maintain the old behavior or require that your connection not use “chained” transaction mode.

No

1

TextSize

The maximum size of binary or text data that will be sent over the wire.

No

Empty. ASE default is 32K.

TrustedFile

If encryption is set to ssl, this property should be set to the path to the Trusted File.

No

Empty

UseCursor

Specifies whether cursors are to be used by the driver: 0 indicates do not use cursors, and 1 indicates use cursors.

No

0