Source: api/api/update_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.   'pipeline',
  48.   'preference',
  49.   'q',
  50.   'routing',
  51.   'scroll',
  52.   'search_type',
  53.   'search_timeout',
  54.   'size',
  55.   'max_docs',
  56.   'sort',
  57.   '_source',
  58.   '_source_excludes',
  59.   '_source_exclude',
  60.   '_source_includes',
  61.   '_source_include',
  62.   'terminate_after',
  63.   'stats',
  64.   'version',
  65.   'version_type',
  66.   'request_cache',
  67.   'refresh',
  68.   'timeout',
  69.   'wait_for_active_shards',
  70.   'scroll_size',
  71.   'wait_for_completion',
  72.   'requests_per_second',
  73.   'slices',
  74.   'pretty',
  75.   'human',
  76.   'error_trace',
  77.   'source',
  78.   'filter_path',
  79. ];
  80. const snakeCase = {
  81.   analyzeWildcard: 'analyze_wildcard',
  82.   defaultOperator: 'default_operator',
  83.   ignoreUnavailable: 'ignore_unavailable',
  84.   allowNoIndices: 'allow_no_indices',
  85.   expandWildcards: 'expand_wildcards',
  86.   searchType: 'search_type',
  87.   searchTimeout: 'search_timeout',
  88.   maxDocs: 'max_docs',
  89.   _sourceExcludes: '_source_excludes',
  90.   _sourceExclude: '_source_exclude',
  91.   _sourceIncludes: '_source_includes',
  92.   _sourceInclude: '_source_include',
  93.   terminateAfter: 'terminate_after',
  94.   versionType: 'version_type',
  95.   requestCache: 'request_cache',
  96.   waitForActiveShards: 'wait_for_active_shards',
  97.   scrollSize: 'scroll_size',
  98.   waitForCompletion: 'wait_for_completion',
  99.   requestsPerSecond: 'requests_per_second',
  100.   errorTrace: 'error_trace',
  101.   filterPath: 'filter_path',
  102. };
  104. /**
  105.  * Run a script to update all documents that match the query.
  106.  * <br/> See Also: {@link https://opensearch.org/docs/2.4/api-reference/document-apis/update-by-query/ OpenSearch - Update by query}
  107.  *
  108.  * @memberOf API-Document
  109.  *
  110.  * @param {Object} params
  111.  * @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
  112.  * @param {Object} [params.body] - The search definition using the Query DSL
  113.  * @param {string} [params.analyzer] - The analyzer to use for the query string
  114.  * @param {boolean} [params.analyze_wildcard=false] - Specify whether wildcard and prefix queries should be analyzed (default: false)
  115.  * @param {string} [params.default_operator=OR] - The default operator for query string query (options: AND, OR)
  116.  * @param {string} [params.df] - The field to use as default where no field prefix is given in the query string
  117.  * @param {number} [params.from=0] - Starting offset
  118.  * @param {boolean} [params.ignore_unavailable=false] - Whether specified concrete indices should be ignored when unavailable (missing or closed)
  119.  * @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)
  120.  * @param {string} [params.conflicts=abort] - What to do when the update by query hits version conflicts? (options: abort, proceed)
  121.  * @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)
  122.  * @param {boolean} [params.lenient=false] - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
  123.  * @param {string} [params.pipeline] - Ingest pipeline to set on index requests made by this action. (default: none)
  124.  * @param {string} [params.preference] - Specify the node or shard the operation should be performed on (default: random)
  125.  * @param {string} [params.q] - Query in the Lucene query string syntax
  126.  * @param {string} [params.routing] - A comma-separated list of specific routing values
  127.  * @param {string} [params.scroll] - Specify how long a consistent view of the index should be maintained for scrolled search
  128.  * @param {string} [params.search_type=query_then_fetch] - Search operation type (options: query_then_fetch, dfs_query_then_fetch)
  129.  * @param {string} [params.search_timeout] - Explicit timeout for each search request. Defaults to no timeout.
  130.  * @param {number} [params.size] - Deprecated, please use 'max_docs' instead
  131.  * @param {number} [params.max_docs] - Maximum number of documents to process (default: all documents)
  132.  * @param {string} [params.sort] - A comma-separated list of <field>:<direction> pairs
  133.  * @param {string} [params._source] - True or false to return the _source field or not, or a list of fields to return
  134.  * @param {string} [params._source_excludes] - A list of fields to exclude from the returned _source field
  135.  * @param {string} [params._source_includes] - A list of fields to extract and return from the _source field
  136.  * @param {number} [params.terminate_after] - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
  137.  * @param {string} [params.stats] - Specific 'tag' of the request for logging and statistical purposes
  138.  * @param {boolean} [params.version] - Specify whether to return document version as part of a hit
  139.  * @param {boolean} [params.version_type] - Should the document increment the version number (internal) on hit or not (reindex)
  140.  * @param {boolean} [params.request_cache] - Specify if request cache should be used for this request or not, defaults to index level setting
  141.  * @param {boolean} [params.refresh=false] - Should the affected indexes be refreshed?
  142.  * @param {string} [params.timeout] - Time each individual bulk request should wait for shards that are unavailable.
  143.  * @param {string} [params.wait_for_active_shards=1] - Sets the number of shard copies that must be active before proceeding with the update 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)
  144.  * @param {number} [params.scroll_size=1000] - Size on the scroll request powering the update by query
  145.  * @param {boolean} [params.wait_for_completion=true] - Should the request should block until the update by query operation is complete.
  146.  * @param {number} [params.requests_per_second=-1] - The throttle to set on this request in sub-requests per second. -1 means no throttle.
  147.  * @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'.
  148.  *
  149.  * @param {Object} options - Options for {@link Transport#request}
  150.  * @param {function} callback - Callback that handles errors and response
  151.  *
  152.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/2.4/api-reference/document-apis/update-by-query/#response Update by query Response}
  153.  */
  154. function updateByQueryApi(params, options, callback) {
  155.   [params, options, callback] = normalizeArguments(params, options, callback);
  157.   // check required parameters
  158.   if (params.index == null) {
  159.     const err = new this[kConfigurationError]('Missing required parameter: index');
  160.     return handleError(err, callback);
  161.   }
  163.   // check required url components
  164.   if (params.type != null && params.index == null) {
  165.     const err = new this[kConfigurationError]('Missing required parameter of the url: index');
  166.     return handleError(err, callback);
  167.   }
  169.   let { method, body, index, type, ...querystring } = params;
  170.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  172.   let path = '';
  173.   if (index != null && type != null) {
  174.     if (method == null) method = 'POST';
  175.     path =
  176.       '/' + encodeURIComponent(index) + '/' + encodeURIComponent(type) + '/' + '_update_by_query';
  177.   } else {
  178.     if (method == null) method = 'POST';
  179.     path = '/' + encodeURIComponent(index) + '/' + '_update_by_query';
  180.   }
  182.   // build request object
  183.   const request = {
  184.     method,
  185.     path,
  186.     body: body || '',
  187.     querystring,
  188.   };
  190.   return this.transport.request(request, options, callback);
  191. }
  193. module.exports = updateByQueryApi;