mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 22:17:55 +00:00
118 lines
No EOL
3.4 KiB
Markdown
118 lines
No EOL
3.4 KiB
Markdown
---
|
|
id: cosmosdb
|
|
title: CosmosDB
|
|
---
|
|
|
|
ToolJet can connect to CosmosDB databases to read and write data.
|
|
|
|
## Connection
|
|
|
|
To establish a connection with the CosmosDB data source, you can either click on the **+ Add new data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview)** page through the ToolJet dashboard.
|
|
|
|
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](https://portal.azure.com/)**.
|
|
:::
|
|
|
|
<img className="screenshot-full img-full" src="/img/datasource-reference/cosmosdb/connection-v3.png" alt="Connection - CosmosDB"/>
|
|
|
|
## Querying CosmoDB
|
|
|
|
1. Click on **+ Add** button of the query manager at the bottom panel of the editor.
|
|
2. Select the **CosmoDB** datasource added in previous step.
|
|
3. Select the operation you want to perform and enter the query.
|
|
4. Click on the **Preview** button to preview the output or Click on the **Run** button to create and trigger the query.
|
|
|
|
<img className="screenshot-full img-full" src="/img/datasource-reference/cosmosdb/listops-v3.png" alt="Supported operations - CosmosDB"/>
|
|
|
|
## Supported Queries
|
|
|
|
- **[List databases](#list-databases)**
|
|
- **[List containers](#list-containers)**
|
|
- **[Read item](#read-item)**
|
|
- **[Insert items](#insert-items)**
|
|
- **[Delete item](#delete-item)**
|
|
- **[Query database](#query-database)**
|
|
|
|
### List Databases
|
|
|
|
This query lists all the databases in a Cosmos DB.
|
|
|
|
<img className="screenshot-full img-full" src="/img/datasource-reference/cosmosdb/list-db-op.png" alt="list db query"/>
|
|
|
|
### List Containers
|
|
|
|
This query lists all the containers of a database in a Cosmos DB.
|
|
|
|
#### Required Parameter
|
|
- **Database**
|
|
|
|
<img className="screenshot-full img-full" src="/img/datasource-reference/cosmosdb/list-container-op.png" alt="list container query "/>
|
|
|
|
|
|
### Read Item
|
|
|
|
To read a single item from a container of a database in a Cosmos DB, use the following query.
|
|
|
|
#### Required Parameter
|
|
- **Database**
|
|
- **Container**
|
|
- **Item ID**
|
|
|
|
<img className="screenshot-full img-full" src="/img/datasource-reference/cosmosdb/read-item-op.png" alt="read item query"/>
|
|
|
|
### Insert Items
|
|
|
|
This query inserts one or more items in a container of a database in a Cosmos DB.
|
|
|
|
#### Required Parameter
|
|
- **Database**
|
|
- **Container**
|
|
- **Items**
|
|
|
|
<img className="screenshot-full img-full" src="/img/datasource-reference/cosmosdb/insert-op.png" alt="insert item query"/>
|
|
|
|
#### Example
|
|
|
|
```yaml
|
|
{
|
|
"id": "123",
|
|
"product": "Laptop",
|
|
"price": 1200,
|
|
"customer_id": "C001"
|
|
}
|
|
```
|
|
|
|
### Delete Item
|
|
|
|
To delete an item from a container of a database in a Cosmos DB, use the following query.
|
|
|
|
#### Required Parameter
|
|
- **Database**
|
|
- **Container**
|
|
- **Item ID**
|
|
- **Partition Key**
|
|
|
|
<img className="screenshot-full img-full" src="/img/datasource-reference/cosmosdb/delete-op.png" alt="delete item query"/>
|
|
|
|
### Query Database
|
|
|
|
To query documents from a container of a database in a Cosmos DB using SQL-like syntax, use the following query.
|
|
|
|
#### Required Parameter
|
|
- **Database**
|
|
- **Container**
|
|
- **Query**
|
|
|
|
<img className="screenshot-full img-full" src="/img/datasource-reference/cosmosdb/query-db-op.png" alt="query database querying"/>
|
|
|
|
#### Example
|
|
```yaml
|
|
SELECT * FROM c WHERE c.age > 20 AND c.age <= 30
|
|
``` |