Skip to main content

AliasSubDbMssql

This page provides generated reference documentation for the AliasSubDbMssql data model.

Overview

PropertySummary
hostThe host under which the the Microsoft SQL Server is reachable.
portThe port under which the the Microsoft SQL Server is reachable.
databaseThe name of the database to which this alias is to be connected.
instanceNameThe name of the instance to use. If an instance is used, the port is discarded.
schemaThe database schema to which this alias is to be connected.
authenticationTypeControls the type of connection between the ADITO server and the MS SQL database.
userThe user to be used to log on to the Microsoft SQL Server.
passwordThe password of the user to be used to log on to the the Microsoft SQL Server.
timezoneThe timezone of the alias definition.
autoOrderByIDIf yes/true, each frame is automatically sorted by the ID column of the respective database table. If no/false, no automatic sorting will be executed.
selectMethodSelects if adaptive buffering should be used. This can be useful to prevent OutOfMemory errors, if big resultsets are to be handled by the JDBC driver.
sendStringParametersAsUnicodeDetermines, if the JDBC driver sends instructions in Unicode (true) or ASCII-/MBCS format (false)
enableSnapshotIsolationDetermines, if snapshot isolation is enabled.

host

Type: String

The host under which the the Microsoft SQL Server is reachable.


port

Type: Integer
Default: 1433
Constraints: Minimum: 0, Maximum: 65536

The port under which the the Microsoft SQL Server is reachable.


database

Type: String

The name of the database to which this alias is to be connected.


instanceName

Type: String

The name of the instance to use. If an instance is used, the port is discarded.


schema

Type: String

The database schema to which this alias is to be connected.


authenticationType

Type: EAuthenticationTypeMSSQL

Controls the type of connection between the ADITO server and the MS SQL database.

Integrated uses the currently logged on user.

Kerberos also uses the currently logged on user and instead of the NTLM the Kerberos scheme.

Basic requires a user name and password.


user

Type: String

The user to be used to log on to the Microsoft SQL Server.


password

Type: String

The password of the user to be used to log on to the the Microsoft SQL Server.


timezone

Type: String

The timezone of the alias definition.


autoOrderByID

Type: Boolean
Default: true

If yes/true, each frame is automatically sorted by the ID column of the respective database table. If no/false, no automatic sorting will be executed.


selectMethod

Type: String

Selects if adaptive buffering should be used. This can be useful to prevent OutOfMemory errors, if big resultsets are to be handled by the JDBC driver.


sendStringParametersAsUnicode

Type: Boolean
Default: false

Determines, if the JDBC driver sends instructions in Unicode (true) or ASCII-/MBCS format (false)


enableSnapshotIsolation

Type: Boolean
Default: false

Determines, if snapshot isolation is enabled.
It is recommended to enable this option, if your version of SQL Server supports the feature.
You have to enable snapshot isolation for every database using:
ALTER DATABASE YOUR_DATABASE_NAME SET ALLOW_SNAPSHOT_ISOLATION ON