Source: api/api/create_pit.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. 'use strict';
  13. /* eslint camelcase: 0 */
  14. /* eslint no-unused-vars: 0 */
  16. /** @namespace API-PIT */
  18. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  19. const acceptedQuerystring = [
  20.   'allow_partial_pit_creation',
  21.   'keep_alive',
  22.   'preference',
  23.   'routing',
  24.   'pretty',
  25.   'human',
  26.   'error_trace',
  27.   'source',
  28.   'filter_path',
  29. ];
  30. const snakeCase = {
  31.   allowPartialPitCreation: 'allow_partial_pit_creation',
  32.   keepAlive: 'keep_alive',
  33.   errorTrace: 'error_trace',
  34.   filterPath: 'filter_path',
  35. };
  37. /**
  38.  * Creates a point in time.
  39.  * <br/> See Also: {@link https://opensearch.org/docs/latest/opensearch/point-in-time-api#create-a-pit|Opensearch - Create a PIT}
  40.  * @memberOf API-PIT
  41.  *
  42.  * @param {Object} params
  43.  * @param {string} params.index - The name(s) of the target index(es) for the PIT. May contain a comma-separated list or a wildcard index pattern.
  44.  * @param {string} params.keep_alive - The amount of time to keep the PIT
  45.  * @param {string} [params.preference=random] - The node or the shard used to perform the search.
  46.  * @param {string} [params.routing] - Specifies to route search requests to a specific shard.
  47.  * @param {string} [params.expand_wildcards=open] - The type of index that can match the wildcard pattern. Supports comma-separated values.
  48.  * @param {string} [params.allow_partial_pit_creation=false] - Specifies whether to create a PIT with partial failures.
  49.  *
  50.  * @param {Object} [options] - Options for {@link Transport#request}
  51.  * @param {function} [callback] - Callback that handles errors and response
  52.  *
  53.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/opensearch/point-in-time-api#sample-response|Create PIT Response}
  54.  */
  56. function createPitApi(params, options, callback) {
  57.   [params, options, callback] = normalizeArguments(params, options, callback);
  59.   // check required parameters
  60.   if (params['index'] == null) {
  61.     const err = new this[kConfigurationError]('Missing required parameter: index');
  62.     return handleError(err, callback);
  63.   }
  65.   if (params['keep_alive'] == null) {
  66.     const err = new this[kConfigurationError]('Missing required parameter: keep_alive');
  67.     return handleError(err, callback);
  68.   }
  70.   let { method, body, index, ...querystring } = params;
  71.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  73.   let path = '';
  74.   if (method == null) method = 'POST';
  75.   path = '/' + encodeURIComponent(index) + '/' + '_search' + '/' + 'point_in_time';
  77.   // build request object
  78.   const request = {
  79.     method,
  80.     path,
  81.     body: body || '',
  82.     querystring,
  83.   };
  85.   return this.transport.request(request, options, callback);
  86. }
  88. module.exports = createPitApi;