elasticsearch.json•8.1 kB
{
"nodeType": "n8n-nodes-base.elasticsearch",
"displayName": "Elasticsearch",
"description": "Consume the Elasticsearch API",
"version": 1,
"properties": [
{
"name": "indexId",
"displayName": "Index ID",
"type": "string",
"default": "",
"description": "ID of the index containing the document to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"delete"
]
}
}
},
{
"name": "documentId",
"displayName": "Document ID",
"type": "string",
"default": "",
"description": "ID of the document to delete",
"required": true,
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"delete"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "Whether to use the bulk operation to delete the document/s",
"placeholder": "Add Option",
"options": [
{
"name": "bulkOperation",
"displayName": "Bulk Delete",
"type": "boolean",
"default": false,
"description": "Whether to use the bulk operation to delete the document/s"
}
],
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"delete"
]
}
}
},
{
"name": "simple",
"displayName": "Simplify",
"type": "boolean",
"default": true,
"description": "Whether to return a simplified version of the response instead of the raw data",
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"get"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "paginateNotice",
"displayName": "By default, you cannot page through more than 10,000 hits. To page through more hits, add \"Sort\" from options.",
"type": "notice",
"default": "",
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"getAll"
],
"returnAll": [
true
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 50,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1
},
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "dataToSend",
"displayName": "Data to Send",
"type": "options",
"default": "defineBelow",
"description": "Set the value for each destination column",
"options": [
{
"name": "Define Below for Each Column",
"value": "defineBelow",
"description": "Set the value for each destination column"
},
{
"name": "Auto-Map Input Data to Columns",
"value": "autoMapInputData",
"description": "Use when node input properties match destination column names"
}
],
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"create"
]
}
}
},
{
"name": "inputsToIgnore",
"displayName": "Inputs to Ignore",
"type": "string",
"default": "",
"description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
"placeholder": "Enter properties...",
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"create"
],
"dataToSend": [
"autoMapInputData"
]
}
}
},
{
"name": "fieldsUi",
"displayName": "Fields to Send",
"type": "fixedCollection",
"default": {},
"placeholder": "Add Field",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"create"
],
"dataToSend": [
"defineBelow"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "ID of the document to create and add to the index",
"placeholder": "Add Field",
"options": [
{
"name": "documentId",
"displayName": "Document ID",
"type": "string",
"default": "",
"description": "ID of the document to create and add to the index"
},
{
"name": "routing",
"displayName": "Routing",
"type": "string",
"default": "",
"description": "Target this primary shard"
},
{
"name": "timeout",
"displayName": "Timeout",
"type": "string",
"default": "1m",
"description": "Period to wait for active shards. Defaults to <code>1m</code> (one minute). See the <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units\">Elasticsearch time units reference</a>"
}
],
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"create"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "get",
"description": "Create a document",
"options": [
{
"name": "Create",
"value": "create",
"description": "Create a document"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete a document"
},
{
"name": "Get",
"value": "get",
"description": "Get a document"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Get many documents"
},
{
"name": "Update",
"value": "update",
"description": "Update a document"
}
],
"displayOptions": {
"show": {
"resource": [
"document"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "document",
"options": [
{
"name": "Document",
"value": "document"
},
{
"name": "Index",
"value": "index"
}
]
}
],
"credentialsConfig": [
{
"name": "elasticsearchApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [
"Main"
],
"outputs": [
"Main"
],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [
"Main"
],
"produces": [
"Main"
]
}
}