Using connection parameters

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

Table 2-1: Connection parameters

Property names

Description

Required

Default value

AnsiNull

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

No

1

ApplicationName

The name Adaptive Server 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

Specifies the character set that is used to communicate to Adaptive Server. By default, the Adaptive Server OLE DB Driver negotiates the same default character set as the Adaptive Server.

No

Empty

ClientCharset

Specifies the client character set. In cases where ClientCharset is different from CharSet, the Adaptive Server OLE DB Provider converts the client's character set to the character set specified by CharSet.

No

The character set currently used by the operating system.

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

CodePageType

Specifies the type of character encoding used. The valid values are ANSI and OEM.

No

ANSI

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 Adaptive Server to compile/prepare. This can boost performance if you use the same query repeatedly.

No

0

EnableServerPacketSize

Allows Adaptive Server 15.0 or later to choose the optimal packetsize.

No

1

EncryptedPassword

Specifies whether password is transmitted in an encrypted format:

  • 0 – use plain text password.

  • 1 – use encrypted password. If it is not supported, return an error message.

  • 2 – use encrypted password. If it is not supported, use plain text password.

NoteWhen password encryption is enabled, and the server supports asymmetric encryption, asymmetric encryption is used instead of symmetric encryption.

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 Adaptive Server returns error messages.

No

Empty – Adaptive Server 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

15

MutualAuthentication

Enables Kerberos Mutual Authentication.

No

0 (disabled)

oldpassword

The current password. If oldpassword contains a value that is not null or an empty string, the current password is changed to the value contained in PWD.

No

Empty

PacketSize

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

No

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

Port

The port number of the Adaptive Server server.

No, if data source is specified.

Empty

PWD, Password

Contains the value of the password. When performing a normal login, oldpassword is not set and PWD contains the value of the current password. When changing the password, oldpassword is set to the current password and PWD contains the value of the new password.

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

Empty

QuotedIdentifier

Specifies if Adaptive Server 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 Adaptive 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 Adaptive Server acting as a failover server in an active-active or active-passive setup.

Yes, if HASession is set to 1

Empty

Server

The name or the IP address of the Adaptive Server.

No, if data source is specified.

Empty

ServerInitiated Transactions

When ServerInitiatedTransactions is set to 1, Adaptive Server starts managing transactions as needed. The driver issues a set chained on command on the connection. Set this property to 0 if you 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. Adaptive Server 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

User ID, UserID, UID

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

Yes

None