mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 22:17:55 +00:00
f6bef78dec
* [docs]: Update data-sources guides - Clickhouse, CosmosDB, CouchDB * Added padding before h2 * Updated 2.50-LTS/data-source/databricks.md * Updated Databrick * Updated DynamoDB * Updated elasticsearch * Updated GCS * Updated Google Sheets * Updated GraphQL * Updated graphql v2 * Updated graphql v3 * Updated sheets v2 * updated sheets v3 * Updated gcs v2 * updated elasticsearch v2 * updated dynamodb v2 * Updated databrick v2 * Added missing images * Updated docs in 2.68.0
482 lines
No EOL
14 KiB
Markdown
482 lines
No EOL
14 KiB
Markdown
---
|
||
id: elasticsearch
|
||
title: Elasticsearch
|
||
---
|
||
|
||
ToolJet allows you to connect to your Elasticsearch cluster to perform data read/write operations and execute various queries.
|
||
|
||
## Connection
|
||
|
||
To connect to an Elasticsearch data source in ToolJet, you can either click the **+ Add new data source** button on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview)** page in the ToolJet dashboard.
|
||
|
||
:::info
|
||
Please make sure the **Host/IP** of the database is accessible from your VPC if you have self-hosted ToolJet. If you are using ToolJet cloud, please **whitelist** our IP.
|
||
:::
|
||
|
||
To connect to your Elasticsearch cluster, the following details are required:
|
||
- **Host**
|
||
- **Port**
|
||
- **Username**
|
||
- **Password**
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/connect-v2.png" alt="Elastic Connect" />
|
||
</div>
|
||
|
||
ToolJet also supports SSL certificate-based connections:
|
||
- You can use either CA or Client certificates.
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/ssl-v2.png" alt="Elastic SSL Connect" />
|
||
</div>
|
||
|
||
<div style={{paddingTop:'24px'}}>
|
||
|
||
## Querying Elasticsearch
|
||
|
||
1. Click the **+ Add** button in the query manager at the bottom of the editor and select the Elasticsearch data source added earlier.
|
||
2. Choose the operation you want to perform on your Elasticsearch cluster.
|
||
|
||
:::tip
|
||
Query results can be transformed using transformations. Refer to our transformations documentation for more details: **[link](/docs/tutorial/transformations)**
|
||
:::
|
||
|
||
</div>
|
||
|
||
<div style={{paddingTop:'24px'}}>
|
||
|
||
## Supported Operations
|
||
|
||
ToolJet supports the following Elasticsearch operations:
|
||
|
||
- **[Search](#search)**
|
||
- **[Index a Document](#index-a-document)**
|
||
- **[Get a Document](#get-a-document)**
|
||
- **[Update a Document](#update-a-document)**
|
||
- **[Delete a Document](#delete-a-document)**
|
||
- **[Bulk Operation](#bulk-operation)**
|
||
- **[Count Documents](#count-documents)**
|
||
- **[Check Document Existence](#check-document-existence)**
|
||
- **[Multi Get](#multi-get)**
|
||
- **[Scroll Search](#scroll-search)**
|
||
- **[Clear Scroll](#clear-scroll)**
|
||
- **[Get Cat Indices](#get-cat-indices)**
|
||
- **[Get Cluster Health](#get-cluster-health)**
|
||
|
||
### Search
|
||
|
||
This operation executes a search query and returns matching search hits. For more details, see the Elasticsearch search guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Index**: The name of the index to search in.
|
||
- **Query**: The search query in JSON format.
|
||
|
||
#### Optional Parameter
|
||
- **Scroll**: Scroll time.
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/elastic-search-v2.png" alt="Elastic search" style={{marginBottom:'15px'}} />
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
Index: books
|
||
Query:
|
||
{
|
||
"query": {
|
||
"match": {
|
||
"title": "The Great Gatsby"
|
||
}
|
||
},
|
||
"size": 20
|
||
}
|
||
Scroll: 1m # Can be in the format of 1m, 1h, 1d.
|
||
```
|
||
|
||
### Index a Document
|
||
|
||
This operation adds a JSON document to the specified index or data stream. For more details, see the Elasticsearch index guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Index**: The name of the index to add the document to
|
||
- **Body**: The document body in JSON format
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/index-v2.png" alt="Elastic index" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
Index: books
|
||
Body:
|
||
{
|
||
"title": "1984",
|
||
"author": "George Orwell",
|
||
"year": 1949,
|
||
"genre": "Dystopian Fiction"
|
||
}
|
||
```
|
||
|
||
### Get a Document
|
||
|
||
This operation retrieves the specified JSON document from the index. For more details, see the Elasticsearch get guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Index**: The name of the index to get the document from
|
||
- **Id**: The ID of the document to retrieve
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/get-v2.png" alt="Elastic get" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
Index: books
|
||
Id: FJXTSZEBsuzUn2y4wZ-W
|
||
```
|
||
|
||
### Update a Document
|
||
|
||
This operation updates a document using the specified script. For more details, see the Elasticsearch update guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Index**: The name of the index containing the document
|
||
- **Id**: The ID of the document to update
|
||
- **Body**: The update script or partial document in JSON format
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/update-v2.png" alt="Elastic update" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
Index: books
|
||
Id: FJXTSZEBsuzUn2y4wZ-W
|
||
Body:
|
||
{
|
||
"doc": {
|
||
"title": "1984",
|
||
"author": "George Orwell",
|
||
"year": 1949,
|
||
"genre": "Fiction"
|
||
}
|
||
}
|
||
```
|
||
|
||
### Delete a Document
|
||
|
||
This operation removes a JSON document from the specified index. For more details, see the Elasticsearch delete guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Index**: The name of the index containing the document
|
||
- **Id**: The ID of the document to delete
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/delete.png" alt="Elastic delete" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
Index: books
|
||
Id: FJXTSZEBsuzUn2y4wZ-W
|
||
```
|
||
|
||
### Bulk Operation
|
||
|
||
This operation performs multiple index/update/delete operations in a single API call. For more details, see the Elasticsearch bulk guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Operations**: The bulk operations to perform in JSON format
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/bulk.png" alt="Elastic bulk" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
[
|
||
{ "index": { "_index": "books", "_id": "book1" } },
|
||
{
|
||
"title": "The Great Gatsby",
|
||
"author": "F. Scott Fitzgerald",
|
||
"year": 1925
|
||
},
|
||
{ "delete": { "_index": "books", "_id": "book2" } },
|
||
{ "index": { "_index": "books", "_id": "book3" } },
|
||
{
|
||
"title": "Moby-Dick",
|
||
"author": "Herman Melville",
|
||
"year": 1851
|
||
},
|
||
{ "delete": { "_index": "books", "_id": "book4" } }
|
||
]
|
||
```
|
||
|
||
### Count Documents
|
||
|
||
This operation returns the number of matches for a search query. For more details, see the Elasticsearch count guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Index**: The name of the index to count documents in.
|
||
|
||
#### Optional Parameter
|
||
- **Query**: The query to filter documents in JSON format
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/count.png" alt="Elastic count" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
{
|
||
"query": {
|
||
"range": {
|
||
"timestamp": {
|
||
"gte": 1901
|
||
}
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### Check Document Existence
|
||
|
||
This operation checks if a document exists in an index. For more details, see the Elasticsearch exists guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#docs-get-api-response-codes)**.
|
||
|
||
#### Required Parameter:
|
||
- **Index**: The name of the index to check for document existence
|
||
- **Id**: The ID of the document to check
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/exists.png" alt="Elastic exists" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
Index: books
|
||
Id: FJXTSZEBsuzUn2y4wZ-W
|
||
```
|
||
|
||
### Multi Get
|
||
|
||
This operation retrieves multiple documents in a single request. For more details, see the Elasticsearch multi-get guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Operations**: The multi-get operations to perform in JSON format
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/mget.png" alt="Elastic multi get" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
{
|
||
"docs": [
|
||
{ "_index": "books", "_id": "book124" },
|
||
{ "_index": "books", "_id": "book125" }
|
||
]
|
||
}
|
||
```
|
||
|
||
### Scroll Search
|
||
|
||
This operation retrieves large numbers of results from a single search request. For more details, see the Elasticsearch scroll guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results)**.
|
||
|
||
#### Required Parameter
|
||
- **Scroll ID**: The scroll ID for the search
|
||
- **Scroll**: The scroll time
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/scroll-search.png" alt="Elastic scroll" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
Scroll ID: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAOWQWYm9vbDItY1NCOUExal9TcTBjeUEyZw
|
||
Scroll: 60m
|
||
```
|
||
|
||
### Clear Scroll
|
||
|
||
This operation clears the search context for a scroll. For more details, see the Elasticsearch clear scroll guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html)**.
|
||
|
||
#### Required Parameter
|
||
- **Scroll ID**: The scroll ID to clear
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/clear-scroll.png" alt="Elastic clear scroll" style={{marginBottom:'15px'}}/>
|
||
</div>
|
||
|
||
#### Example:
|
||
```yaml
|
||
Scroll ID: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAOWQWYm9vbDItY1NCOUExal9TcTBjeUEyZw
|
||
```
|
||
|
||
### Get Cat Indices
|
||
|
||
This operation provides a compact, column-aligned view of indices in a cluster. For more details, see the Elasticsearch cat indices guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html)**.
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/cat-indices.png" alt="Elastic cat indices" />
|
||
</div>
|
||
|
||
<details>
|
||
<summary>**Response Example**</summary>
|
||
```json
|
||
{
|
||
"body": [
|
||
{
|
||
"health": "yellow",
|
||
"status": "open",
|
||
"index": "1",
|
||
"uuid": "JQOzqxK7Rdar7ROOlqXwkA",
|
||
"pri": "1",
|
||
"rep": "1",
|
||
"docs.count": "2",
|
||
"docs.deleted": "0",
|
||
"store.size": "9.2kb",
|
||
"pri.store.size": "9.2kb"
|
||
},
|
||
{
|
||
"health": "yellow",
|
||
"status": "open",
|
||
"index": "recipes",
|
||
"uuid": "eNGdAsG4TMWvs9f0eLERlQ",
|
||
"pri": "1",
|
||
"rep": "1",
|
||
"docs.count": "20",
|
||
"docs.deleted": "0",
|
||
"store.size": "30kb",
|
||
"pri.store.size": "30kb"
|
||
},
|
||
{
|
||
"health": "yellow",
|
||
"status": "open",
|
||
"index": "read_me",
|
||
"uuid": "EbE4V-5RRE2y-_P4z_auVQ",
|
||
"pri": "1",
|
||
"rep": "1",
|
||
"docs.count": "1",
|
||
"docs.deleted": "0",
|
||
"store.size": "5.1kb",
|
||
"pri.store.size": "5.1kb"
|
||
}
|
||
],
|
||
"statusCode": 200,
|
||
"headers": {
|
||
"x-elastic-product": "Elasticsearch",
|
||
"content-type": "application/json",
|
||
"content-length": "558"
|
||
},
|
||
"meta": {
|
||
"context": null,
|
||
"request": {
|
||
"params": {
|
||
"method": "GET",
|
||
"path": "/_cat/indices",
|
||
"body": null,
|
||
"querystring": "format=json",
|
||
"headers": {
|
||
"user-agent": "opensearch-js/1.2.0 (linux 6.5.0-1021-aws-x64; Node.js v18.18.2)"
|
||
},
|
||
"timeout": 30000
|
||
},
|
||
"options": {},
|
||
"id": 1
|
||
},
|
||
"name": "opensearch-js",
|
||
"connection": {
|
||
"url": "http://xx.2xx.183.199:9200/",
|
||
"id": "http://xx.2xx.183.199:9200/",
|
||
"headers": {},
|
||
"deadCount": 0,
|
||
"resurrectTimeout": 0,
|
||
"_openRequests": 0,
|
||
"status": "alive",
|
||
"roles": {
|
||
"master": true,
|
||
"data": true,
|
||
"ingest": true
|
||
}
|
||
},
|
||
"attempts": 0,
|
||
"aborted": false
|
||
}
|
||
}
|
||
```
|
||
</details>
|
||
|
||
### Get Cluster Health
|
||
|
||
This operation retrieves the status of the cluster’s health. For more details, see the Elasticsearch cluster health guide **[here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html)**.
|
||
|
||
<div style={{textAlign: 'center'}}>
|
||
<img className="screenshot-full" src="/img/datasource-reference/elasticsearch/cluster-health.png" alt="Elastic cluster health" />
|
||
</div>
|
||
|
||
<details>
|
||
<summary>**Response Example**</summary>
|
||
```json
|
||
{
|
||
"body": {
|
||
"cluster_name": "docker-cluster",
|
||
"status": "yellow",
|
||
"timed_out": false,
|
||
"number_of_nodes": 1,
|
||
"number_of_data_nodes": 1,
|
||
"active_primary_shards": 10,
|
||
"active_shards": 10,
|
||
"relocating_shards": 0,
|
||
"initializing_shards": 0,
|
||
"unassigned_shards": 3,
|
||
"delayed_unassigned_shards": 0,
|
||
"number_of_pending_tasks": 0,
|
||
"number_of_in_flight_fetch": 0,
|
||
"task_max_waiting_in_queue_millis": 0,
|
||
"active_shards_percent_as_number": 76.92307692307693
|
||
},
|
||
"statusCode": 200,
|
||
"headers": {
|
||
"x-elastic-product": "Elasticsearch",
|
||
"content-type": "application/json",
|
||
"content-length": "405"
|
||
},
|
||
"meta": {
|
||
"context": null,
|
||
"request": {
|
||
"params": {
|
||
"method": "GET",
|
||
"path": "/_cluster/health",
|
||
"body": null,
|
||
"querystring": "",
|
||
"headers": {
|
||
"user-agent": "opensearch-js/1.2.0 (linux 6.5.0-1021-aws-x64; Node.js v18.18.2)"
|
||
},
|
||
"timeout": 30000
|
||
},
|
||
"options": {},
|
||
"id": 1
|
||
},
|
||
"name": "opensearch-js",
|
||
"connection": {
|
||
"url": "http://xx.2xx.183.199:9200/",
|
||
"id": "http://xx.2xx.183.199:9200/",
|
||
"headers": {},
|
||
"deadCount": 0,
|
||
"resurrectTimeout": 0,
|
||
"_openRequests": 0,
|
||
"status": "alive",
|
||
"roles": {
|
||
"master": true,
|
||
"data": true,
|
||
"ingest": true
|
||
}
|
||
},
|
||
"attempts": 0,
|
||
"aborted": false
|
||
}
|
||
}
|
||
```
|
||
</details>
|
||
|
||
</div> |