Skip to main content
Version: 2026.0

DatabaseConnectionData

Information object for connections of a single database alias.

It provides general information about the type of database and the properties used to configure the connection.

It provides counts for the free and used connections of the database.

Methods​

getAdditionalProperties​

getAdditionalProperties(): Map<any, any>

Returns​

Map<any, any>

a map of additional connection properties used for the database connection.

getAliasName​

getAliasName(): string

Returns​

string

the name of the database alias.

getConfigName​

getConfigName(): string

Returns​

string

the configuration name of the database alias.

getConnectionInfo​

getConnectionInfo(pServerId): DatabaseServerConnectionData

Returns the connection data of the specified server for this database.

Parameters​

pServerId
string | number | boolean

the id of the server.

Returns​

DatabaseServerConnectionData

the DatabaseServerConnectionData for the server, or null if no such object exists.

getConnectionInfos​

getConnectionInfos(): DatabaseServerConnectionData[]

Returns​

DatabaseServerConnectionData[]

an array of all DatabaseServerConnectionData objects related to this database.

getDatabaseId​

getDatabaseId(): string

Returns​

string

the UID of the database.

getDatabaseName​

getDatabaseName(): string

Returns​

string

the name of the database.

getDatabaseType​

getDatabaseType(): number

Returns​

number

the type of the database.

getDBTypeDisplayName​

getDBTypeDisplayName(): string

Returns​

string

a display string of the database type.

getFreeConnections​

getFreeConnections(): number

Returns​

number

the total amount of free database connections for this database.

getLastestTimestamp​

getLastestTimestamp(): number

Returns​

number

the timestamp of the latest update in milliseconds.

getProperties​

getProperties(): Map<any, any>

Returns​

Map<any, any>

a map of the standard connection properties used for the database connection.

getServerIds​

getServerIds(): string[]

Returns​

string[]

an array of all server ids for which this database info contains respective server connection objects.

getTimezone​

getTimezone(): string

Returns​

string

the timezone of the database.

getUsedConnections​

getUsedConnections(): number

Returns​

number

the total amount of used database connections for this database.