Source: api/api/scroll.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.   'scroll',
  38.   'scroll_id',
  39.   'rest_total_hits_as_int',
  40.   'pretty',
  41.   'human',
  42.   'error_trace',
  43.   'source',
  44.   'filter_path',
  45. ];
  46. const snakeCase = {
  47.   scrollId: 'scroll_id',
  48.   restTotalHitsAsInt: 'rest_total_hits_as_int',
  49.   errorTrace: 'error_trace',
  50.   filterPath: 'filter_path',
  51. };
  53. /**
  54.  * Allows to retrieve a large numbers of results from a single search request.
  55.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/scroll/ OpenSearch - Scroll }
  56.  *
  57.  * @memberOf API-Search
  58.  *
  59.  * @param {Object} params
  60.  * @param {string} [params.scroll_id] - The scroll ID *Deprecated*
  61.  * @param {string} [params.scroll] - Specify how long a consistent view of the index should be maintained for scrolled search
  62.  * @param {boolean} [params.rest_total_hits_as_int] - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
  63.  * @param {Object} [params.body] - The scroll ID if not passed by URL or query parameter.
  64.  *
  65.  * @param {Object} [options] - Options for {@link Transport#request}
  66.  * @param {function} [callback] - Callback that handles errors and response
  67.  *
  68.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  69.  */
  70. function scrollApi(params, options, callback) {
  71.   [params, options, callback] = normalizeArguments(params, options, callback);
  73.   let { method, body, scrollId, scroll_id, ...querystring } = params;
  74.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  76.   let path = '';
  77.   if ((scroll_id || scrollId) != null) {
  78.     if (method == null) method = body == null ? 'GET' : 'POST';
  79.     path = '/' + '_search' + '/' + 'scroll' + '/' + encodeURIComponent(scroll_id || scrollId);
  80.   } else {
  81.     if (method == null) method = body == null ? 'GET' : 'POST';
  82.     path = '/' + '_search' + '/' + 'scroll';
  83.   }
  85.   // build request object
  86.   const request = {
  87.     method,
  88.     path,
  89.     body: body || '',
  90.     querystring,
  91.   };
  93.   return this.transport.request(request, options, callback);
  94. }
  96. module.exports = scrollApi;