Source: api/api/msearch_template.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.   'search_type',
  38.   'typed_keys',
  39.   'max_concurrent_searches',
  40.   'rest_total_hits_as_int',
  41.   'ccs_minimize_roundtrips',
  42.   'pretty',
  43.   'human',
  44.   'error_trace',
  45.   'source',
  46.   'filter_path',
  47. ];
  48. const snakeCase = {
  49.   searchType: 'search_type',
  50.   typedKeys: 'typed_keys',
  51.   maxConcurrentSearches: 'max_concurrent_searches',
  52.   restTotalHitsAsInt: 'rest_total_hits_as_int',
  53.   ccsMinimizeRoundtrips: 'ccs_minimize_roundtrips',
  54.   errorTrace: 'error_trace',
  55.   filterPath: 'filter_path',
  56. };
  58. /**
  59.  * Allows to execute several search template operations in one request.
  60.  *
  61.  * @memberOf API-Search
  62.  *
  63.  * @param {Object} params
  64.  * @param {string} params.index - A comma-separated list of index names to use as default
  65.  * @param {Object} params.body - The request definitions (metadata-search request definition pairs), separated by newlines
  66.  * @param {string} [params.search_type] - Search operation type (options: query_then_fetch, dfs_query_then_fetch)
  67.  * @param {boolean} [params.typed_keys] - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
  68.  * @param {number} [params.max_concurrent_searches] - Controls the maximum number of concurrent searches the multi search api will execute
  69.  * @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
  70.  * @param {boolean} [params.ccs_minimize_roundtrips] - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
  71.  *
  72.  * @param {Object} options - Options for {@link Transport#request}
  73.  * @param {function} callback - Callback that handles errors and response
  74.  *
  75.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  76.  */
  77. function msearchTemplateApi(params, options, callback) {
  78.   [params, options, callback] = normalizeArguments(params, options, callback);
  80.   // check required parameters
  81.   if (params.body == null) {
  82.     const err = new this[kConfigurationError]('Missing required parameter: body');
  83.     return handleError(err, callback);
  84.   }
  86.   // check required url components
  87.   if (params.type != null && params.index == null) {
  88.     const err = new this[kConfigurationError]('Missing required parameter of the url: index');
  89.     return handleError(err, callback);
  90.   }
  92.   let { method, body, index, type, ...querystring } = params;
  93.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  95.   let path = '';
  96.   if (index != null && type != null) {
  97.     if (method == null) method = body == null ? 'GET' : 'POST';
  98.     path =
  99.       '/' +
  100.       encodeURIComponent(index) +
  101.       '/' +
  102.       encodeURIComponent(type) +
  103.       '/' +
  104.       '_msearch' +
  105.       '/' +
  106.       'template';
  107.   } else if (index != null) {
  108.     if (method == null) method = body == null ? 'GET' : 'POST';
  109.     path = '/' + encodeURIComponent(index) + '/' + '_msearch' + '/' + 'template';
  110.   } else {
  111.     if (method == null) method = body == null ? 'GET' : 'POST';
  112.     path = '/' + '_msearch' + '/' + 'template';
  113.   }
  115.   // build request object
  116.   const request = {
  117.     method,
  118.     path,
  119.     bulkBody: body,
  120.     querystring,
  121.   };
  123.   return this.transport.request(request, options, callback);
  124. }
  126. module.exports = msearchTemplateApi;