Elasticsearch uses Indexes to store, access, and delete documents.
Use the task Elasticsearch Indexes settings to choose the indexes the task will access.
Define Elasticsearch Index
Add Index (Optional)
- Click to add an Elasticsearch index to the list.
Provide an Elasticsearch Index name, as defined by the transformation script
loadTo<Target>(obj) command (where
Target is the index name
obj is the object to be passed to Elasticsearch).
E.g., a transformation script's
loadToOrders(orderData) command requires you to define an Elasticsearch
- Elasticsearch requires an all lower case index name (e.g.
- The transformation script allows both lower and higher-case characters (e.g. both
loadToorders are permitted).
Document ID Property Name
Provide the name of a property passed by the transformation script to Elasticsearch, as an ID.
Elasticsearch will store your documents by this ID, and you will be able to delete and modify them by it.
E.g., if one of the properties of the object passed by your transformation script to Elasticsearch is "DocID",
you can use DocID as the index's ID Property.
By default, the ETL task appends a new document only after deleting its existing version using
Insert Only prevents the task from sending
_delete_by_query messages, allowing you to append
documents without removing their existing version first.
Enabling Insert Only would accumulate new document versions on Elasticsearch without ever removing them.
Click to add this index to the list.
Click to cancel the operation without adding the index to the list.
- Defined Index
An Elasticsearch index that has been added.
Elasticsearch index name.
- Document ID Property
The RavenDB document property that is used as an Elasticsearch ID.
- Edit Index
Click to edit index properties.
- Remove Index
Click to remove this index from the list.