Source: api/api/mget.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.   'stored_fields',
  38.   'preference',
  39.   'realtime',
  40.   'refresh',
  41.   'routing',
  42.   '_source',
  43.   '_source_excludes',
  44.   '_source_exclude',
  45.   '_source_includes',
  46.   '_source_include',
  47.   'pretty',
  48.   'human',
  49.   'error_trace',
  50.   'source',
  51.   'filter_path',
  52. ];
  53. const snakeCase = {
  54.   storedFields: 'stored_fields',
  55.   _sourceExcludes: '_source_excludes',
  56.   _sourceExclude: '_source_exclude',
  57.   _sourceIncludes: '_source_includes',
  58.   _sourceInclude: '_source_include',
  59.   errorTrace: 'error_trace',
  60.   filterPath: 'filter_path',
  61. };
  63. /**
  64.  * Retrieve multiple documents
  65.  * <br/> See Also: {@link https://opensearch.org/docs/2.4/api-reference/document-apis/multi-get/ OpenSearch - Multi-get Document}
  66.  *
  67.  * @memberOf API-Document
  68.  *
  69.  * @param {Object} params
  70.  * @param {string} params.index - Name of the index.
  71.  * @param {string} params.id - Document ID.
  72.  * @param {string} params.body - {@link https://opensearch.org/docs/2.4/api-reference/document-apis/multi-get/#request-body Multi-get Request Body}
  73.  * @param {string} [params.preference] - Specifies a preference of which shard to retrieve results from. Available options are '_local', which tells the operation to retrieve results from a locally allocated shard replica, and a custom string value assigned to a specific shard replica. By default, OpenSearch executes get document operations on random shards.
  74.  * @param {boolean} [params.realtime=true] - Specifies whether the operation should run in realtime. If false, the operation waits for the index to refresh to analyze the source to retrieve data, which makes the operation near-realtime.
  75.  * @param {boolean} [params.refresh=false] - If true, OpenSearch refreshes shards to make the get operation available to search results. Valid options are 'true', 'false', and 'wait_for', which tells OpenSearch to wait for a refresh before executing the operation.
  76.  * @param {string} [params.routing] - A value used to route the operation to a specific shard.
  77.  * @param {boolean} [params.stored_fields=false] - Whether the get operation should retrieve fields stored in the index.
  78.  * @param {string} [params._source=true] - Whether to include the '_source' field in the response body.
  79.  * @param {string} [params._source_excludes] - A comma-separated list of source fields to exclude in the query response.
  80.  * @param {string} [params._source_includes] - A comma-separated list of source fields to include in the query response.
  81.  *
  82.  * @param {Object} options - Options for {@link Transport#request}
  83.  * @param {function} callback - Callback that handles errors and response
  84.  *
  85.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/2.4/api-reference/document-apis/multi-get/#response Multi-get Response}
  86.  */
  87. function mgetApi(params, options, callback) {
  88.   [params, options, callback] = normalizeArguments(params, options, callback);
  90.   // check required parameters
  91.   if (params.body == null) {
  92.     const err = new this[kConfigurationError]('Missing required parameter: body');
  93.     return handleError(err, callback);
  94.   }
  96.   // check required url components
  97.   if (params.type != null && params.index == null) {
  98.     const err = new this[kConfigurationError]('Missing required parameter of the url: index');
  99.     return handleError(err, callback);
  100.   }
  102.   let { method, body, index, type, ...querystring } = params;
  103.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  105.   let path = '';
  106.   if (index != null && type != null) {
  107.     if (method == null) method = body == null ? 'GET' : 'POST';
  108.     path = '/' + encodeURIComponent(index) + '/' + encodeURIComponent(type) + '/' + '_mget';
  109.   } else if (index != null) {
  110.     if (method == null) method = body == null ? 'GET' : 'POST';
  111.     path = '/' + encodeURIComponent(index) + '/' + '_mget';
  112.   } else {
  113.     if (method == null) method = body == null ? 'GET' : 'POST';
  114.     path = '/' + '_mget';
  115.   }
  117.   // build request object
  118.   const request = {
  119.     method,
  120.     path,
  121.     body: body || '',
  122.     querystring,
  123.   };
  125.   return this.transport.request(request, options, callback);
  126. }
  128. module.exports = mgetApi;