Source: api/api/get.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.   'version',
  48.   'version_type',
  49.   'pretty',
  50.   'human',
  51.   'error_trace',
  52.   'source',
  53.   'filter_path',
  54. ];
  55. const snakeCase = {
  56.   storedFields: 'stored_fields',
  57.   _sourceExcludes: '_source_excludes',
  58.   _sourceExclude: '_source_exclude',
  59.   _sourceIncludes: '_source_includes',
  60.   _sourceInclude: '_source_include',
  61.   versionType: 'version_type',
  62.   errorTrace: 'error_trace',
  63.   filterPath: 'filter_path',
  64. };
  66. /**
  67.  * Retrieve a document
  68.  * <br/> See Also: {@link https://opensearch.org/docs/2.4/api-reference/document-apis/get-documents/ OpenSearch - Get Document}
  69.  *
  70.  * @memberOf API-Document
  71.  *
  72.  * @param {Object} params
  73.  * @param {string} params.index - Name of the index.
  74.  * @param {string} params.id - Document ID.
  75.  * @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.
  76.  * @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.
  77.  * @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.
  78.  * @param {string} [params.routing] - A value used to route the operation to a specific shard.
  79.  * @param {boolean} [params.stored_fields=false] - Whether the get operation should retrieve fields stored in the index.
  80.  * @param {string} [params._source=true] - Whether to include the '_source' field in the response body.
  81.  * @param {string} [params._source_excludes] - A comma-separated list of source fields to exclude in the query response.
  82.  * @param {string} [params._source_includes] - A comma-separated list of source fields to include in the query response.
  83.  * @param {number} [params.version] - The document’s version number.
  84.  * @param {number} [params.version_type] - Specific version type (options: 'external' and 'external_gte')
  85.  *
  86.  * @param {Object} options - Options for {@link Transport#request}
  87.  * @param {function} callback - Callback that handles errors and response
  88.  *
  89.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/2.4/api-reference/document-apis/get-documents/#response Get Response}
  90.  */
  91. function getApi(params, options, callback) {
  92.   [params, options, callback] = normalizeArguments(params, options, callback);
  94.   // check required parameters
  95.   if (params.id == null) {
  96.     const err = new this[kConfigurationError]('Missing required parameter: id');
  97.     return handleError(err, callback);
  98.   }
  99.   if (params.index == null) {
  100.     const err = new this[kConfigurationError]('Missing required parameter: index');
  101.     return handleError(err, callback);
  102.   }
  104.   let { method, body, id, index, type, ...querystring } = params;
  105.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  107.   let path = '';
  108.   if (index != null && type != null && id != null) {
  109.     if (method == null) method = 'GET';
  110.     path =
  111.       '/' +
  112.       encodeURIComponent(index) +
  113.       '/' +
  114.       encodeURIComponent(type) +
  115.       '/' +
  116.       encodeURIComponent(id);
  117.   } else {
  118.     if (method == null) method = 'GET';
  119.     path = '/' + encodeURIComponent(index) + '/' + '_doc' + '/' + encodeURIComponent(id);
  120.   }
  122.   // build request object
  123.   const request = {
  124.     method,
  125.     path,
  126.     body: null,
  127.     querystring,
  128.   };
  130.   return this.transport.request(request, options, callback);
  131. }
  133. module.exports = getApi;