.show database

Returns a table showing the properties of the context database.

To return a table in which every record corresponds to a database in the cluster that the user has access to, see .show databases.

Syntax

.show database [details | identity | policies | datastats]

The default call without any options specified is equal to 'identity' option.

Output for 'identity' option

Output parameter Type Description
DatabaseName String The database name. Database names are case-sensitive.
PersistentStorage String The persistent storage URI in which the database is stored. (This field is empty for ephemeral databases.)
Version String Database version number. This number is updated for each change operation in the database (such as adding data and changing the schema).
IsCurrent Boolean True if the database is the one that the current connection points to.
DatabaseAccessMode String How the cluster is attached to the database. For example, if the database is attached in ReadOnly mode then the cluster will fail all requests to modify the database in any way.
PrettyName String The database pretty name.
CurrentUserIsUnrestrictedViewer Boolean Specifies if the current user is an unrestricted viewer on the database.
DatabaseId Guid The database's unique ID.

Output for 'details' option

Output parameter Type Description
DatabaseName String The database name. Database names are case-sensitive.
PersistentStorage String The persistent storage URI in which the database is stored. (This field is empty for ephemeral databases.)
Version String The database version number. This number is updated for each change operation in the database (such as adding data and changing the schema).
IsCurrent Boolean True if the database is the one that the current connection points to.
DatabaseAccessMode String How the cluster is attached to the database. For example, if the database is attached in ReadOnly mode then the cluster will fail all requests to modify the database in any way.
PrettyName String The database's pretty name.
AuthorizedPrincipals String The database's collection of authorized principals (serialized in JSON format).
RetentionPolicy String The database's Retention policy (serialized in JSON format).
MergePolicy String The database's Extents Merge policy (serialized in JSON format).
CachingPolicy String The database's Caching policy (serialized in JSON format).
ShardingPolicy String The database's Sharding policy (serialized in JSON format).
StreamingIngestionPolicy String The database's Streaming Ingestion policy (serialized in JSON format).
IngestionBatchingPolicy String The database's Ingestion Batching policy (serialized in JSON format).
TotalSize Real The database's extents total size in bytes.
DatabaseId Guid The database's unique ID.
NumberOfTables Int64 The database's number of tables (not including external tables or materialized views).
NumberOfExternalTables Int64 The database's number of external tables.
NumberOfMaterializedViews Int64 The database's number of materialized views.

Output for 'policies' option

Output parameter Type Description
DatabaseName String The database name. Database names are case-sensitive.
PersistentStorage String The persistent storage URI in which the database is stored. (This field is empty for ephemeral databases.)
Version String The database version number. This number is updated for each change operation in the database (such as adding data and changing the schema).
IsCurrent Boolean True if the database is the one that the current connection points to.
DatabaseAccessMode String How the cluster is attached to the database. For example, if the database is attached in ReadOnly mode then the cluster will fail all requests to modify the database in any way.
PrettyName String The database's pretty name.
DatabaseId Guid The database's unique ID.
AuthorizedPrincipals String The database's collection of authorized principals (serialized in JSON format).
RetentionPolicy String The database's Retention policy (serialized in JSON format).
MergePolicy String The database's Extents Merge policy (serialized in JSON format).
CachingPolicy String The database's Caching policy (serialized in JSON format).
ShardingPolicy String The database's Sharding policy (serialized in JSON format).
StreamingIngestionPolicy String The database's Streaming Ingestion policy (serialized in JSON format).
IngestionBatchingPolicy String The database's Ingestion Batching policy (serialized in JSON format).

Output for 'datastats' option

Output parameter Type Description
DatabaseName String The database name. Database names are case-sensitive.
PersistentStorage String The persistent storage URI in which the database is stored. (This field is empty for ephemeral databases.)
Version String The database version number. This number is updated for each change operation in the database (such as adding data and changing the schema).
IsCurrent Boolean True if the database is the one that the current connection points to.
DatabaseAccessMode String How the cluster is attached to the database. For example, if the database is attached in ReadOnly mode then the cluster will fail all requests to modify the database in any way.
PrettyName String The database's pretty name.
DatabaseId Guid The database's unique ID.
OriginalSize Real The database's extents total original size.
ExtentSize Real The database's extents total size (data + indices).
CompressedSize Real The database's extents total data compressed size.
IndexSize Real The database's extents total index size.
RowCount Long The database's extents total row count.
HotOriginalSize Real The database's hot extents total original size.
HotExtentSize Real The database's hot extents total size (data + indices).
HotCompressedSize Real The database's hot extents total data compressed size.
HotIndexSize Real The database's hot extents total index size.
HotRowCount Long The database's hot extents total row count.