aerospike/lib/query_duration.js

Aerospike Client Library

// *****************************************************************************
// Copyright 2022-2023 Aerospike, Inc.
//
// Licensed under the Apache License, Version 2.0 (the 'License')
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an 'AS IS' BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// *****************************************************************************

'use strict'

const as = require('bindings')('aerospike.node')
const queryDuration = as.queryDuration

/**
 * @module aerospike/queryDuration
 *
 * @description Expected query duration. The server treats the query in different ways depending on the expected duration.
 * This enum is ignored for aggregation (UDF) queries, background queries and server versions < 6.0.
 */

// ========================================================================
// Constants
// ========================================================================
module.exports = {
  /**
     * The query is expected to return more than 100 records per node. The server optimizes for a
     * large record set in the following ways:
     * <ul>
     * <li>Allow query to be run in multiple threads using the server's query threading configuration.</li>
     * <li>Do not relax read consistency for AP namespaces.</li>
     * <li>Add the query to the server's query monitor.</li>
     * <li>Do not add the overall latency to the server's latency histogram.</li>
     * <li>Do not allow server timeouts.</li>
     * </ul>
     *
     * @const {number}
     */
  LONG: queryDuration.LONG,

  /**
     * The query is expected to return less than 100 records per node. The server optimizes for a
     * small record set in the following ways:
     * <ul>
     * <li>Always run the query in one thread and ignore the server's query threading configuration.</li>
     * <li>Allow query to be inlined directly on the server's service thread.</li>
     * <li>Relax read consistency for AP namespaces.</li>
     * <li>Do not add the query to the server's query monitor.</li>
     * <li>Add the overall latency to the server's latency histogram.</li>
     * <li>Allow server timeouts. The default server timeout for a short query is 1 second.</li>
     * </ul>
     *
     * @const {number}
     */
  SHORT: queryDuration.SHORT,

  /**
     * Treat query as a LONG query, but relax read consistency for AP namespaces.
     * This value is treated exactly like LONG for server versions &lt; 7.1.
     *
     * @const {number}
     */
  LONG_RELAX_AP: queryDuration.LONG_RELAX_AP
}