Source: api/api/delete.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.   'if_seq_no',
  42.   'if_primary_term',
  43.   'version',
  44.   'version_type',
  45.   'pretty',
  46.   'human',
  47.   'error_trace',
  48.   'source',
  49.   'filter_path',
  50. ];
  51. const snakeCase = {
  52.   waitForActiveShards: 'wait_for_active_shards',
  53.   ifSeqNo: 'if_seq_no',
  54.   ifPrimaryTerm: 'if_primary_term',
  55.   versionType: 'version_type',
  56.   errorTrace: 'error_trace',
  57.   filterPath: 'filter_path',
  58. };
  60. /**
  61.  * Delete a document
  62.  * <br/> See Also: {@link https://opensearch.org/docs/2.4/api-reference/document-apis/update-document/ OpenSearch - Update Document}
  63.  *
  64.  * @memberOf API-Document
  65.  *
  66.  * @param {Object} params
  67.  * @param {string} params.index - Name of the index.
  68.  * @param {string} params.id - A unique identifier to attach to the document.
  69.  * @param {number} [params.if_seq_no] - Only perform the delete operation if the document has the specified sequence number.
  70.  * @param {number} [params.if_primary_term] - Only perform the delete operation if the document has the specified primary term.
  71.  * @param {string} [params.routing] - Value used to assign the index operation to a specific shard.
  72.  * @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.
  73.  * @param {string} [params.timeout=1m] - How long to wait for a response from the cluster.
  74.  * @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.
  75.  * @param {number} [params.version] - The document’s version number.
  76.  * @param {number} [params.version_type] - Specific version type (options: 'external' and 'external_gte')
  77.  *
  78.  * @param {Object} options - Options for {@link Transport#request}
  79.  * @param {function} callback - Callback that handles errors and response
  80.  *
  81.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/2.4/api-reference/document-apis/update-document/#response Update Response}
  82.  */
  83. function deleteApi(params, options, callback) {
  84.   [params, options, callback] = normalizeArguments(params, options, callback);
  86.   // check required parameters
  87.   if (params.id == null) {
  88.     const err = new this[kConfigurationError]('Missing required parameter: id');
  89.     return handleError(err, callback);
  90.   }
  91.   if (params.index == null) {
  92.     const err = new this[kConfigurationError]('Missing required parameter: index');
  93.     return handleError(err, callback);
  94.   }
  96.   let { method, body, id, index, type, ...querystring } = params;
  97.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  99.   let path = '';
  100.   if (index != null && type != null && id != null) {
  101.     if (method == null) method = 'DELETE';
  102.     path =
  103.       '/' +
  104.       encodeURIComponent(index) +
  105.       '/' +
  106.       encodeURIComponent(type) +
  107.       '/' +
  108.       encodeURIComponent(id);
  109.   } else {
  110.     if (method == null) method = 'DELETE';
  111.     path = '/' + encodeURIComponent(index) + '/' + '_doc' + '/' + encodeURIComponent(id);
  112.   }
  114.   // build request object
  115.   const request = {
  116.     method,
  117.     path,
  118.     body: body || '',
  119.     querystring,
  120.   };
  122.   return this.transport.request(request, options, callback);
  123. }
  125. module.exports = deleteApi;