Azure Cosmosdb

What it does

This skill enables AI agents to interact with Azure Cosmos DB, a fully managed NoSQL database service. Specifically, it focuses on the NoSQL (Core) API, which provides a flexible document database. The skill allows for accessing, querying, and managing data stored within your Cosmos DB accounts, understanding concepts like containers, items, partition keys, and request units (RUs). It's designed to help you leverage Cosmos DB’s scalability and performance capabilities effectively.

When to use it

• Managing user data: Retrieve or update user profiles and order information using a userId as the partition key.
• Multi-tenant applications: Query documents based on tenant identifiers for efficient access within a shared database environment.
• IoT telemetry analysis: Access device readings and sensor data organized by deviceId.
• Log aggregation and analysis: Query logs partitioned using synthetic keys (e.g., date + category).
• Working with graph databases: While the skill primarily focuses on NoSQL Core, it can be adapted to interact with other Cosmos DB APIs like Gremlin for graph database operations.

Key capabilities

• Access and query data within Azure Cosmos DB accounts.
• Supports the NoSQL (Core) API, MongoDB, PostgreSQL (Citus), Apache Cassandra, Apache Gremlin, and Table APIs.
• Understands key concepts such as containers, items, partition keys, logical partitions, physical partitions, and request units.
• Provides guidance on designing effective partition keys for optimal performance and scalability.

Example prompts

• "Retrieve all documents where userId is 'user-456'."
• "Find all logs from the tenant with ID 'tenant-abc' that occurred on 2024-01-15."
• "Show me the latest telemetry readings for deviceId 'device-789'."

Tips & gotchas

• Partition Key Design is Crucial: Carefully consider your partition key strategy. Avoid low cardinality or monotonically increasing keys to prevent hot partitions and ensure even data distribution.
• RU Consumption: Be mindful of request units (RUs) when querying, as they represent the throughput currency for Cosmos DB operations.
• Environment Variables: The skill requires environment variables COSMOS_ENDPOINT, COSMOS_KEY, and COSMOS_DATABASE to be configured.