Source: api/api/reindex.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.   'refresh',
  38.   'timeout',
  39.   'wait_for_active_shards',
  40.   'wait_for_completion',
  41.   'requests_per_second',
  42.   'scroll',
  43.   'slices',
  44.   'max_docs',
  45.   'pretty',
  46.   'human',
  47.   'error_trace',
  48.   'source',
  49.   'filter_path',
  50. ];
  51. const snakeCase = {
  52.   waitForActiveShards: 'wait_for_active_shards',
  53.   waitForCompletion: 'wait_for_completion',
  54.   requestsPerSecond: 'requests_per_second',
  55.   maxDocs: 'max_docs',
  56.   errorTrace: 'error_trace',
  57.   filterPath: 'filter_path',
  58. };
  60. /**
  61.  * Copy all or a subset of your data from a source index into a destination index.
  62.  * <br/> See Also: {@link https://opensearch.org/docs/2.4/api-reference/document-apis/reindex/ OpenSearch - Reindex Document}
  63.  *
  64.  * @memberOf API-Document
  65.  *
  66.  * @param {Object} params
  67.  * @param {Object} params.body The search definition using the Query DSL and the prototype for the index request.
  68.  * @param {boolean} [params.refresh=false] Should the affected indexes be refreshed?
  69.  * @param {string} [params.timeout=30s] Time each individual bulk request should wait for shards that are unavailable.
  70.  * @param {string} [params.wait_for_active_shards] Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning 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)
  71.  * @param {boolean} [params.wait_for_completion=false] Should the request should block until the reindex is complete.
  72.  * @param {number} [params.requests_per_second=-1] The throttle to set on this request in sub-requests per second. -1 means no throttle.
  73.  * @param {string} [params.scroll=5m] Control how long to keep the search context alive
  74.  * @param {number|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`.
  75.  * @param {number} [params.max_docs] Maximum number of documents to process (default: all documents)
  76.  *
  77.  * @param {Object} options - Options for {@link Transport#request}
  78.  * @param {function} callback - Callback that handles errors and response
  79.  *
  80.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/2.4/api-reference/document-apis/reindex/#response Reindex Document Response}
  81.  */
  82. function reindexApi(params, options, callback) {
  83.   [params, options, callback] = normalizeArguments(params, options, callback);
  85.   // check required parameters
  86.   if (params.body == null) {
  87.     const err = new this[kConfigurationError]('Missing required parameter: body');
  88.     return handleError(err, callback);
  89.   }
  91.   let { method, body, ...querystring } = params;
  92.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  94.   let path = '';
  95.   if (method == null) method = 'POST';
  96.   path = '/' + '_reindex';
  98.   // build request object
  99.   const request = {
  100.     method,
  101.     path,
  102.     body: body || '',
  103.     querystring,
  104.   };
  106.   return this.transport.request(request, options, callback);
  107. }
  109. module.exports = reindexApi;