Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/modules/cosmosdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Cosmos DB Emulator Module (Linux-based)

[Azure Cosmos DB](https://azure.microsoft.com/en-GB/products/cosmos-db) is a globally distributed, multi-model database service provided by Microsoft.

## Install

```bash
npm install @testcontainers/azurecosmosdb --save-dev
```

## Examples
<!--codeinclude-->
[Connect to emulator and create a database:](../../packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts) inside_block:httpCreateDB
<!--/codeinclude-->

<!--codeinclude-->
[Using HTTPS:](../../packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts) inside_block:httpsCreateDB
<!--/codeinclude-->

<!--codeinclude-->
[Create and read items:](../../packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts) inside_block:createAndRead
<!--/codeinclude-->

## Caveats
### Compatibility
This testcontainer uses the [linux-based](https://learn.microsoft.com/en-us/azure/cosmos-db/emulator-linux) version. In general, it:

- Provides better compatibility on a variety of systems
- Consumes significantly less resources
- Comes with much faster startup times

However, not all features of a full CosmosDB are implemented yet - please refer to [this overview](https://learn.microsoft.com/en-us/azure/cosmos-db/emulator-linux#feature-support) for a detailed list.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ nav:
- Azurite: modules/azurite.md
- Cassandra: modules/cassandra.md
- ChromaDB: modules/chromadb.md
- CosmosDB: modules/cosmosdb.md
- Couchbase: modules/couchbase.md
- CockroachDB: modules/cockroachdb.md
- Elasticsearch: modules/elasticsearch.md
Expand Down
Loading