Source: api/api/bulk.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.   'wait_for_active_shards',
  38.   'refresh',
  39.   'routing',
  40.   'timeout',
  41.   'type',
  42.   '_source',
  43.   '_source_excludes',
  44.   '_source_exclude',
  45.   '_source_includes',
  46.   '_source_include',
  47.   'pipeline',
  48.   'require_alias',
  49.   'pretty',
  50.   'human',
  51.   'error_trace',
  52.   'source',
  53.   'filter_path',
  54. ];
  55. const snakeCase = {
  56.   waitForActiveShards: 'wait_for_active_shards',
  57.   _sourceExcludes: '_source_excludes',
  58.   _sourceExclude: '_source_exclude',
  59.   _sourceIncludes: '_source_includes',
  60.   _sourceInclude: '_source_include',
  61.   requireAlias: 'require_alias',
  62.   errorTrace: 'error_trace',
  63.   filterPath: 'filter_path',
  64. };
  66. /**
  67.  * The bulk operation lets you add, update, or delete many documents in a single request.
  68.  * Compared to individual OpenSearch indexing requests, the bulk operation has significant performance benefits.
  69.  * Whenever practical, we recommend batching indexing operations into bulk requests.
  70.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/document-apis/bulk/|OpenSearch - Bulk}
  71.  *
  72.  * @memberOf API-Document
  73.  *
  74.  * @param {Object} params
  75.  * @param {Object[]} params.body - {@link https://opensearch.org/docs/latest/api-reference/document-apis/bulk/#request-body|Request Body}
  76.  * @param {string} [params.index] - Specifying the index means you don’t need to include it in the request body.
  77.  * @param {string} [params.pipeline] - The pipeline ID for preprocessing documents.
  78.  * @param {string} [params.routing] - Routes the request to the specified shard.
  79.  * @param {string} [params.refresh=false] - If true, OpenSearch refreshes shards to make the operation visible to searching. Valid options are 'true', 'false', and 'wait_for', which tells OpenSearch to wait for a refresh before executing the operation.
  80.  * @param {string} [params.timeout=1m] - How long to wait for a response from the cluster.
  81.  * @param {string} [params.wait_for_active_shards] - The number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the operation to succeed.
  82.  * @param {boolean} [params.require_alias=false] - Specifies whether the target index must be an index alias.
  83.  *
  84.  * @param {Object} options - Options for {@link Transport#request}
  85.  * @param {function} callback - Callback that handles errors and response
  86.  *
  87.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/document-apis/bulk/#response|Bulk Response}
  88.  */
  89. function bulkApi(params, options, callback) {
  90.   [params, options, callback] = normalizeArguments(params, options, callback);
  92.   // check required parameters
  93.   if (params.body == null) {
  94.     const err = new this[kConfigurationError]('Missing required parameter: body');
  95.     return handleError(err, callback);
  96.   }
  98.   // check required url components
  99.   if (params.type != null && params.index == null) {
  100.     const err = new this[kConfigurationError]('Missing required parameter of the url: index');
  101.     return handleError(err, callback);
  102.   }
  104.   let { method, body, index, type, ...querystring } = params;
  105.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  107.   let path = '';
  108.   if (index != null && type != null) {
  109.     if (method == null) method = 'POST';
  110.     path = '/' + encodeURIComponent(index) + '/' + encodeURIComponent(type) + '/' + '_bulk';
  111.   } else if (index != null) {
  112.     if (method == null) method = 'POST';
  113.     path = '/' + encodeURIComponent(index) + '/' + '_bulk';
  114.   } else {
  115.     if (method == null) method = 'POST';
  116.     path = '/' + '_bulk';
  117.   }
  119.   // build request object
  120.   const request = {
  121.     method,
  122.     path,
  123.     bulkBody: body,
  124.     querystring,
  125.   };
  127.   return this.transport.request(request, options, callback);
  128. }
  130. module.exports = bulkApi;