Skip to main content
Version: 2025.1

AliasSubDbMssql

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

Overview​

PropertySummary
authenticationTypeControls the type of connection between the ADITO server and the MS SQL database.
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.
databaseThe name of the database to which this alias is to be connected.
enableSnapshotIsolationDetermines, if snapshot isolation is enabled.
hostThe host under which the the Microsoft SQL Server is reachable.
instanceNameThe name of the instance to use. If an instance is used, the port is discarded.
passwordThe password of the user to be used to log on to the the Microsoft SQL Server.
portThe port under which the the Microsoft SQL Server is reachable.
schemaThe database schema to which this alias is to be connected.
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)
timezoneThe timezone of the alias definition.
userThe user to be used to log on to the Microsoft SQL Server.

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.


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.


database​

Type: String

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


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


host​

Type: String

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


instanceName​

Type: String

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


password​

Type: String

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


port​

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

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


schema​

Type: String

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


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)


timezone​

Type: String

The timezone of the alias definition.


user​

Type: String

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