Source: api/api/delete_by_query.js

  1. /*
  2.  * Copyright OpenSearch Contributors
  3.  * SPDX-License-Identifier: Apache-2.0
  4.  *
  5.  * The OpenSearch Contributors require contributions made to
  6.  * this file be licensed under the Apache-2.0 license or a
  7.  * compatible open source license.
  8.  *
  9.  */
  11. /*
  12.  * Licensed to Elasticsearch B.V. under one or more contributor
  13.  * license agreements. See the NOTICE file distributed with
  14.  * this work for additional information regarding copyright
  15.  * ownership. Elasticsearch B.V. licenses this file to you under
  16.  * the Apache License, Version 2.0 (the "License"); you may
  17.  * not use this file except in compliance with the License.
  18.  * You may obtain a copy of the License at
  19.  *
  20.  *    http://www.apache.org/licenses/LICENSE-2.0
  21.  *
  22.  * Unless required by applicable law or agreed to in writing,
  23.  * software distributed under the License is distributed on an
  24.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  25.  * KIND, either express or implied.  See the License for the
  26.  * specific language governing permissions and limitations
  27.  * under the License.
  28.  */
  30. 'use strict';
  32. /* eslint camelcase: 0 */
  33. /* eslint no-unused-vars: 0 */
  35. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  36. const acceptedQuerystring = [
  37.   'analyzer',
  38.   'analyze_wildcard',
  39.   'default_operator',
  40.   'df',
  41.   'from',
  42.   'ignore_unavailable',
  43.   'allow_no_indices',
  44.   'conflicts',
  45.   'expand_wildcards',
  46.   'lenient',
  47.   'preference',
  48.   'q',
  49.   'routing',
  50.   'scroll',
  51.   'search_type',
  52.   'search_timeout',
  53.   'size',
  54.   'max_docs',
  55.   'sort',
  56.   '_source',
  57.   '_source_excludes',
  58.   '_source_exclude',
  59.   '_source_includes',
  60.   '_source_include',
  61.   'terminate_after',
  62.   'stats',
  63.   'version',
  64.   'request_cache',
  65.   'refresh',
  66.   'timeout',
  67.   'wait_for_active_shards',
  68.   'scroll_size',
  69.   'wait_for_completion',
  70.   'requests_per_second',
  71.   'slices',
  72.   'pretty',
  73.   'human',
  74.   'error_trace',
  75.   'source',
  76.   'filter_path',
  77. ];
  78. const snakeCase = {
  79.   analyzeWildcard: 'analyze_wildcard',
  80.   defaultOperator: 'default_operator',
  81.   ignoreUnavailable: 'ignore_unavailable',
  82.   allowNoIndices: 'allow_no_indices',
  83.   expandWildcards: 'expand_wildcards',
  84.   searchType: 'search_type',
  85.   searchTimeout: 'search_timeout',
  86.   maxDocs: 'max_docs',
  87.   _sourceExcludes: '_source_excludes',
  88.   _sourceExclude: '_source_exclude',
  89.   _sourceIncludes: '_source_includes',
  90.   _sourceInclude: '_source_include',
  91.   terminateAfter: 'terminate_after',
  92.   requestCache: 'request_cache',
  93.   waitForActiveShards: 'wait_for_active_shards',
  94.   scrollSize: 'scroll_size',
  95.   waitForCompletion: 'wait_for_completion',
  96.   requestsPerSecond: 'requests_per_second',
  97.   errorTrace: 'error_trace',
  98.   filterPath: 'filter_path',
  99. };
  101. /**
  102.  * Deletes documents matching the provided query.
  103.  * <br/> See Also: {@link https://opensearch.org/docs/2.4/api-reference/document-apis/delete-by-query/ OpenSearch - Delete by query}
  104.  *
  105.  * @memberOf API-Document
  106.  *
  107.  * @param {Object} params
  108.  * @param {string} params.index - A comma-separated list of index names to search; use '_all' or empty string to perform the operation on all indices
  109.  * @param {Object} params.body - The search definition using the Query DSL
  110.  * @param {string} [params.analyzer] - The analyzer to use for the query string
  111.  * @param {boolean} [params.analyze_wildcard=false] - Specify whether wildcard and prefix queries should be analyzed
  112.  * @param {string} [params.default_operator=OR] - The default operator for query string query (options: AND, OR)
  113.  * @param {string} [params.df] - The field to use as default where no field prefix is given in the query string
  114.  * @param {number} [params.from=0] - Starting offset
  115.  * @param {boolean} [params.ignore_unavailable=false] - Whether specified concrete indices should be ignored when unavailable (missing or closed)
  116.  * @param {boolean} [params.allow_no_indices=true] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes '_all' string or when no indices have been specified)
  117.  * @param {string} [params.conflicts] - What to do when the delete-by-query hits version conflicts? (options: abort, proceed)
  118.  * @param {string} [params.expand_wildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
  119.  * @param {boolean} [params.lenient=false] - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
  120.  * @param {string} [params.preference] - Specify the node or shard the operation should be performed on (default: random)
  121.  * @param {string} [params.q] - Query in the Lucene query string syntax
  122.  * @param {string} [params.routing] - A comma-separated list of specific routing values
  123.  * @param {string} [params.scroll] - Specify how long a consistent view of the index should be maintained for scrolled search
  124.  * @param {string} [params.search_type] - Search operation type (options: query_then_fetch, dfs_query_then_fetch)
  125.  * @param {string} [params.search_timeout] - Explicit timeout for each search request. Defaults to no timeout.
  126.  * @param {number} [params.size] - Deprecated, please use 'max_docs' instead
  127.  * @param {number} [params.max_docs] - Maximum number of documents to process (default: all documents)
  128.  * @param {string} [params.sort] - A comma-separated list of <field>:<direction> pairs
  129.  * @param {string} [params._source] - True or false to return the _source field or not, or a list of fields to return
  130.  * @param {string} [params._source_excludes] - A list of fields to exclude from the returned _source field
  131.  * @param {string} [params._source_includes] - A list of fields to extract and return from the _source field
  132.  * @param {number} [params.terminate_after] - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
  133.  * @param {string} [params.stats] - Specific 'tag' of the request for logging and statistical purposes
  134.  * @param {boolean} [params.version] - Specify whether to return document version as part of a hit
  135.  * @param {boolean} [params.request_cache] - Specify if request cache should be used for this request or not, defaults to index level setting
  136.  * @param {boolean} [params.refresh=false] - Should the effected indexes be refreshed?
  137.  * @param {string} [params.timeout=1m] - time each individual bulk request should wait for shards that are unavailable.
  138.  * @param {string} [params.wait_for_active_shards=1] - Sets the number of shard copies that must be active before proceeding with the delete-by-query operation. 1 means the primary shard only. Set to 'all' for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
  139.  * @param {number} [params.scroll_size=1000] - Size on the scroll request powering the delete-by-query
  140.  * @param {boolean} [params.wait_for_completion] - Should the request should block until the delete-by-query is complete.
  141.  * @param {number} [params.requests_per_second=-1] - The throttle for this request in sub-requests per second. -1 means no throttle.
  142.  * @param {string} [params.slices=1] - The number of slices this task should be divided into. 1 means the task isn't sliced into subtasks. Can be set to 'auto'.
  143.  *
  144.  * @param {Object} options - Options for {@link Transport#request}
  145.  * @param {function} callback - Callback that handles errors and response
  146.  *
  147.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/2.4/api-reference/document-apis/delete-by-query/#response Delete by query Response}
  148.  */
  149. function deleteByQueryApi(params, options, callback) {
  150.   [params, options, callback] = normalizeArguments(params, options, callback);
  152.   // check required parameters
  153.   if (params.index == null) {
  154.     const err = new this[kConfigurationError]('Missing required parameter: index');
  155.     return handleError(err, callback);
  156.   }
  157.   if (params.body == null) {
  158.     const err = new this[kConfigurationError]('Missing required parameter: body');
  159.     return handleError(err, callback);
  160.   }
  162.   // check required url components
  163.   if (params.type != null && params.index == null) {
  164.     const err = new this[kConfigurationError]('Missing required parameter of the url: index');
  165.     return handleError(err, callback);
  166.   }
  168.   let { method, body, index, type, ...querystring } = params;
  169.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  171.   let path = '';
  172.   if (index != null && type != null) {
  173.     if (method == null) method = 'POST';
  174.     path =
  175.       '/' + encodeURIComponent(index) + '/' + encodeURIComponent(type) + '/' + '_delete_by_query';
  176.   } else {
  177.     if (method == null) method = 'POST';
  178.     path = '/' + encodeURIComponent(index) + '/' + '_delete_by_query';
  179.   }
  181.   // build request object
  182.   const request = {
  183.     method,
  184.     path,
  185.     body: body || '',
  186.     querystring,
  187.   };
  189.   return this.transport.request(request, options, callback);
  190. }
  192. module.exports = deleteByQueryApi;