Query Admin REST API

The name of the cluster.

The URL of the datastore.

The URL of the configstore.

The URL of the accountstore.

The amount of memory freed.

Only returned by the POST method. The amount of memory released to the OS.

The status of the garbage collector.

If true, all requests that generate a panic are logged.

The IP address of the client. If specified, all completed requests from this IP address are logged.

The opaque ID or context provided by the client. If specified, all completed requests with this client context ID are logged.

Refer to the request-level client_context_id parameter for more information.

An error number. If specified, all completed queries returning this error number are logged.

A unique string which tags a set of qualifiers.

Refer to Configure Completed Requests for more information.

A duration in milliseconds. If specified, all completed queries lasting longer than this threshold are logged.

This is another way of specifying the node-level completed-threshold setting.

A user name, as given in the request credentials. If specified, all completed queries with this user name are logged.

A single value that represents the current state.

15-minute exponentially weighted moving average.

1-minute exponentially weighted moving average.

5-minute exponentially weighted moving average.

Mean rate since the query service started.

The maximum value.

The mean value.

The median value.

The minimum value.

The standard deviation.

The 75th percentile.

The 95th percentile.

The 99th percentile.

The 99.9th percentile.

The name of the cluster.

The URL of the node, including port number.

The HTTP URL of the query endpoint.

The HTTP URL of the admin endpoint.

The HTTPS URL of the query endpoint.

The HTTPS URL of the admin endpoint.

The opaque ID or context provided by the client. Refer to the request-level client_context_id parameter for more information.

The time taken from when the request was acknowledged by the service to when the request was completed. It includes the time taken by the service to schedule the request.

Total number of errors encountered while executing the query.

The memory quota for the request, in MB. This property is only returned if a memory quota is set for the query.

IP address and port number of the node where the query is executed.

Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc.

For active requests, this property is dynamic, depending on the documents processed by various phases up to this moment in time. Polling the active requests again may return different values.

Indicates the numbers of each kind of query operator involved in different phases of the query processing.

For instance, a non-covering index path might involve one index scan and one fetch operator. A join would probably involve two or more fetches, one per keyspace. A union select would have twice as many operator counts, one per each branch of the union.

Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc.

For active requests, this property is dynamic, depending on the documents processed by various phases up to this moment in time. Polling the active requests again may return different values.

IP address and port number of the client application, from where the query is received.

Unique request ID internally generated for the query.

Timestamp when the query is received.

Total number of documents returned in the query result.

Total number of bytes returned in the query result.

The value of the query setting Scan Consistency used for the query.

Total amount of calendar time taken to complete the query.

The state of the query execution, such as completed, running, cancelled.

Note that the completed state means that the request was started and completed by the Query service, but it does not mean that it was necessarily successful. The request could have been successful, or completed with errors.

To find requests that were successful, use this field in conjunction with the errorCount field: search for requests whose state is completed and whose error count is 0.

The query statement being executed.

Whether the cost-based optimizer is enabled for the query.

The amount of document memory used to execute the request. This property is only returned if a memory quota is set for the query.

Name of the client application or program that issued the query.

Username with whose privileges the query is run.

Specifies the collection where active transaction records are stored. The collection must be present. If not specified, the active transaction record is stored in the default collection in the default scope in the bucket containing the first mutated document within the transaction.

The value must be a string in the form "bucket.scope.collection" or "namespace:bucket.scope.collection". If any part of the path contains a special character, that part of the path must be delimited in backticks ``.

The request-level atrcollection parameter specifies this property per request. If a request does not include this parameter, the node-level atrcollection setting will be used.

Specifies whether the query engine should create a prepared statement every time a SQL++ request is submitted, whether the PREPARE statement is included or not.

Refer to Auto-Prepare for more information.

When enabled, the Query service preferentially aims to clean up just transactions that it has created, leaving transactions for the distributed cleanup process only when it is forced to.

The cluster-level queryCleanupClientAttempts setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client.

The cluster-level queryCleanupLostAttempts setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

Specifies how frequently the Query service checks its subset of active transaction records for cleanup. Decreasing this setting causes expiration transactions to be found more swiftly, with the tradeoff of increasing the number of reads per second used for the scanning process.

The value for this setting is a string. Its format includes an amount and a mandatory unit, e.g. 10ms (10 milliseconds) or 0.5s (half a second). Valid units are:

• ns (nanoseconds)
• us (microseconds)
• ms (milliseconds)
• s (seconds)
• m (minutes)
• h (hours)

The cluster-level queryCleanupWindow setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

A nested object that sets the parameters for the completed requests catalog. All completed requests that match these parameters are tracked in the completed requests catalog.

Refer to Configure Completed Requests for more information and examples.

Sets the number of requests to be logged in the completed requests catalog. As new completed requests are added, old ones are removed.

Increase this when the completed request keyspace is not big enough to track the slow requests, such as when you want a larger sample of slow requests.

Refer to Configure Completed Requests for more information and examples.

The cluster-level queryCompletedLimit setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

A plan size in bytes. Limits the size of query execution plans that can be logged in the completed requests catalog. Values larger than the maximum limit are silently treated as the maximum limit. Queries with plans larger than this are not logged. You must obtain execution plans for such queries via profiling or using the EXPLAIN statement.

Refer to Configure Completed Requests for more information.

The cluster-level queryCompletedMaxPlanSize setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

A file size in MiB. When specified, completed requests are saved to the Couchbase Server logs directory. Completed requests are saved to GZIP archives with the prefix local_request_log. The value of this property determines the size of the data to retain, per node.

Specify 0 (the default) to disable completed request streaming.

Completed request streaming is available in Couchbase Server 7.6.4 and later.

Refer to Stream Completed Requests for more information and examples.

A duration in milliseconds. All completed queries lasting longer than this threshold are logged in the completed requests catalog.

Specify 0 to track all requests, independent of duration. Specify any negative number to track none.

Refer to Configure Completed Requests for more information and examples.

The cluster-level queryCompletedThreshold setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

Specifies if there should be a controls section returned with the request results.

When set to true, the query response document includes a controls section with runtime information provided along with the request, such as positional and named parameters or settings.

NOTE: If the request qualifies for caching, these values will also be cached in the completed_requests system keyspace.

The request-level controls parameter specifies this property per request. If a request does not include this parameter, the node-level controls setting will be used.

The absolute path and filename to write the CPU profile to a local file.

The output file includes a controls section and performance measurements, such as memory allocation and garbage collection, to pinpoint bottlenecks and ways to improve your code execution.

NOTE: If cpuprofile is left running too long, it can slow the system down as its file size increases.

To stop cpuprofile, run with the empty setting of "".

Use debug mode.

When set to true, extra logging is provided.

This field is only available with the POST method. When specified alongside other settings, this field instructs the node that is processing the request to cascade those settings to all other query nodes. The actual value of this field is ignored.

Maximum number of user-defined functions.

Maximum size of buffered result.

Log level used in the logger.

All values, in descending order of data:

• DEBUG — For developers. Writes everything.

• TRACE — For developers. Less info than DEBUG.

• INFO — For admin & customers. Lists warnings & errors.

• WARN — For admin. Only abnormal items.

• ERROR — For admin. Only errors to be fixed.

• SEVERE — For admin. Major items, like crashes.

• NONE — Doesn't write anything.

The cluster-level queryLogLevel setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

Max index API. This setting is provided for technical support only.

Specifies the maximum parallelism for queries on this node.

If the value is zero or negative, the maximum parallelism is restricted to the number of allowed cores. Similarly, if the value is greater than the number of allowed cores, the maximum parallelism is restricted to the number of allowed cores.

(The number of allowed cores is the same as the number of logical CPUs. In Community Edition, the number of allowed cores cannot be greater than 4. In Enterprise Edition, there is no limit to the number of allowed cores.)

The cluster-level queryMaxParallelism setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, there is a request-level max_parallelism parameter. If a request includes this parameter, it will be capped by the node-level max-parallelism setting.

NOTE: To enable queries to run in parallel, you must specify the cluster-level queryMaxParallelism parameter, or specify the node-level max-parallelism parameter on all Query nodes.

Refer to Max Parallelism for more information.

Specifies the maximum amount of memory a request may use on this node, in MB. Note that the overall node memory quota is this setting multiplied by the node-level servicers setting.

Specify 0 (the default value) to disable. When disabled, there is no quota.

This parameter enforces a ceiling on the memory used for the tracked documents required for processing a request. It does not take into account any other memory that might be used to process a request, such as the stack, the operators, or some intermediate values.

Within a transaction, this setting enforces the memory quota for the transaction by tracking the delta table and the transaction log (approximately).

The cluster-level queryMemoryQuota setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, the request-level memory_quota parameter specifies this property per request. If a request includes this parameter, it will be capped by the node-level memory-quota setting.

Filename to write the diagnostic memory usage log.

NOTE: If memprofile is left running too long, it can slow the system down as its file size increases.

To stop memprofile, run with the empty setting of "".

Mutex profile. This setting is provided for technical support only.

SQL++ feature control. This setting is provided for technical support only. The value may be an integer, or a string representing a hexadecimal number.

The cluster-level queryN1qlFeatCtrl setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

Sets the soft memory limit for this node, in MB. The garbage collector tries to keep below this target. It is not a hard, absolute limit, and memory usage may exceed this value.

When set to 0 (the default), there is no soft memory limit.

The cluster-level queryNodeQuota setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

The percentage of the node-quota that is dedicated to tracked value content memory across all active requests on this node. (The memory-quota setting specifies the maximum amount of document memory an individual request may use on this node.)

The cluster-level queryNodeQuotaValPercent setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

The number of CPUs the Query service can use on this node. Note that this setting requires a restart of the Query service to take effect.

When set to 0 (the default), the Query service can use all available CPUs, up to the limits described below.

The number of CPUs can never be greater than the number of logical CPUs. In Community Edition, the number of allowed CPUs cannot be greater than 4. In Enterprise Edition, there is no limit to the number of allowed CPUs.

The cluster-level queryNumCpus setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

Specifies the total number of active transaction records.

The cluster-level queryNumAtrs setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, the request-level numatrs parameter specifies this property per request. The minimum of that and the node-level numatrs setting is applied.

Controls the number of items execution operators can batch for Fetch from the KV.

The cluster-level queryPipelineBatch setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, the request-level pipeline_batch parameter specifies this property per request. The minimum of that and the node-level pipeline-batch setting is applied.

Maximum number of items each execution operator can buffer between various operators.

The cluster-level queryPipelineCap setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, the request-level pipeline_cap parameter specifies this property per request. The minimum of that and the node-level pipeline-cap setting is applied.

The number of service threads for transactions where the scan consistency is request_plus or at_plus. The default is 16 times the number of logical cores.

Maximum number of prepared statements in the cache. When this cache reaches the limit, the least recently used prepared statements will be discarded as new prepared statements are created.

The cluster-level queryPreparedLimit setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

Specifies whether query results are returned in pretty format.

The request-level pretty parameter specifies this property per request. If a request does not include this parameter, the node-level setting is used, which defaults to false.

Specifies if there should be a profile section returned with the request results. The valid values are:

• off — No profiling information is added to the query response.

• phases — The query response includes a profile section with stats and details about various phases of the query plan and execution. Three phase times will be included in the system:active_requests and system:completed_requests monitoring keyspaces.

• timings — Besides the phase times, the profile section of the query response document will include a full query plan with timing and information about the number of processed documents at each phase. This information will be included in the system:active_requests and system:completed_requests keyspaces.

NOTE: If profile is not set as one of the above values, then the profile setting does not change.

Refer to Monitoring and Profiling Details for more information and examples.

The request-level profile parameter specifies this property per request. If a request does not include this parameter, the node-level profile setting will be used.

Maximum size of a request.

Maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill.

Use 0 or a negative number to disable. Smaller values reduce GC, while larger values reduce indexer backfill.

The cluster-level queryScanCap setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, the request-level scan_cap parameter specifies this property per request. The minimum of that and the node-level scan-cap setting is applied.

The number of service threads for the query. The default is 4 times the number of cores on the query node.

Note that the overall node memory quota is this setting multiplied by the node-level memory-quota setting.

Maximum time to spend on the request before timing out (ns).

The value for this setting is an integer, representing a duration in nanoseconds. It must not be delimited by quotes, and must not include a unit.

Specify 0 (the default value) or a negative integer to disable. When disabled, no timeout is applied and the request runs for however long it takes.

The cluster-level queryTimeout setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, the request-level timeout parameter specifies this property per request. The minimum of that and the node-level timeout setting is applied.

Maximum time to spend on a transaction before timing out (ns). This setting only applies to requests containing the BEGIN TRANSACTION statement, or to requests where the tximplicit parameter is set. For all other requests, it is ignored.

The value for this setting is an integer, representing a duration in nanoseconds. It must not be delimited by quotes, and must not include a unit.

Specify 0 (the default value) to disable. When disabled, no timeout is applied and the transaction runs for however long it takes.

The cluster-level queryTxTimeout setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, the request-level txtimeout parameter specifies this property per request. The minimum of that and the node-level txtimeout setting is applied.

Specifies whether the cost-based optimizer is enabled.

The cluster-level queryUseCBO setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.

In addition, the request-level use_cbo parameter specifies this property per request. If a request does not include this parameter, the node-level setting is used, which defaults to true.

Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are:

• off — read from replica is disabled for all queries and cannot be overridden at request level.

• on — read from replica is enabled for all queries, but can be disabled at request level.

• unset — read from replica is enabled or disabled at request level.

The cluster-level queryUseReplica setting specifies the default for this property for the whole cluster. When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster.

In addition, the request-level use_replica parameter specifies this property per request. If a request does not include this parameter, or if the request-level parameter is unset, the node-level setting is used. If the request-level parameter and the node-level setting are both unset, read from replica is disabled for that request.

Do not enable read from replica when you require consistent results. Only SELECT queries that are not within a transaction can read from replica.

Reading from replica is only possible if the cluster uses Couchbase Server 7.6.0 or later.

Note that KV range scans cannot currently be started on a replica vBucket. If a query uses sequential scan and a data node becomes unavailable, the query might return an error, even if read from replica is enabled for the request.

The full prepared statement in encoded format.

This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

The name of the prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created.

The namespace in which the prepared statement is stored. Currently, only the default namespace is available.

The node on which the prepared statement is stored.

The text of the query.

The count of times the prepared statement has been executed.

The mean time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. It includes the time taken by the service to schedule the request.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

The mean amount of calendar time taken to complete the execution of the prepared statement.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

Date and time of last use.

This property is only returned when the prepared statement has been executed.

The maximum time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. It includes the time taken by the service to schedule the request.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

The maximum amount of calendar time taken to complete the execution of the prepared statement.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

The minimum time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. It includes the time taken by the service to schedule the request.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

The minimum amount of calendar time taken to complete the execution of the prepared statement.

This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements.

Total number of active requests.

Total number of query requests with at_plus index consistency.

The total number of audit records sent to the server. Some requests cause more than one audit record to be emitted. Records in the output queue that have not yet been sent to the server are not counted.

The total number of audit records sent to the server that failed.

The number of potentially auditable requests that cause no audit action to be taken.

The total number of potentially auditable requests sent to the query engine.

Total number of cancelled requests.

Total number of DELETE operations.

The total number of query errors returned so far.

Total number of secondary index scans.

Total number of INSERT operations.

Total number of requests for unsupported endpoints.

Total number of document mutations.

Total number of prepared statements executed.

Total number of primary index scans.

Total number of queued requests.

Total end-to-end time to process all queries (ns).

Number of query requests processed per second. 15-minute exponentially weighted moving average.

Number of query requests processed per second. 1-minute exponentially weighted moving average.

Number of query requests processed per second. 5-minute exponentially weighted moving average.

End-to-end time to process a query (ns). The 75th percentile.

End-to-end time to process a query (ns). The 95th percentile.

End-to-end time to process a query (ns). The 99th percentile.

End-to-end time to process a query (ns). The 99.9th percentile.

Total number of query requests.

End-to-end time to process a query (ns). The maximum value.

End-to-end time to process a query (ns). The mean value.

Number of query requests processed per second. Mean rate since the query service started.

End-to-end time to process a query (ns). The median value.

End-to-end time to process a query (ns). The minimum value.

End-to-end time to process a query (ns). The standard deviation.

Total number of query requests.

Number of queries that take longer than 1000ms.

Number of queries that take longer than 250ms.

Number of queries that take longer than 5000ms.

Number of queries that take longer than 500ms.

Total number of results (documents) returned by the query engine.

Total size of data returned by the query engine (bytes).

Total number of query requests with request_plus index consistency.

Total number of SELECT requests.

Time to execute all queries (ns).

Total number of query requests with not_bounded index consistency.

Total number of UPDATE requests.

The total number of query warnings returned so far.

The number of reads and retries for each bucket.

The uptime of the query engine.

The local time of the query engine.

The version of the query engine.

The number of active threads used by the query engine.

The maximum number of logical cores available to the query engine.

The total number of times FFDC has been invoked since the last restart.

The target heap size of the next garbage collection cycle.

The total time spent pausing for garbage collection since the query engine started (ns).

The percentage of time spent pausing for garbage collection since the last time the statistics were checked.

False when either the unbounded or plus request queues are full; true otherwise.

Amount of free memory on the host.

The host memory quota. This reflects the node-quota setting.

Total memory on the host.

This the total document memory quota on the node.

A calculation for how busy the server is.

The moving 15 minute average of the load calculation.

The amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, and decreases as objects are freed.

The cumulative amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, but does not decrease when objects are freed.

The total amount of memory obtained from the operating system (bytes). This measures the virtual address space reserved by the query engine for heaps, stacks, and other internal data structures.

The name or IP address and port of the node.

The total number of values allocated to contain documents or computations around documents. (This is only of relevance internally.)

The currently allocated document memory on the node.

CPU usage. The percentage of time spent executing user code since the last time the statistics were checked.

CPU usage. The percentage of time spent executing system code since the last time the statistics were checked.

Current process memory use.

Average CPU usage per core.

Process RSS (bytes)

The number of active servicers for the dominant workload — unbound queue servicers or plus queue servicers.

Total number of completed requests.

Total number of active requests.

Number of query requests processed per second. 1-minute exponentially weighted moving average.

Number of query requests processed per second. 5-minute exponentially weighted moving average.

Number of query requests processed per second. 15-minute exponentially weighted moving average.

Number of queued requests.

High water mark for request quota use.

End-to-end time to process a query. The mean value.

End-to-end time to process a query. The median value.

End-to-end time to process a query. The 80th percentile.

End-to-end time to process a query. The 95th percentile.

End-to-end time to process a query. The 99th percentile.

Percentage of requests that are prepared statements.

Number of servicers temporarily paused due to memory pressure. (Applies to serverless environments only.)

Number of times servicers have been temporarily paused. (Applies to serverless environments only.)

High water mark for temp space use directly by query. (Doesn't include use by the GSI and FTS clients.)

Current Query temp space use. (Doesn't include use by the GSI and FTS clients.)