Couchbase Data API (1.0.0)

The new expiry to set for the document, specified as an ISO8601 string.

The value to set the document to if the document does not exist.

The value to set the document to if the document does not exist.

Supplies the values for positional parameters in the statement. Applicable if the statement or prepared statement contains 1 or more positional parameters.

The value is an array of JSON values, one for each positional parameter in the statement.

Refer to Named Parameters and Positional Parameters for details.

Specifies the collection where the active transaction record (ATR) is stored. The collection must be present. If not specified, the ATR 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 ``.

Specifies that prepared statements should be executed automatically as soon as they are created. This saves you from having to make two separate requests in cases where you want to prepare a statement and execute it immediately.

Refer to Auto-Execute for more information.

A piece of data supplied by the client that is echoed in the response, if present. SQL++ is agnostic about the content of this parameter; it is just echoed in the response.

• Maximum allowed size is 64 characters; all others will be cut.
• If it contains an escape character / or quote ", it will be rejected as error code 1110.

Compression format to use for response data on the wire.

Values are case-insensitive.

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.

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

In the Data API, this parameter is ignored and has no effect.

The level of durability for mutations produced by the request.

If the request contains a BEGIN TRANSACTION statement, or a DML statement with the tximplicit parameter set to true, the durability level is specified for all mutations within that transaction.

Durability is also supported for non-transactional DML statements. In this case, the kvtimeout parameter is used as the durability timeout.

If not specified, the default durability level is "majority". Set the durability level to "none" or "" to specify no durability.

In Couchbase Server 6.5 and later, this parameter is ignored and has no effect. It is included for compatibility with previous versions of Couchbase Server.

Desired character encoding for the query results.

Only possible value is UTF-8 and is case-insensitive.

Desired format for the query results.

Values are case-insensitive.

The approximate time to wait for a KV get operation before timing out. This applies to statements within a transaction, and to non-transactional statements, whether durability_level is set or not.

If use_replica is enabled for a query, then this parameter also specifies the approximate time to wait before fetching data from a replica vBucket when the active vBucket is inaccessible.

The value for this parameter 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)

Specify a duration of 0 or a negative duration to disable. When disabled, no timeout is applied and the KV operation runs for however long it takes.

Specifies the maximum parallelism for the query.

The default value is the same as the number of partitions of the index selected for the query.

Specifies the maximum amount of memory the request may use, in MB.

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).

Specifies that metrics should be returned with query results.

Specifies the namespace to use. Currently, only the default namespace is available.

Specifies the total number of active transaction records. Must be a positive integer.

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

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

Required if statement not provided.

The name of the prepared SQL++ statement to be executed. Refer to EXECUTE for examples.

If both prepared and statement are present and non-empty, an error is returned.

Specifies whether documents should keep their current expiration setting when modified by a DML statement.

If true, documents will keep any existing expiration setting when modified by a DML statement. If the DML statement explicitly specifies the document expiration, the statement overrides this parameter, and the expiration is changed.

If false, document expiration is set to 0 when modified by a DML statement, unless the DML statement explicitly specifies the document expiration.

Not supported for statements in a transaction.

Specifies the query results returned in pretty format.

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.

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

Specifies the namespace, bucket, and scope used to resolve partial keyspace references within the request.

The query context may be a full path, containing namespace, bucket, and scope; or a relative path, containing just the bucket and scope. Currently, only the default namespace is available. If the namespace name is omitted, the default namespace in the current session is used.

Controls whether a query can change a resulting recordset.

If readonly is true, then the following statements are not allowed:

• CREATE INDEX
• DROP INDEX
• INSERT
• MERGE
• UPDATE
• UPSERT

When using GET requests, it's best to set readonly to true.

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.

Specifies the consistency guarantee or constraint for index scanning. The valid values are:

• not_bounded — No timestamp vector is used in the index scan. This is the fastest mode, because it avoids the costs of obtaining the vector and waiting for the index to catch up to the vector.

• at_plus — This implements bounded consistency. The request includes a scan_vector parameter and value, which is used as a lower bound. This can be used to implement read-your-own-writes (RYOW).

• request_plus — This implements strong consistency per request. Before processing the request, a current vector is obtained. The vector is used as a lower bound for the statements in the request. If there are DML statements in the request, RYOW is also applied within the request. (If request_plus is specified in a query that runs during a failover of an index node, the query waits until the rebalance operation completes and the index data has rebalanced before returning a result.)

• statement_plus — This implements strong consistency per statement. Before processing each statement, a current vector is obtained and used as a lower bound for that statement.

Values are case-insensitive.

For multi-statement requests, the default behavior is RYOW within each request. If you want to disable RYOW within a request, add a separate request_consistency parameter that can be set to not_bounded.

If the request contains a BEGIN TRANSACTION statement, or a DML statement with the tximplicit parameter set to true, then this parameter sets the transactional scan consistency. Refer to Transactional Scan Consistency for details.

Required if scan_consistency is at_plus and scan_vectors not provided.

Specify the lower bound vector timestamp for one keyspace when using at_plus scan consistency.

Scan vectors are built of two-element [value, guard] entries:

• value: a vBucket's sequence number (a JSON number)
• guard: a vBucket's UUID (a string)

Scan vectors have two forms:

1. Full: an array of [value, guard] entries, giving an entry for every vBucket in the system.
2. Sparse: an object providing entries for specific vBuckets, mapping a vBucket number (a string) to each [value, guard] entry.

Note that scan_vector can only be used if the query uses at most one keyspace; if it is used for a query referencing more than one keyspace, the query will fail with an error.

For queries referencing multiple keyspaces, use scan_vectors.

Required if scan_consistency is at_plus and scan_vector not provided.

A map from keyspace names to scan vectors. See scan_vector.

The scan vectors can be Full or Sparse.

Can be supplied with scan_consistency values of request_plus, statement_plus and at_plus.

Specifies the maximum time the client is willing to wait for an index to catch up to the vector timestamp in the request.

Specifies how much time the client is willing to wait for the indexer to satisfy the required scan_consistency and scan_vector criteria. After receiving the scan request, if the indexer is unable to catch up within the scan_wait time and initiate the scan, the indexer aborts with an error and the scan fails.

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)

Specify 0 or a negative integer to disable.

Include a header for the results schema in the response.

If true, causes statement projection terms to be sorted alphabetically.

If false (the default), statement projection terms are returned in the order specified by the query.

Required if prepared not provided.

Any valid SQL++ statement for a POST request, or a read-only SQL++ statement (SELECT, EXPLAIN) for a GET request.

If both prepared and statement are present and non-empty, an error is returned.

When specifying the request parameters as form data, the statement may not contain an unescaped semicolon (;). If it does, the Query Service responds with error 1040. To avoid this, either URL-encode the semicolon as %3B, or just omit the semicolon if possible.

This restriction does not apply when specifying the request parameters in JSON format.

Maximum time to spend on the request before timing out.

The value for this parameter 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)

Specify a duration of 0 or a negative duration to disable. When disabled, no timeout is applied and the request runs for however long it takes.

If tximplicit or txid is set, this parameter is ignored. The request inherits the remaining time of the transaction as timeout.

Transaction data. For internal use only.

Required for statements within a transaction.

Transaction ID. Specifies the transaction to which a statement belongs. For use with DML statements within a transaction, rollbacks, and commits.

The transaction ID should be the same as the transaction ID generated by the BEGIN TRANSACTION statement. The transaction must be active and non-expired.

Specifies that a DML statement is a singleton transaction.

When this parameter is true, the Query service starts a transaction and executes the statement. If execution is successful, the Query service commits the transaction; otherwise the transaction is rolled back.

The statement may not be part of an ongoing transaction. If the txid request-level parameter is set, the tximplicit parameter is ignored.

Transaction statement number. The transaction statement number must be a positive integer, and must be higher than any previous transaction statement numbers in the transaction. If the transaction statement number is lower than the transaction statement number for any previous statement, an error is generated.

Maximum time to spend on a transaction before timing out. Only applies to BEGIN TRANSACTION statements, or DML statements for which tximplicit is set. For other statements, it is ignored.

Within a transaction, the request-level timeout parameter is ignored. The transaction timeout clock starts when the BEGIN WORK statement is successful. Once the transaction timeout is reached, no statement is allowed to continue in the transaction.

The value for this parameter 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)

Specify a duration of 0 to disable. When disabled, the request-level timeout is set to the default.

The default is "15s" for cbq files or scripts, "2m" for interactive cbq sessions or redirected input.

Specifies whether the cost-based optimizer is enabled.

Specifies that the query should use a Search index.

If the query contains a USING FTS hint, that takes priority over this parameter.

If the query does not contain a USING FTS hint, and this parameter is set to true, all Search indexes are considered for the query. If a qualified Search index is available, it is selected for the query. If none of the available Search indexes are qualified, the available GSI indexes are considered instead.

Refer to Flex Indexes for more information.

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 this request.

• on — read from replica is enabled for this request, unless it has been disabled for all requests at node level.

• unset — read from replica is specified by the node-level setting. If the node-level setting is also unset, read from replica is disabled for this 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.

An object that contains the properties for one of the supported query types. For more information, see Query Object.

An array that contains objects that describe a Vector Search query. For more information, see Knn Objects.

An object that contains properties for query consistency. For more information, see Ctl Object.

Set the total number of results to return for a single page of search results.

Set an offset value to change where pagination starts for search results.

Contains properties to control search result highlighting. For more information, see Highlight Objects.

An array of strings to specify each indexed field you want to return in search results.

Contains nested objects to define each facet you want to return with search results. For more information, see Facet Objects.

Whether to create an explanation for a search result's score in search results.

Contains an array of strings or JSON objects to set how to sort search results. For more information, see Sort Object.

Whether to return the position of each occurrence of a search term inside a document.

Whether to include document relevancy scoring in search results.

Use to control pagination in search results.

Use to control pagination in search results.

The name of the Search index. For more information, see Initial Settings.

The type of the Search index. For more information, see Initial Settings.

The name of the bucket where the Search index is stored. For more information, see Initial Settings.

The UUID of the bucket where the Search index is stored. For more information, see Initial Settings.

Advanced settings for Search index behavior. For more information, see Initial Settings.

The type of the bucket where the Search index is stored. For more information, see Initial Settings.

The Search index's type identifier, type mappings, and analyzers. For more information, see Params Object.

The Search index's partitioning and replication settings. For more information, see Plan Params Object.

The UUID of the previous index. Intended for clients that want to check that they are not overwriting the Search index definition updates of concurrent clients.