Bots From Extension: opensearch
Opensearch - Read, Write and Append data to Opensearch Indices
This extension provides 11 bots.
Bot @os:append-index
Bot Position In Pipeline: Sink
Appends the record(s) to an existing or a new index on Opensearch
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| index* | Text | Index to update | |
| continue_on_failure | Text | no | Continue on Failure. Provide yes/no |
| skip_empty_fields | Text | no | Skip empty fields in the row before sending. Provide yes/no |
Bot *os:cluster-health
Bot Position In Pipeline: Source
Lists health stats for cluster in Opensearch
This bot expects a Full CFXQL.
Bot applies the Query on the data that is already loaded from previous bot or from a source.
Bot *os:cluster-node-stats
Bot Position In Pipeline: Source
Lists all cluster nodes stats in Opensearch
This bot expects a Full CFXQL.
Bot applies the Query on the data that is already loaded from previous bot or from a source.
Bot @os:delete-from-index-by-id
Bot Position In Pipeline: Sink
Delete one or more records from Opensearch index
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| index* | Text | Specify Opensearch index name | |
| id_col* | Text | Specify the input column that has one or more ids of Opensearch index records. | |
| concurrent_delete | Text | 50 | Specify number of records to be deleted concurrently |
Bot #os:delete-from-index-by-query
Bot Position In Pipeline: Sink
Delete one or more records from Opensearch index.
This bot expects Full CFXQL.
Bot translates the Query to native query of the Data source supported by this extension.
Bot @os:index-meta
Bot Position In Pipeline: Source
Reads the metadata from Opensearch index
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| index* | Text | Index to get metadata for |
Bot *os:list-indices
Bot Position In Pipeline: Source
Lists all available indices on Opensearch
This bot expects a Full CFXQL.
Bot applies the Query on the data that is already loaded from previous bot or from a source.
Bot *os:list-shards
Bot Position In Pipeline: Source
Lists all shards for indices in Opensearch
This bot expects a Full CFXQL.
Bot applies the Query on the data that is already loaded from previous bot or from a source.
Bot #os:read-index
Bot Position In Pipeline: Sink
Reads the data from Opensearch indice(s). Add suffix .keyword for exact matches on keyword columns.
This bot expects Full CFXQL.
Bot translates the Query to native query of the Data source supported by this extension.
Bot @os:read-index-histogram
Bot Position In Pipeline: Source Sink
Reads the Histogram data from Opensearch indice(s)
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
Bot @os:update-index
Bot Position In Pipeline: Sink
Updates the record(s) to an existing or a new index on Opensearch
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| index* | Text | Index to update | |
| ids* | Text | comma separated columns to match against. | |
| skip_empty_fields | Text | no | Skip empty fields in the row before sending. Provide yes/no |