Source: api/api/count.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-Count */
  37. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  38. const acceptedQuerystring = [
  39.   'ignore_unavailable',
  40.   'ignore_throttled',
  41.   'allow_no_indices',
  42.   'expand_wildcards',
  43.   'min_score',
  44.   'preference',
  45.   'routing',
  46.   'q',
  47.   'analyzer',
  48.   'analyze_wildcard',
  49.   'default_operator',
  50.   'df',
  51.   'lenient',
  52.   'terminate_after',
  53.   'pretty',
  54.   'human',
  55.   'error_trace',
  56.   'source',
  57.   'filter_path',
  58. ];
  59. const snakeCase = {
  60.   ignoreUnavailable: 'ignore_unavailable',
  61.   ignoreThrottled: 'ignore_throttled',
  62.   allowNoIndices: 'allow_no_indices',
  63.   expandWildcards: 'expand_wildcards',
  64.   minScore: 'min_score',
  65.   analyzeWildcard: 'analyze_wildcard',
  66.   defaultOperator: 'default_operator',
  67.   terminateAfter: 'terminate_after',
  68.   errorTrace: 'error_trace',
  69.   filterPath: 'filter_path',
  70. };
  72. /**
  73.  * The count API gives you quick access to the number of documents that match a query. You can also use it to check the document count of an index, data stream, or cluster.
  74.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/count/ OpenSearch - Bulk}
  75.  *
  76.  * @memberOf API-Count
  77.  *
  78.  * @param {Object} params
  79.  * @param {boolean} [params.allow_no_indices=false] - If false, the request returns an error if any wildcard expression or index alias targets any closed or missing indices.
  80.  * @param {string} [params.analyzer] - The analyzer to use in the query string.
  81.  * @param {boolean} [params.analyze_wildcard=false] - Specifies whether to analyze wildcard and prefix queries.
  82.  * @param {string} [params.default_operator='OR'] - Indicates whether the default operator for a string query should be 'AND' or 'OR'.
  83.  * @param {string} [params.df] - The default field in case a field prefix is not provided in the query string.
  84.  * @param {string} [params.expand_wildcards=open] - Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are 'all', 'open', 'closed', 'hidden', and 'none'.
  85.  * @param {boolean} [params.ignore_unavailable=false] - Specifies whether to include missing or closed indices in the response.
  86.  * @param {boolean} [params.lenient=false] - Specifies whether OpenSearch should accept requests if queries have format errors (for example, querying a text field for an integer).
  87.  * @param {number} [params.min_score] - Include only documents with a minimum '_score' value in the result.
  88.  * @param {string} [params.routing] - Value used to route the operation to a specific shard.
  89.  * @param {string} [params.preference] - Specifies which shard or node OpenSearch should perform the count operation on.
  90.  * @param {number} [params.terminate_after] - The maximum number of documents OpenSearch should process before terminating the request.
  91.  *
  92.  * @param {Object} options - Options for {@link Transport#request}
  93.  * @param {function} callback - Callback that handles errors and response
  94.  *
  95.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/count/#response Count Response}
  96.  */
  98. function countApi(params, options, callback) {
  99.   [params, options, callback] = normalizeArguments(params, options, callback);
  101.   // check required url components
  102.   if (params.type != null && params.index == null) {
  103.     const err = new this[kConfigurationError]('Missing required parameter of the url: index');
  104.     return handleError(err, callback);
  105.   }
  107.   let { method, body, index, type, ...querystring } = params;
  108.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  110.   let path = '';
  111.   if (index != null && type != null) {
  112.     if (method == null) method = body == null ? 'GET' : 'POST';
  113.     path = '/' + encodeURIComponent(index) + '/' + encodeURIComponent(type) + '/' + '_count';
  114.   } else if (index != null) {
  115.     if (method == null) method = body == null ? 'GET' : 'POST';
  116.     path = '/' + encodeURIComponent(index) + '/' + '_count';
  117.   } else {
  118.     if (method == null) method = body == null ? 'GET' : 'POST';
  119.     path = '/' + '_count';
  120.   }
  122.   // build request object
  123.   const request = {
  124.     method,
  125.     path,
  126.     body: body || '',
  127.     querystring,
  128.   };
  130.   return this.transport.request(request, options, callback);
  131. }
  133. module.exports = countApi;