Skip to content

Commit

Permalink
feat(out_es): update write_operation docs (#690)
Browse files Browse the repository at this point in the history
* feat: write_operation docs

taken from https://github.com/uken/fluent-plugin-elasticsearch/blob/master/README.md#write_operation

Signed-off-by: Zhanibek Adilbekov <[email protected]>

* fix(out_es): update docs according to feature PR comments

Signed-off-by: Zhanibek Adilbekov <[email protected]>
  • Loading branch information
Zhanibek Adilbekov authored Feb 11, 2022
1 parent 9cada94 commit 073e48e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions pipeline/outputs/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The **es** output plugin, allows to ingest your records into an [Elasticsearch](
| Tag\_Key | When Include\_Tag\_Key is enabled, this property defines the key name for the tag. | \_flb-key |
| Generate\_ID | When enabled, generate `_id` for outgoing records. This prevents duplicate records when retrying ES. | Off |
| Id\_Key | If set, `_id` will be the value of the key from incoming record and `Generate_ID` option is ignored. | |
| Write\_Operation | The write\_operation can be any of: index (default), create, update, upsert. | index |
| Write\_Operation | The write\_operation can be any of: create (default), index, update, upsert. | create |
| Replace\_Dots | When enabled, replace field name dots with underscore, required by Elasticsearch 2.0-2.3. | Off |
| Trace\_Output | When enabled print the elasticsearch API calls to stdout \(for diag only\) | Off |
| Trace\_Error | When enabled print the elasticsearch API calls to stdout when elasticsearch returns an error \(for diag only\) | Off |
Expand All @@ -56,12 +56,12 @@ The write\_operation can be any of:

| Operation | Description |
| ------------- | ----------- |
| index (default) | new data is added while existing data (based on its id) is replaced (reindexed).|
| create | adds new data - if the data already exists (based on its id), the op is skipped.|
| update | updates existing data (based on its id). If no data is found, the op is skipped.|
| upsert | known as merge or insert if the data does not exist, updates if the data exists (based on its id).|
| create (default) | adds new data - if the data already exists (based on its id), the op is skipped.|
| index | new data is added while existing data (based on its id) is replaced (reindexed).|
| update | updates existing data (based on its id). If no data is found, the op is skipped.|
| upsert | known as merge or insert if the data does not exist, updates if the data exists (based on its id).|

**Please note, id is required in create, update, and upsert scenario. Without id, the message will be dropped.**
**Please note, `Id_Key` or `Generate_ID` is required in update, and upsert scenario.**

## Getting Started

Expand Down

0 comments on commit 073e48e

Please sign in to comment.