Source: api/api/search.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. /** @namespace API-Search */
  37. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  38. const acceptedQuerystring = [
  39.   'analyzer',
  40.   'analyze_wildcard',
  41.   'ccs_minimize_roundtrips',
  42.   'default_operator',
  43.   'df',
  44.   'explain',
  45.   'stored_fields',
  46.   'docvalue_fields',
  47.   'from',
  48.   'ignore_unavailable',
  49.   'ignore_throttled',
  50.   'allow_no_indices',
  51.   'expand_wildcards',
  52.   'lenient',
  53.   'preference',
  54.   'q',
  55.   'routing',
  56.   'scroll',
  57.   'search_pipeline',
  58.   'search_type',
  59.   'size',
  60.   'sort',
  61.   '_source',
  62.   '_source_excludes',
  63.   '_source_exclude',
  64.   '_source_includes',
  65.   '_source_include',
  66.   'terminate_after',
  67.   'stats',
  68.   'suggest_field',
  69.   'suggest_mode',
  70.   'suggest_size',
  71.   'suggest_text',
  72.   'timeout',
  73.   'track_scores',
  74.   'track_total_hits',
  75.   'allow_partial_search_results',
  76.   'typed_keys',
  77.   'version',
  78.   'seq_no_primary_term',
  79.   'request_cache',
  80.   'batched_reduce_size',
  81.   'max_concurrent_shard_requests',
  82.   'pre_filter_shard_size',
  83.   'rest_total_hits_as_int',
  84.   'min_compatible_shard_node',
  85.   'pretty',
  86.   'human',
  87.   'error_trace',
  88.   'source',
  89.   'filter_path',
  90. ];
  91. const snakeCase = {
  92.   analyzeWildcard: 'analyze_wildcard',
  93.   ccsMinimizeRoundtrips: 'ccs_minimize_roundtrips',
  94.   defaultOperator: 'default_operator',
  95.   storedFields: 'stored_fields',
  96.   docvalueFields: 'docvalue_fields',
  97.   ignoreUnavailable: 'ignore_unavailable',
  98.   ignoreThrottled: 'ignore_throttled',
  99.   allowNoIndices: 'allow_no_indices',
  100.   expandWildcards: 'expand_wildcards',
  101.   searchPipeline: 'search_pipeline',
  102.   searchType: 'search_type',
  103.   _sourceExcludes: '_source_excludes',
  104.   _sourceExclude: '_source_exclude',
  105.   _sourceIncludes: '_source_includes',
  106.   _sourceInclude: '_source_include',
  107.   terminateAfter: 'terminate_after',
  108.   suggestField: 'suggest_field',
  109.   suggestMode: 'suggest_mode',
  110.   suggestSize: 'suggest_size',
  111.   suggestText: 'suggest_text',
  112.   trackScores: 'track_scores',
  113.   trackTotalHits: 'track_total_hits',
  114.   allowPartialSearchResults: 'allow_partial_search_results',
  115.   typedKeys: 'typed_keys',
  116.   seqNoPrimaryTerm: 'seq_no_primary_term',
  117.   requestCache: 'request_cache',
  118.   batchedReduceSize: 'batched_reduce_size',
  119.   maxConcurrentShardRequests: 'max_concurrent_shard_requests',
  120.   preFilterShardSize: 'pre_filter_shard_size',
  121.   restTotalHitsAsInt: 'rest_total_hits_as_int',
  122.   minCompatibleShardNode: 'min_compatible_shard_node',
  123.   errorTrace: 'error_trace',
  124.   filterPath: 'filter_path',
  125. };
  127. /**
  128.  * Allows to execute several search operations in one request.
  129.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/search/ OpenSearch - Search}
  130.  *
  131.  * @memberOf API-Search
  132.  *
  133.  * @param {Object} params
  134.  * @param {string} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
  135.  * @param {string} [params.analyzer] - The analyzer to use for the query string
  136.  * @param {boolean} [params.analyze_wildcard] - Specify whether wildcard and prefix queries should be analyzed (default: false)
  137.  * @param {boolean} [params.ccs_minimize_roundtrips] - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
  138.  * @param {string} [params.default_operator] - The default operator for query string query (AND or OR) (options: AND, OR)
  139.  * @param {string} [params.df] - The field to use as default where no field prefix is given in the query string
  140.  * @param {boolean} [params.explain] - Specify whether to return detailed information about score computation as part of a hit
  141.  * @param {string} [params.stored_fields] - A comma-separated list of stored fields to return as part of a hit
  142.  * @param {string} [params.docvalue_fields] - A comma-separated list of fields to return as the docvalue representation of a field for each hit
  143.  * @param {number} [params.from] - Starting offset (default: 0)
  144.  * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed)
  145.  * @param {boolean} [params.ignore_throttled] - Whether specified concrete, expanded or aliased indices should be ignored when throttled
  146.  * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
  147.  * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
  148.  * @param {boolean} [params.lenient] - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
  149.  * @param {string} [params.preference] - Specify the node or shard the operation should be performed on (default: random)
  150.  * @param {string} [params.q] - Query in the Lucene query string syntax
  151.  * @param {string} [params.routing] - A comma-separated list of specific routing values
  152.  * @param {string} [params.scroll] - Specify how long a consistent view of the index should be maintained for scrolled search
  153.  * @param {string} [params.search_pipeline] - Customizable sequence of processing stages applied to search queries.
  154.  * @param {string} [params.search_type] - Search operation type (options: query_then_fetch, dfs_query_then_fetch)
  155.  * @param {number} [params.size] - Number of hits to return (default: 10)
  156.  * @param {string} [params.sort] - A comma-separated list of <field>:<direction> pairs
  157.  * @param {string} [params._source] - True or false to return the _source field or not, or a list of fields to return
  158.  * @param {string} [params._source_excludes] - A list of fields to exclude from the returned _source field
  159.  * @param {string} [params._source_includes] - A list of fields to extract and return from the _source field
  160.  * @param {number} [params.terminate_after] - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
  161.  * @param {string} [params.stats] - Specific 'tag' of the request for logging and statistical purposes
  162.  * @param {string} [params.suggest_field] - Specify which field to use for suggestions
  163.  * @param {string} [params.suggest_mode] - Specify suggest mode (options: missing, popular, always)
  164.  * @param {number} [params.suggest_size] - How many suggestions to return in response
  165.  * @param {string} [params.suggest_text] - The source text for which the suggestions should be returned
  166.  * @param {string} [params.timeout] - Explicit operation timeout
  167.  * @param {boolean} [params.track_scores] - Whether to calculate and return scores even if they are not used for sorting
  168.  * @param {boolean} [params.track_total_hits] - Indicate if the number of documents that match the query should be tracked
  169.  * @param {boolean} [params.allow_partial_search_results] - Indicate if an error should be returned if there is a partial search failure or timeout
  170.  * @param {boolean} [params.typed_keys] - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
  171.  * @param {boolean} [params.version] - Specify whether to return document version as part of a hit
  172.  * @param {boolean} [params.seq_no_primary_term] - Specify whether to return sequence number and primary term of the last modification of each hit
  173.  * @param {boolean} [params.request_cache] - Specify if request cache should be used for this request or not, defaults to index level setting
  174.  * @param {number} [params.batched_reduce_size] - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
  175.  * @param {number} [params.max_concurrent_shard_requests] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
  176.  * @param {number} [params.pre_filter_shard_size] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
  177.  * @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
  178.  * @param {string} [params.min_compatible_shard_node] - The minimum compatible version that all shards involved in search should have for this request to be successful
  179.  * @param {Object} [params.body] - The search definition using the Query DSL
  180.  *
  181.  * @param {Object} options - Options for {@link Transport#request}
  182.  * @param {function} callback - Callback that handles errors and response
  183.  *
  184.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/search/#response-body Search Response}
  185.  */
  186. function searchApi(params, options, callback) {
  187.   [params, options, callback] = normalizeArguments(params, options, callback);
  189.   // check required url components
  190.   if (params.type != null && params.index == null) {
  191.     const err = new this[kConfigurationError]('Missing required parameter of the url: index');
  192.     return handleError(err, callback);
  193.   }
  195.   let { method, body, index, type, ...querystring } = params;
  196.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  198.   let path = '';
  199.   if (index != null && type != null) {
  200.     if (method == null) method = body == null ? 'GET' : 'POST';
  201.     path = '/' + encodeURIComponent(index) + '/' + encodeURIComponent(type) + '/' + '_search';
  202.   } else if (index != null) {
  203.     if (method == null) method = body == null ? 'GET' : 'POST';
  204.     path = '/' + encodeURIComponent(index) + '/' + '_search';
  205.   } else {
  206.     if (method == null) method = body == null ? 'GET' : 'POST';
  207.     path = '/' + '_search';
  208.   }
  210.   // build request object
  211.   const request = {
  212.     method,
  213.     path,
  214.     body: body || '',
  215.     querystring,
  216.   };
  218.   return this.transport.request(request, options, callback);
  219. }
  221. module.exports = searchApi;