ToolJet/docs/versioned_docs/version-2.18.0/data-sources/cosmosdb.md
Shubhendra Singh Chauhan 9f2ff94a12
[docs] platform 5.x (#7427)
* whtie label revamp

* minor changes

* updated beta info in copilot docs

* renamed gds to ds in overview doc of v2.15 onwards

* updated multienv: renamed gds to ds, updated screenshot

* updated multienv: app state description

* updated superadmin wrt new licensing updates

* licensing update: free trial

* updates in licensing

* changes after review

* [docs]updated restapi with bearer auth

* Update kubernetes-aks.md

* Update openshift.md

* Update ecs.md

* Update ecs.md

* Update kubernetes-gke.md

* Update kubernetes.md

* Update docker.md

* Update docker.md

* Update ecs.md

* Update google-cloud-run.md

* Update kubernetes-aks.md

* Update kubernetes-gke.md

* Update kubernetes.md

* Update openshift.md

* Update kubernetes-gke.md

* Update kubernetes-aks.md

* fixed ecs, removed heroku from 2.15 onwards

* updated digitalocean doc

* licensing doc changes and location

* Update digitalocean.md

* Update digitalocean.md

* added v2.18.0

---------

Co-authored-by: Adish M <44204658+adishM98@users.noreply.github.com>
2023-09-27 12:24:39 +05:30

2.7 KiB

id title
cosmosdb CosmosDB

Cosmosdb

ToolJet can connect to CosmosDB databases to read and write data.

Connection

To add a new Azure Cosmos DB, click on the + button on data sources panel at the left-bottom corner of the app editor. Select CosmosDB from the modal that pops up.

ToolJet requires the following to connect to your Cosmos DB.

  • Cosmos DB Account End point
  • Cosmos DB Account Key

:::info Azure Cosmos DB End point is the URL of the Cosmos DB service. Azure Cosmos DB Key is the key that is used to access the Cosmos DB service. You can find the endpoint and key in the Azure Portal. :::

ToolJet - Data source - CosmosDB

Supported queries:

Listing databases

This query lists all the databases in a Cosmos DB.

Listing containers

This query lists all the containers of a database in a Cosmos DB.

Fields description
database id of the database

Inserting item(s)

This query inserts one or more items in a container of a database in a Cosmos DB.

Fields description
database id of the database
container id of the container
items items to be inserted. Example: {{[{name: "one", val: 1}, {name:"two", val: 2}]}}

Retrieving an item

To read a single item from a container of a database in a Cosmos DB, use the following query.

Fields description
database id of the database
container id of the container
item id of the item

Deleting an item

To delete an item from a container of a database in a Cosmos DB, use the following query.

Fields description
database id of the database
container id of the container
item id of the item

Querying documents

To query documents from a container of a database in a Cosmos DB using SQL-like syntax, use the following query.

Fields description
database id of the database
container id of the container
query query to be executed. Example: SELECT * FROM c WHERE c.age > 20 AND c.age <= 30