Database interface

Information about a single database

Properties

collation

Collation name of the database

compatibilityLevel

SQL Server compatibility level of database. Possible values include: 'CompatLevel80', 'CompatLevel90', 'CompatLevel100', 'CompatLevel110', 'CompatLevel120', 'CompatLevel130', 'CompatLevel140'

databaseState

State of the database. Possible values include: 'Online', 'Restoring', 'Recovering', 'RecoveryPending', 'Suspect', 'Emergency', 'Offline', 'Copying', 'OfflineSecondary'

fqdn

Fully qualified name

id

Unique identifier for the database

installId

Install id of the database

name

Name of the database

serverCoreCount

Number of cores on the server

serverDefaultBackupPath

Default path of the backup folder

serverDefaultDataPath

Default path of the data files

serverDefaultLogPath

Default path of the log files

serverEdition

Edition of the server

serverId

The unique Server Id

serverLevel

Product level of the server (RTM, SP, CTP).

serverName

Name of the server

serverVersion

Version of the server

serverVisibleOnlineCoreCount

Number of cores on the server that have VISIBLE ONLINE status

Property Details

collation

Collation name of the database

collation?: string

Property Value

string

compatibilityLevel

SQL Server compatibility level of database. Possible values include: 'CompatLevel80', 'CompatLevel90', 'CompatLevel100', 'CompatLevel110', 'CompatLevel120', 'CompatLevel130', 'CompatLevel140'

compatibilityLevel?: DatabaseCompatLevel

Property Value

databaseState

State of the database. Possible values include: 'Online', 'Restoring', 'Recovering', 'RecoveryPending', 'Suspect', 'Emergency', 'Offline', 'Copying', 'OfflineSecondary'

databaseState?: DatabaseState

Property Value

fqdn

Fully qualified name

fqdn?: string

Property Value

string

id

Unique identifier for the database

id?: string

Property Value

string

installId

Install id of the database

installId?: string

Property Value

string

name

Name of the database

name?: string

Property Value

string

serverCoreCount

Number of cores on the server

serverCoreCount?: number

Property Value

number

serverDefaultBackupPath

Default path of the backup folder

serverDefaultBackupPath?: string

Property Value

string

serverDefaultDataPath

Default path of the data files

serverDefaultDataPath?: string

Property Value

string

serverDefaultLogPath

Default path of the log files

serverDefaultLogPath?: string

Property Value

string

serverEdition

Edition of the server

serverEdition?: string

Property Value

string

serverId

The unique Server Id

serverId?: string

Property Value

string

serverLevel

Product level of the server (RTM, SP, CTP).

serverLevel?: string

Property Value

string

serverName

Name of the server

serverName?: string

Property Value

string

serverVersion

Version of the server

serverVersion?: string

Property Value

string

serverVisibleOnlineCoreCount

Number of cores on the server that have VISIBLE ONLINE status

serverVisibleOnlineCoreCount?: number

Property Value

number