Azure Cosmos DB

https://learn.microsoft.com/en-us/azure/cosmos-db/
Admin
Azure Cosmos DB is a fully managed distributed NoSQL, relational, and vector database designed for...
Tokens:2,000,731
Snippets:15,296
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### get command examples

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/command-reference

Examples of the get command, including with and without partition key.

```bash
# Get document
CS > get user1

# Get with partition key
CS > get user1 --partition-key user1

```

--------------------------------

### Install dependencies and run NodeJS sample

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/mongodb/readpreference-global-distribution

For the NodeJS sample, these commands install required packages and start the application. The application will fail initially due to an invalid connection string.

```bash
cd mean
npm install
node index.js

```

--------------------------------

### CLI startup options examples

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/command-reference

Examples of launching the shell with Entra ID authentication, managed identity, and explicit ARM context.

```bash
# Launch with Entra ID authentication
cosmosdbshell --connect https://myaccount.documents.azure.com:443/ --connect-tenant=<tenant-id>

# Launch with managed identity
cosmosdbshell --connect https://myaccount.documents.azure.com:443/ --connect-managed-identity=<client-id>

# Launch with explicit ARM context
cosmosdbshell --connect https://myaccount.documents.azure.com:443/ --connect-tenant=<tenant-id> --connect-subscription=<subscription-id> --connect-resource-group=<resource-group>
```

--------------------------------

### Clone and install the complete sample

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/gen-ai/langchain-javascript-get-started

Use these Bash commands to clone the GitHub sample repository, change into its directory, and install dependencies. After setting the required environment variables, run `node get-started.js` to execute the complete application.

```bash
git clone https://github.com/AzureCosmosDB/langchainjs-cosmosdb-rag-quickstart.git
cd langchainjs-cosmosdb-rag-quickstart
npm install
```

--------------------------------

### Example JSON response for getting a user

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/tutorial-springboot-azure-kubernetes-service

This JSON snippet shows an example response from the GET /users/{email} endpoint, containing the user's details.

```json
{
  "email": "john.doe@foobar.com",
  "firstName": "John",
  "lastName": "Doe",
  "city": "Dallas"
}
```

--------------------------------

### mkdb examples

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/command-reference

Examples of creating a database with default settings, provisioned throughput, and autoscale.

```bash
# Create database with default settings
CS > mkdb mydb

# Create database with provisioned throughput
CS > mkdb mydb --throughput 400

# Create database with autoscale
CS > mkdb mydb --autoscale 4000

```

--------------------------------

### Start the Kafka-Cosmos Cassandra integration pipeline

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/cassandra/kafka-connect

Starts all services defined in the docker-compose file. This may take a while to download and start the containers; it is a one-time setup.

```shell
docker-compose --project-name kafka-cosmos-cassandra up --build

```

--------------------------------

### echo example: output text

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/command-reference

Example of using echo to display a message. The output is shown as 'Starting operations...'.

```bash
CS > echo "Starting operations..."
Starting operations...

```

--------------------------------

### Run the application: node get-started.js

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/gen-ai/langchain-javascript-get-started

Run this command to execute the application. Ensure get-started.js, sample-data.txt, and package.json with "type": "module" are present.

```Bash
node get-started.js

```

--------------------------------

### Install CQLSH on Unix/Linux/Mac

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/cassandra/support

Installs Java, imports the Baltimore CyberTrust root certificate, and installs Cassandra 3.11.13 to get CQLSH. This is required before connecting to Azure Cosmos DB for Apache Cassandra.

```bash
# Install default-jre and default-jdk
sudo apt install default-jre
sudo apt-get update
sudo apt install default-jdk

# Import the Baltimore CyberTrust root certificate:
curl https://cacert.omniroot.com/bc2025.crt > bc2025.crt
keytool -importcert -alias bc2025ca -file bc2025.crt

# Install the Cassandra libraries in order to get CQLSH:
echo "deb https://downloads.apache.org/cassandra/debian 311x main" | sudo tee -a /etc/apt/sources.list.d/cassandra.sources.list
curl https://downloads.apache.org/cassandra/KEYS | sudo apt-key add -
sudo apt-get update
sudo apt-get install cassandra=3.11.13

```

--------------------------------

### Java application starting point without comments

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/cassandra/manage-data-java-v4-sdk

The Java application after removing comments and console output. This is the starting point for the remainder of the guide.

```java
package quickstart;

public class App 
{
    public static void main(String[] args)
    {
    }
}

```

--------------------------------

### Initialize Go module and install dependencies

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/quickstart-vector-store-go

Changes to the project directory and initializes the Go module with the name 'vector-search-quickstart'.

```bash
cd vector-search-quickstart
go mod init vector-search-quickstart

```

--------------------------------

### create command examples

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/command-reference

Examples of the create command, including simple, nested, and array documents.

```bash
# Create simple document
CS > create item {"id": "user1", "name": "Alice"}

# Create nested document
CS > create item {"id": "user2", "name": "Bob", "address": {"city": "Seattle", "country": "USA"}}

# Create with array
CS > create item {"id": "user3", "name": "Charlie", "tags": ["vip", "premium"]}

```

--------------------------------

### Install Cassandra Go driver with go get

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/cassandra/manage-data-go

Import the `github.com/apache/cassandra-gocql-driver/v2` package from Go. This installs the client library required for connecting to the Cassandra account.

```bash
go get github.com/apache/cassandra-gocql-driver/v2

```

--------------------------------

### Install PostgreSQL extension with create_extension() function

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/postgresql/reference-extensions

Use the create_extension() function when CREATE EXTENSION fails with a permission denied error. This example installs the PostGIS extension.

```sql
SELECT create_extension('postgis');
```

--------------------------------

### Run the sample

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/quickstart-create-vector-index-dotnet

Run the sample project using the .NET CLI.

```console
dotnet run --project nosql-create-index-dotnet.csproj

```

--------------------------------

### Initialize project with azd init

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/quickstart-nodejs

Initialize the project using the `cosmos-db-nosql-nodejs-quickstart` template.

```bash
azd init --template cosmos-db-nosql-nodejs-quickstart

```

--------------------------------

### Azure PowerShell: Install required module version

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/periodic-backup-update-storage-redundancy

Install the Az.CosmosDB module version 1.4.0 or higher using the `Install-Module` cmdlet. This is required for the Azure PowerShell commands in this guide.

```powershell
$parameters = @{
    Name = "Az.CosmosDB"
    RequiredVersion = "1.4.0"
}
Install-Module @parameters

```

--------------------------------

### Emulator command examples for each parameter

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/emulator-windows-arguments

Example commands for each emulator parameter, including startup, help, status, shutdown, data path, ports, API endpoints, key file, reset, traces, SSL certificate, and direct ports. Each example shows the exact command to run.

```powershell
Microsoft.Azure.Cosmos.Emulator.exe
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /?
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /GetStatus
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /Shutdown
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /DataPath=E:\SomeDataFolder
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /Port=65000
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /ComputePort=65100
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /EnableMongoDbEndpoint=3.2
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /EnableMongoDbEndpoint=3.6
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /EnableMongoDbEndpoint=4.0
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /MongoPort=65200
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /EnableCassandraEndpoint
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /CassandraPort=65300
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /EnableGremlinEndpoint
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /GremlinPort=65400
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /EnableTableEndpoint
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /TablePort=65500
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /KeyFile=D:\Keys\keyfile
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /ResetDataPath
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /StartTraces
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /StopTraces
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /StartWprTraces
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /StopWprTraces
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /FailOnSslCertificateNameMismatch
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /GenCert
```

```powershell
Microsoft.Azure.Cosmos.Emulator.exe /DirectPorts:65600,65700
```

--------------------------------

### Install Azure Cosmos DB Python SDK in virtual environment

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/how-to-python-get-started

Use this command to install the Azure Cosmos DB for NoSQL Python SDK in a virtual environment. This is part of the project setup for the tutorial.

```bash
pip install azure-cosmos
```

--------------------------------

### Change to the .NET sample directory

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/quickstart-create-vector-index-dotnet

Navigate to the .NET sample directory for the create-index sample.

```bash
cd nosql-create-index-dotnet
```

--------------------------------

### Get-CosmosDbEmulatorStatus with AlternativeInstallLocation

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/emulator-windows-arguments

Gets the status of an emulator installed in the D:\SomeFolder\AzureCosmosDBEmulator folder by passing the AlternativeInstallLocation parameter via a splatting variable.

```powershell
@parameters = {
    AlternativeInstallLocation = "D:\SomeFolder\AzureCosmosDBEmulator"
}
Get-CosmosDbEmulatorStatus @parameters
```

--------------------------------

### cd - Change directory examples

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/command-reference

Examples of navigating to a database, container, going back one level, and navigating to root.

```bash
# Navigate to a database
CS > cd mydb
# Navigate to a container
CS > cd users
# Go back one level
CS > cd ..
# Navigate to root
CS > cd /
CS >

```

--------------------------------

### Error: Failed to start MCP server

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/troubleshooting

Error message when the MCP server fails to start. Possible causes include port already in use, invalid settings, Cosmos DB Shell not properly installed, or firewall blocking the port.

```text
Failed to start MCP server

```

--------------------------------

### JSON output showing migration in progress

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/migrate-continuous-backup

Example output after migration starts, showing migrationState with status InProgress and targetType Continuous.

```json
{
  ...
  "backupPolicy": {
    ...
    "migrationState": {
      "status": "InProgress",
      "targetType": "Continuous"
    },
    "type": "Periodic"
  },
  ...
}

```

--------------------------------

### Start the sample application

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/cassandra/access-data-spring-data-app

Run the built JAR file to start the Spring Data Cassandra application.

```shell
java -jar target/spring-data-cassandra-on-azure-0.1.0-SNAPSHOT.jar

```

--------------------------------

### Establish connection in Phoenix

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/migrate-hbase

Uses JDBC to get a connection to an HBase cluster via Phoenix. This is the Phoenix alternative to the HBase connection example.

```Java
//Use JDBC to get a connection to an HBase cluster
Connection conn = DriverManager.getConnection("jdbc:phoenix:server1,server2:3333",props);
```

--------------------------------

### Initialize project template with azd init

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/quickstart-go

Initializes the quickstart project using the `cosmos-db-nosql-go-quickstart` template. You will be prompted to configure a unique environment name during initialization.

```Azure CLI
azd init --template cosmos-db-nosql-go-quickstart

```

--------------------------------

### Get a table (JavaScript)

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/table/quickstart-nodejs

Creates an instance of the TableClient type using the GetTableClient function of the TableServiceClient type. The example uses a credential variable that must be defined.

```JavaScript
let table = new TableClient("<azure-cosmos-db-table-account-endpoint>", "<azure-cosmos-db-table-name>", credential);

```

--------------------------------

### Initialize project with azd init

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/table/quickstart-java

Use this command to initialize the project from the cosmos-db-table-java-quickstart template.

```bash
azd init --template cosmos-db-table-java-quickstart

```

--------------------------------

### help examples: general, specific command, container commands

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/command-reference

Examples of using help: general help, help for a specific command (query), and help for container commands (mkcon).

```bash
# General help
CS > help

# Help for specific command
CS > help query

# Help for container commands
CS > help mkcon

```

--------------------------------

### Get a table (TypeScript)

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/table/quickstart-nodejs

Creates an instance of the TableClient type using the GetTableClient function of the TableServiceClient type. The example uses a credential variable that must be defined.

```TypeScript
let table: TableClient = new TableClient("<azure-cosmos-db-table-account-endpoint>", "<azure-cosmos-db-table-name>", credential);

```

--------------------------------

### PowerShell: Sample Request for Table Backup Information

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/get-latest-restore-timestamp

Example command to get backup information for a specific Table API table. Replace the sample values with your own.

```powershell
Get-AzCosmosDBTableBackupInformation   `
  -ResourceGroupName "rg" `
  -AccountName "amisitablepitracc1" `
  -Name "table1" `
  -Location "eastus"

```

--------------------------------

### mkcon examples

Source: https://learn.microsoft.com/en-us/azure/cosmos-db/shell/command-reference

Examples of creating a container with various options: partition key, throughput, autoscale, TTL, and unique key.

```bash
# Create container with partition key
CS > mkcon users -pk /id

# Create with provisioned throughput
CS > mkcon users -pk /id --throughput 400

# Create with autoscale
CS > mkcon users -pk /id --autoscale 4000

# Create with TTL
CS > mkcon users -pk /id --ttl 86400

# Create with unique key
CS > mkcon users -pk /id --unique-key /email

```
Tokens:
Raw