Table: azure_cosmosdb_sql_database - Query Azure Cosmos DB SQL Databases using SQL
Azure Cosmos DB is a globally distributed, multi-model database service designed for scalable and high-performance modern applications. It is a fully managed NoSQL database for modern app development with guaranteed single-digit millisecond response times and 99.999-percent availability backed by SLAs, automatic and instant scalability, and open source APIs for MongoDB and Cassandra. A SQL Database in Azure Cosmos DB is a schema-less JSON database engine with SQL querying capabilities.
Table Usage Guide
The azure_cosmosdb_sql_database
table provides detailed insights into SQL Databases within Azure Cosmos DB. As a database administrator or developer, you can explore database-specific details through this table, including throughput settings, indexing policies, and associated metadata. Utilize it to monitor database performance, manage configurations, and ensure optimal resource utilization.
Examples
Basic info
Explore which Azure CosmosDB SQL databases are tied to specific accounts and regions. This can be helpful in managing resources and understanding the distribution of databases across different regions and accounts.
select name, account_name, database_users, region, resource_groupfrom azure_cosmosdb_sql_database;
select name, account_name, database_users, region, resource_groupfrom azure_cosmosdb_sql_database;
Database count per cosmosdb accounts
Determine the number of databases associated with each CosmosDB account to better manage resources and plan for scaling needs.
select account_name, count(name) as database_countfrom azure_cosmosdb_sql_databasegroup by account_name;
select account_name, count(name) as database_countfrom azure_cosmosdb_sql_databasegroup by account_name;
List of sql databases without application tag key
Identify Azure Cosmos DB SQL databases that have not been tagged with an 'application' key. This can be useful in managing and organizing databases, particularly in larger systems where proper tagging can streamline operations and maintenance.
select name, tagsfrom azure_cosmosdb_sql_databasewhere not tags :: JSONB ? 'application';
select name, tagsfrom azure_cosmosdb_sql_databasewhere json_extract(tags, '$.application') is null;
Query examples
Schema for azure_cosmosdb_sql_database
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form. | |
account_name | text | = | The friendly name that identifies the database account in which the database is created. |
akas | jsonb | Array of globally unique identifier strings (also known as) for the resource. | |
autoscale_settings_max_throughput | bigint | Contains maximum throughput, the resource can scale up to. | |
cloud_environment | text | The Azure Cloud Environment. | |
database_colls | text | A system generated property that specified the addressable path of the collections resource. | |
database_etag | text | A system generated property representing the resource etag required for optimistic concurrency control. | |
database_id | text | Name of the Cosmos DB SQL database. | |
database_rid | text | A system generated unique identifier for database. | |
database_ts | bigint | A system generated property that denotes the last updated timestamp of the resource. | |
database_users | text | A system generated property that specifies the addressable path of the users resource. | |
id | text | Contains ID to identify a sql database uniquely. | |
name | text | = | The friendly name that identifies the sql database. |
region | text | The Azure region/location in which the resource is located. | |
resource_group | text | = | The resource group which holds this resource. |
sp_connection_name | text | =, !=, ~~, ~~*, !~~, !~~* | Steampipe connection name. |
sp_ctx | jsonb | Steampipe context in JSON form. | |
subscription_id | text | =, !=, ~~, ~~*, !~~, !~~* | The Azure Subscription ID in which the resource is located. |
tags | jsonb | A map of tags for the resource. | |
throughput | bigint | Contains the value of the Cosmos DB resource throughput or autoscaleSettings. | |
title | text | Title of the resource. | |
type | text | Type of the resource. |
Export
This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.
You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh
script:
/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- azure
You can pass the configuration to the command with the --config
argument:
steampipe_export_azure --config '<your_config>' azure_cosmosdb_sql_database