import type { INodeProperties } from 'n8n-workflow'; import * as placeholders from './placeholders'; export const documentOperations: INodeProperties[] = [ { displayName: 'Operation', name: 'operation', type: 'options', noDataExpression: true, displayOptions: { show: { resource: ['document'], }, }, options: [ { name: 'Create', value: 'create', description: 'Create a document', action: 'Create a document', }, { name: 'Delete', value: 'delete', description: 'Delete a document', action: 'Delete a document', }, { name: 'Get', value: 'get', description: 'Get a document', action: 'Get a document', }, { name: 'Get Many', value: 'getAll', description: 'Get many documents', action: 'Get many documents', }, { name: 'Update', value: 'update', description: 'Update a document', action: 'Update a document', }, ], default: 'get', }, ]; export const documentFields: INodeProperties[] = [ // ---------------------------------------- // document: delete // ---------------------------------------- { displayName: 'Index ID', name: 'indexId', description: 'ID of the index containing the document to delete', type: 'string', required: true, default: '', displayOptions: { show: { resource: ['document'], operation: ['delete'], }, }, }, { displayName: 'Document ID', name: 'documentId', description: 'ID of the document to delete', type: 'string', required: true, default: '', displayOptions: { show: { resource: ['document'], operation: ['delete'], }, }, }, // ---------------------------------------- // document: get // ---------------------------------------- { displayName: 'Index ID', name: 'indexId', description: 'ID of the index containing the document to retrieve', type: 'string', required: true, default: '', displayOptions: { show: { resource: ['document'], operation: ['get'], }, }, }, { displayName: 'Document ID', name: 'documentId', description: 'ID of the document to retrieve', type: 'string', required: true, default: '', displayOptions: { show: { resource: ['document'], operation: ['get'], }, }, }, { displayName: 'Simplify', name: 'simple', 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'], }, }, }, { displayName: 'Options', name: 'options', type: 'collection', placeholder: 'Add option', default: {}, displayOptions: { show: { resource: ['document'], operation: ['get'], }, }, options: [ { displayName: 'Source Excludes', name: '_source_excludes', description: 'Comma-separated list of source fields to exclude from the response', type: 'string', default: '', }, { displayName: 'Source Includes', name: '_source_includes', description: 'Comma-separated list of source fields to include in the response', type: 'string', default: '', }, { displayName: 'Stored Fields', name: 'stored_fields', description: 'Whether to retrieve the document fields stored in the index rather than the document _source. Defaults to false.', type: 'boolean', default: false, }, ], }, // ---------------------------------------- // document: getAll // ---------------------------------------- { displayName: 'Index ID', name: 'indexId', description: 'ID of the index containing the documents to retrieve', type: 'string', required: true, default: '', displayOptions: { show: { resource: ['document'], operation: ['getAll'], }, }, }, { displayName: 'Return All', name: 'returnAll', type: 'boolean', default: false, description: 'Whether to return all results or only up to a given limit', displayOptions: { show: { resource: ['document'], operation: ['getAll'], }, }, }, { displayName: 'By default, you cannot page through more than 10,000 hits. To page through more hits, add "Sort" from options.', name: 'paginateNotice', type: 'notice', default: '', displayOptions: { show: { resource: ['document'], operation: ['getAll'], returnAll: [true], }, }, }, { displayName: 'Limit', name: 'limit', type: 'number', default: 50, description: 'Max number of results to return', typeOptions: { minValue: 1, }, displayOptions: { show: { resource: ['document'], operation: ['getAll'], returnAll: [false], }, }, }, { displayName: 'Simplify', name: 'simple', type: 'boolean', default: true, description: 'Whether to return a simplified version of the response instead of the raw data', displayOptions: { show: { resource: ['document'], operation: ['getAll'], }, }, }, { displayName: 'Options', name: 'options', type: 'collection', placeholder: 'Add option', default: {}, displayOptions: { show: { resource: ['document'], operation: ['getAll'], }, }, options: [ { displayName: 'Allow No Indices', name: 'allow_no_indices', // eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether description: 'If false, return an error if any of the following targets only missing/closed indices: wildcard expression, index alias, or _all value. Defaults to true.', type: 'boolean', default: true, }, { displayName: 'Allow Partial Search Results', name: 'allow_partial_search_results', // eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether description: '

If true, return partial results if there are shard request timeouts or shard failures.

If false, returns an error with no partial results. Defaults to true.

.', type: 'boolean', default: true, }, { displayName: 'Batched Reduce Size', name: 'batched_reduce_size', description: 'Number of shard results that should be reduced at once on the coordinating node. Defaults to 512.', type: 'number', typeOptions: { minValue: 2, }, default: 512, }, { displayName: 'CCS Minimize Roundtrips', name: 'ccs_minimize_roundtrips', description: 'Whether network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. Defaults to true.', type: 'boolean', default: true, }, { displayName: 'Doc Value Fields', name: 'docvalue_fields', description: 'Comma-separated list of fields to return as the docvalue representation of a field for each hit', type: 'string', default: '', }, { displayName: 'Expand Wildcards', name: 'expand_wildcards', description: 'Type of index that wildcard expressions can match. Defaults to open', type: 'options', options: [ { name: 'All', value: 'all', }, { name: 'Closed', value: 'closed', }, { name: 'Hidden', value: 'hidden', }, { name: 'None', value: 'none', }, { name: 'Open', value: 'open', }, ], default: 'open', }, { displayName: 'Explain', name: 'explain', description: 'Whether to return detailed information about score computation as part of a hit. Defaults to false.', type: 'boolean', default: false, }, { displayName: 'Ignore Throttled', name: 'ignore_throttled', description: 'Whether concrete, expanded or aliased indices are ignored when frozen. Defaults to true.', type: 'boolean', default: true, }, { displayName: 'Ignore Unavailable', name: 'ignore_unavailable', description: 'Whether missing or closed indices are not included in the response. Defaults to false.', type: 'boolean', default: false, }, { displayName: 'Max Concurrent Shard Requests', name: 'max_concurrent_shard_requests', description: 'Define the number of shard requests per node this search executes concurrently. Defaults to 5.', type: 'number', default: 5, }, { displayName: 'Pre-Filter Shard Size', name: 'pre_filter_shard_size', description: 'Define a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting. Only used if the number of shards the search request expands to exceeds the threshold.', type: 'number', typeOptions: { minValue: 1, }, default: 1, }, { displayName: 'Query', name: 'query', description: 'Query in the Elasticsearch Query DSL', type: 'json', typeOptions: { alwaysOpenEditWindow: true, }, default: '', placeholder: placeholders.query, }, { displayName: 'Request Cache', name: 'request_cache', description: 'Whether the caching of search results is enabled for requests where size is 0. See Elasticsearch shard request cache settings.', type: 'boolean', default: false, }, { displayName: 'Routing', name: 'routing', description: 'Target this primary shard', type: 'string', default: '', }, { displayName: 'Search Type', name: 'search_type', description: 'How distributed term frequencies are calculated for relevance scoring. Defaults to Query then Fetch.', type: 'options', options: [ { name: 'DFS Query Then Fetch', value: 'dfs_query_then_fetch', }, { name: 'Query Then Fetch', value: 'query_then_fetch', }, ], default: 'query_then_fetch', }, { displayName: 'Sequence Number and Primary Term', name: 'seq_no_primary_term', description: 'Whether to return the sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.', type: 'boolean', default: false, }, { displayName: 'Sort', name: 'sort', description: 'Comma-separated list of field:direction pairs', type: 'string', default: '', }, { displayName: 'Source Excludes', name: '_source_excludes', description: 'Comma-separated list of source fields to exclude from the response', type: 'string', default: '', }, { displayName: 'Source Includes', name: '_source_includes', description: 'Comma-separated list of source fields to include in the response', type: 'string', default: '', }, { displayName: 'Stats', name: 'stats', description: 'Tag of the request for logging and statistical purposes', type: 'string', default: '', }, { displayName: 'Stored Fields', name: 'stored_fields', description: 'Whether to retrieve the document fields stored in the index rather than the document _source. Defaults to false.', type: 'boolean', default: false, }, { displayName: 'Terminate After', name: 'terminate_after', description: 'Max number of documents to collect for each shard', type: 'number', default: 0, }, { displayName: 'Timeout', name: 'timeout', description: 'Period to wait for active shards. Defaults to 1m (one minute). See the Elasticsearch time units reference', type: 'string', default: '1m', }, { displayName: 'Track Scores', name: 'track_scores', description: 'Whether to calculate and return document scores, even if the scores are not used for sorting. Defaults to false.', type: 'boolean', default: false, }, { displayName: 'Track Total Hits', name: 'track_total_hits', description: 'Number of hits matching the query to count accurately. Defaults to 10000.', type: 'number', default: 10000, }, { displayName: 'Version', name: 'version', description: 'Whether to return document version as part of a hit. Defaults to false.', type: 'boolean', default: false, }, ], }, // ---------------------------------------- // document: create // ---------------------------------------- { displayName: 'Index ID', name: 'indexId', description: 'ID of the index to add the document to', type: 'string', required: true, default: '', displayOptions: { show: { resource: ['document'], operation: ['create'], }, }, }, { displayName: 'Data to Send', name: 'dataToSend', type: 'options', 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'], }, }, default: 'defineBelow', description: 'Whether to insert the input data this node receives in the new row', }, { displayName: 'Inputs to Ignore', name: 'inputsToIgnore', type: 'string', displayOptions: { show: { resource: ['document'], operation: ['create'], dataToSend: ['autoMapInputData'], }, }, default: '', description: 'List of input properties to avoid sending, separated by commas. Leave empty to send all properties.', placeholder: 'Enter properties...', }, { displayName: 'Fields to Send', name: 'fieldsUi', placeholder: 'Add Field', type: 'fixedCollection', typeOptions: { multipleValueButtonText: 'Add Field to Send', multipleValues: true, }, displayOptions: { show: { resource: ['document'], operation: ['create'], dataToSend: ['defineBelow'], }, }, default: {}, options: [ { displayName: 'Field', name: 'fieldValues', values: [ { displayName: 'Field Name', name: 'fieldId', type: 'string', default: '', }, { displayName: 'Field Value', name: 'fieldValue', type: 'string', default: '', }, ], }, ], }, { displayName: 'Additional Fields', name: 'additionalFields', type: 'collection', placeholder: 'Add Field', default: {}, displayOptions: { show: { resource: ['document'], operation: ['create'], }, }, options: [ { displayName: 'Document ID', name: 'documentId', description: 'ID of the document to create and add to the index', type: 'string', default: '', }, { displayName: 'Routing', name: 'routing', description: 'Target this primary shard', type: 'string', default: '', }, { displayName: 'Timeout', name: 'timeout', description: 'Period to wait for active shards. Defaults to 1m (one minute). See the Elasticsearch time units reference', type: 'string', default: '1m', }, ], }, { displayName: 'Options', name: 'options', type: 'collection', placeholder: 'Add Field', default: {}, displayOptions: { show: { resource: ['document'], operation: ['create'], }, }, options: [ { displayName: 'Pipeline ID', name: 'pipeline', description: 'ID of the pipeline to use to preprocess incoming documents', type: 'string', default: '', }, { displayName: 'Refresh', name: 'refresh', description: 'If true, Elasticsearch refreshes the affected shards to make this operation visible to search,if wait_for then wait for a refresh to make this operation visible to search,if false do nothing with refreshes', type: 'options', default: 'false', options: [ { name: 'True', value: 'true', description: 'Refreshes the affected shards to make this operation visible to search', }, { name: 'Wait For', value: 'wait_for', description: 'Wait for a refresh to make this operation visible', }, { name: 'False', value: 'false', description: 'Do nothing with refreshes', }, ], }, ], }, // ---------------------------------------- // document: update // ---------------------------------------- { displayName: 'Index ID', name: 'indexId', description: 'ID of the document to update', type: 'string', required: true, default: '', displayOptions: { show: { resource: ['document'], operation: ['update'], }, }, }, { displayName: 'Document ID', name: 'documentId', description: 'ID of the document to update', type: 'string', required: true, default: '', displayOptions: { show: { resource: ['document'], operation: ['update'], }, }, }, { displayName: 'Data to Send', name: 'dataToSend', type: 'options', 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: ['update'], }, }, default: 'defineBelow', description: 'Whether to insert the input data this node receives in the new row', }, { displayName: 'Inputs to Ignore', name: 'inputsToIgnore', type: 'string', displayOptions: { show: { resource: ['document'], operation: ['update'], dataToSend: ['autoMapInputData'], }, }, default: '', description: 'List of input properties to avoid sending, separated by commas. Leave empty to send all properties.', placeholder: 'Enter properties...', }, { displayName: 'Fields to Send', name: 'fieldsUi', placeholder: 'Add Field', type: 'fixedCollection', typeOptions: { multipleValueButtonText: 'Add Field to Send', multipleValues: true, }, displayOptions: { show: { resource: ['document'], operation: ['update'], dataToSend: ['defineBelow'], }, }, default: {}, options: [ { displayName: 'Field', name: 'fieldValues', values: [ { displayName: 'Field Name', name: 'fieldId', type: 'string', default: '', }, { displayName: 'Field Value', name: 'fieldValue', type: 'string', default: '', }, ], }, ], }, { displayName: 'Options', name: 'options', type: 'collection', placeholder: 'Add Field', default: {}, displayOptions: { show: { resource: ['document'], operation: ['update'], }, }, options: [ { displayName: 'Refresh', name: 'refresh', description: 'If true, Elasticsearch refreshes the affected shards to make this operation visible to search,if wait_for then wait for a refresh to make this operation visible to search,if false do nothing with refreshes', type: 'options', default: 'false', options: [ { name: 'True', value: 'true', description: 'Refreshes the affected shards to make this operation visible to search', }, { name: 'Wait For', value: 'wait_for', description: 'Wait for a refresh to make this operation visible', }, { name: 'False', value: 'false', description: 'Do nothing with refreshes', }, ], }, ], }, ];