diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index 5a689804..c5bfb933 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -2016,6 +2016,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -2080,6 +2081,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index 8a8672b4..61345e26 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -1238,6 +1238,7 @@ a¦ Any Type array a¦ + _additional + property_ a¦ diff --git a/docs/modules/fts-rest-advanced/pages/index.adoc b/docs/modules/fts-rest-advanced/pages/index.adoc index b0e179ed..8d0a64f8 100644 --- a/docs/modules/fts-rest-advanced/pages/index.adoc +++ b/docs/modules/fts-rest-advanced/pages/index.adoc @@ -1333,6 +1333,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ diff --git a/docs/modules/fts-rest-indexing/pages/index.adoc b/docs/modules/fts-rest-indexing/pages/index.adoc index c61074fa..ebd68375 100644 --- a/docs/modules/fts-rest-indexing/pages/index.adoc +++ b/docs/modules/fts-rest-indexing/pages/index.adoc @@ -5324,6 +5324,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -5986,6 +5987,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -6296,6 +6298,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -6825,6 +6828,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ diff --git a/docs/modules/fts-rest-nodes/pages/index.adoc b/docs/modules/fts-rest-nodes/pages/index.adoc index f5255fc9..69705b61 100644 --- a/docs/modules/fts-rest-nodes/pages/index.adoc +++ b/docs/modules/fts-rest-nodes/pages/index.adoc @@ -2702,6 +2702,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -3012,6 +3013,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -3306,6 +3308,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -3456,6 +3459,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -3561,6 +3565,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ diff --git a/docs/modules/fts-rest-query/pages/index.adoc b/docs/modules/fts-rest-query/pages/index.adoc index e00246a6..d01f7a1d 100644 --- a/docs/modules/fts-rest-query/pages/index.adoc +++ b/docs/modules/fts-rest-query/pages/index.adoc @@ -1058,6 +1058,7 @@ endif::model-descriptions[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc index 19925fb6..7e65e00f 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -1270,6 +1270,7 @@ endif::collapse-models[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ @@ -1326,6 +1327,7 @@ endif::collapse-models[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index db1a375e..9079ee3f 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -27,7 +27,6 @@ include::{specDir}overview/document-before.adoc[opts=optional] -- The Query Admin REST API is a secondary API provided by the Query service. This API enables you to retrieve statistics about the clusters and nodes running the Query service; view or specify node-level settings; and view or delete requests. - -- [discrete#version] @@ -178,7 +177,6 @@ DELETE /admin/active_requests/{request} [markdown] -- Terminates the specified active query request. - -- @@ -225,7 +223,6 @@ a¦ -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. - -- [%hardbreaks] @@ -381,7 +378,6 @@ Returns all active index requests. * Use [Retrieve an Active Request](#get_active_request) to get information about an active index request. * Use [Delete an Active Request](#delete_active_request) to terminate an active index request. - -- @@ -530,7 +526,6 @@ GET /admin/active_requests/{request} [markdown] -- Returns the specified active query request. - -- @@ -577,7 +572,6 @@ a¦ -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. - -- [%hardbreaks] @@ -724,7 +718,6 @@ GET /admin/active_requests [markdown] -- Returns all active query requests. - -- @@ -898,7 +891,6 @@ DELETE /admin/completed_requests/{request} [markdown] -- Purges the specified completed request. - -- @@ -945,7 +937,6 @@ a¦ -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. - -- [%hardbreaks] @@ -1101,7 +1092,6 @@ Returns all completed index requests. * Use [Retrieve a Completed Request](#get_completed_request) to get information about a completed index request. * Use [Delete a Completed Request](#delete_completed_request) to purge a completed index request. - -- @@ -1250,7 +1240,6 @@ GET /admin/completed_requests/{request} [markdown] -- Returns the specified completed request. - -- @@ -1297,7 +1286,6 @@ a¦ -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. - -- [%hardbreaks] @@ -1444,7 +1432,6 @@ GET /admin/completed_requests [markdown] -- Returns all completed requests. - -- @@ -2531,7 +2518,6 @@ GET /admin/gc Runs the garbage collector. A message is written to `query.log` whenever the garbage collector endpoint is invoked. - -- @@ -2587,7 +2573,7 @@ a| xref:Garbage[] | 401 a| [markdown] -- -Error 10000: authentication failure. The invoking user is not a valid full-admin user. +Error 10000: authentication failure. The invoking user is not a valid full-admin user. -- a| Object @@ -2819,7 +2805,6 @@ POST /admin/gc Run the garbage collector and attempts to return freed memory to the OS. A message is written to `query.log` whenever the garbage collector endpoint is invoked. - -- @@ -2875,7 +2860,7 @@ a| xref:Garbage[] | 401 a| [markdown] -- -Error 10000: authentication failure. The invoking user is not a valid full-admin user. +Error 10000: authentication failure. The invoking user is not a valid full-admin user. -- a| Object @@ -3001,7 +2986,6 @@ DELETE /admin/prepareds/{name} [markdown] -- Deletes the specified prepared statement. - -- @@ -3048,7 +3032,6 @@ a¦ -- The name of a prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. - -- [%hardbreaks] @@ -3201,7 +3184,6 @@ GET /admin/prepareds/{name} [markdown] -- Returns the specified prepared statement. - -- @@ -3248,7 +3230,6 @@ a¦ -- The name of a prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. - -- [%hardbreaks] @@ -3398,7 +3379,6 @@ Returns all prepared index statements. * Use [Retrieve a Prepared Statement](#get_prepared) to get information about a prepared index statement. * Use [Delete a Prepared Statement](#delete_prepared) to delete a prepared index statement. - -- @@ -3547,7 +3527,6 @@ GET /admin/prepareds [markdown] -- Returns all prepared statements. - -- @@ -3719,7 +3698,6 @@ GET /admin/settings [markdown] -- Returns node-level query settings. - -- @@ -3868,7 +3846,6 @@ POST /admin/settings [markdown] -- Updates node-level query settings. - -- @@ -4265,7 +4242,6 @@ a¦ The name of a statistic. Only top-level statistic names can be used. You cannot specify a metric. - -- [%hardbreaks] @@ -4312,7 +4288,7 @@ a¦ String | 200 a| [markdown] -- -An object containing all metrics for the specified statistic. Each statistic has a different set of metrics. +An object containing all metrics for the specified statistic. Each statistic has a different set of metrics. -- a| xref:Metrics[] @@ -4460,7 +4436,7 @@ Returns all statistics. | 200 a| [markdown] -- -An object containing all statistics. Each statistic consists of a top-level statistic name and a metric name. Each statistic has a different set of metrics. +An object containing all statistics. Each statistic consists of a top-level statistic name and a metric name. Each statistic has a different set of metrics. -- a| xref:Statistics[] @@ -4562,7 +4538,6 @@ GET /admin/vitals -- Returns data about the running state and health of the query engine. This information can be very useful to assess the current workload and performance characteristics of a query engine, and hence load-balance the requests being sent to various query engines. - -- @@ -4889,7 +4864,6 @@ a¦ -- Only returned by the POST method. The amount of memory released to the OS. - -- [%hardbreaks] @@ -4955,8 +4929,7 @@ All completed requests that match these parameters are tracked in the completed Refer to [Configure Completed Requests][sys-completed-config] for more information and examples. -[sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config - +[sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config //end::desc-Logging_Parameters[] endif::model-descriptions[] @@ -4990,7 +4963,6 @@ a¦ -- The IP address of the client. If specified, all completed requests from this IP address are logged. - -- [%hardbreaks] @@ -5010,7 +4982,6 @@ a¦ ifdef::alt-markdown-links[] [client_context_id]: #client_context_id - endif::alt-markdown-links[] The opaque ID or context provided by the client. If specified, all completed requests with this client context ID are logged. @@ -5018,7 +4989,6 @@ If specified, all completed requests with this client context ID are logged. Refer to the [request-level][client_context_id] `client_context_id` parameter for more information. [client_context_id]: ../n1ql-rest-query/index.html#client_context_id - -- [%hardbreaks] @@ -5035,7 +5005,6 @@ a¦ -- An error number. If specified, all completed queries returning this error number are logged. - -- [%hardbreaks] @@ -5056,8 +5025,7 @@ A unique string which tags a set of qualifiers. Refer to [Configure Completed Requests][sys-completed-config] for more information. -[sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config - +[sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config -- [%hardbreaks] @@ -5077,8 +5045,7 @@ a¦ 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) `completed-threshold` setting. - +This is another way of specifying the `completed-threshold` setting. -- [%hardbreaks] @@ -5097,7 +5064,6 @@ a¦ -- A user name, as given in the request credentials. If specified, all completed queries with this user name are logged. - -- [%hardbreaks] @@ -5117,7 +5083,6 @@ a¦ The number of errors. If specified, all completed queries that return at least this many errors are logged. Queries with fewer errors are not logged. - -- [%hardbreaks] @@ -5573,13 +5538,12 @@ a¦ ifdef::alt-markdown-links[] [client_context_id]: #client_context_id - endif::alt-markdown-links[] The opaque ID or context provided by the client. + Refer to the [request-level][client_context_id] `client_context_id` parameter for more information. [client_context_id]: ../n1ql-rest-query/index.html#client_context_id - -- [%hardbreaks] @@ -5596,7 +5560,6 @@ a¦ -- 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. - -- [%hardbreaks] @@ -5628,7 +5591,6 @@ a¦ -- The memory quota for the request, in MB. This property is only returned if a memory quota is set for the query. - -- [%hardbreaks] @@ -5662,7 +5624,6 @@ Count of documents processed at selective phases involved in the query execution 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. - -- [%hardbreaks] @@ -5683,7 +5644,6 @@ Indicates the numbers of each kind of query operator involved in different phase 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. - -- [%hardbreaks] @@ -5703,7 +5663,6 @@ Cumulative execution times for various phases involved in the query execution, s 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. - -- [%hardbreaks] @@ -5830,7 +5789,6 @@ Note that the `completed` state means that the request was started and completed 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`. - -- [%hardbreaks] @@ -5877,7 +5835,6 @@ a¦ -- The amount of document memory used to execute the request. This property is only returned if a memory quota is set for the query. - -- [%hardbreaks] @@ -5966,7 +5923,6 @@ a¦ ifdef::alt-markdown-links[] [atrcollection_req]: #atrcollection_req - endif::alt-markdown-links[] Specifies the collection where [active transaction records][additional-storage-use] are stored. The collection must be present. @@ -5975,12 +5931,12 @@ If not specified, the active transaction record is stored in the default collect 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 ``. +[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + The [request-level][atrcollection_req] `atrcollection` parameter specifies this property per request. If a request does not include this parameter, the node-level `atrcollection` setting will be used. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [atrcollection_req]: ../n1ql-rest-query/index.html#atrcollection_req - -- [%hardbreaks] @@ -6002,7 +5958,6 @@ Specifies whether the query engine should create a prepared statement every time Refer to [Auto-Prepare][auto-prepare] for more information. [auto-prepare]: /server/7.6/n1ql/n1ql-language-reference/prepare.html#auto-prepare - -- [%hardbreaks] @@ -6022,7 +5977,6 @@ a¦ ifdef::alt-markdown-links[] [queryCleanupClientAttempts]: #queryCleanupClientAttempts - endif::alt-markdown-links[] 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. @@ -6030,7 +5984,6 @@ The [cluster-level][queryCleanupClientAttempts] `queryCleanupClientAttempts` set When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryCleanupClientAttempts]: ../n1ql-rest-settings/index.html#queryCleanupClientAttempts - -- [%hardbreaks] @@ -6050,7 +6003,6 @@ a¦ ifdef::alt-markdown-links[] [queryCleanupLostAttempts]: #queryCleanupLostAttempts - endif::alt-markdown-links[] When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client. @@ -6058,7 +6010,6 @@ The [cluster-level][queryCleanupLostAttempts] `queryCleanupLostAttempts` setting When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryCleanupLostAttempts]: ../n1ql-rest-settings/index.html#queryCleanupLostAttempts - -- [%hardbreaks] @@ -6078,7 +6029,6 @@ a¦ ifdef::alt-markdown-links[] [queryCleanupWindow]: #queryCleanupWindow - endif::alt-markdown-links[] Specifies how frequently the Query service checks its subset of [active transaction records][additional-storage-use] 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. @@ -6094,12 +6044,12 @@ Valid units are: * `m` (minutes) * `h` (hours) +[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + The [cluster-level][queryCleanupWindow] `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. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [queryCleanupWindow]: ../n1ql-rest-settings/index.html#queryCleanupWindow - -- [%hardbreaks] @@ -6134,7 +6084,6 @@ a¦ ifdef::alt-markdown-links[] [queryCompletedLimit]: #queryCompletedLimit - endif::alt-markdown-links[] Sets the number of requests to be logged in the completed requests catalog. As new completed requests are added, old ones are removed. @@ -6143,12 +6092,12 @@ Increase this when the completed request keyspace is not big enough to track the Refer to [Configure Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + The [cluster-level][queryCompletedLimit] `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. -[sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [queryCompletedLimit]: ../n1ql-rest-settings/index.html#queryCompletedLimit - -- [%hardbreaks] @@ -6168,7 +6117,6 @@ a¦ ifdef::alt-markdown-links[] [queryCompletedMaxPlanSize]: #queryCompletedMaxPlanSize - endif::alt-markdown-links[] A plan size in bytes. Limits the size of query execution plans that can be logged in the completed requests catalog. @@ -6178,12 +6126,12 @@ You must obtain execution plans for such queries via profiling or using the EXPL Refer to [Configure Completed Requests][sys-completed-config] for more information. +[sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + The [cluster-level][queryCompletedMaxPlanSize] `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. -[sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [queryCompletedMaxPlanSize]: ../n1ql-rest-settings/index.html#queryCompletedMaxPlanSize - -- [%hardbreaks] @@ -6212,8 +6160,7 @@ Completed request streaming is available in Couchbase Server 7.6.4 and later. Refer to [Stream Completed Requests][sys-history] for more information and examples. -[sys-history]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-history - +[sys-history]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-history -- [%hardbreaks] @@ -6231,7 +6178,6 @@ a¦ ifdef::alt-markdown-links[] [queryCompletedThreshold]: #queryCompletedThreshold - endif::alt-markdown-links[] A duration in milliseconds. All completed queries lasting longer than this threshold are logged in the completed requests catalog. @@ -6241,12 +6187,12 @@ Specify any negative number to track none. Refer to [Configure Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + The [cluster-level][queryCompletedThreshold] `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. -[sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [queryCompletedThreshold]: ../n1ql-rest-settings/index.html#queryCompletedThreshold - -- [%hardbreaks] @@ -6266,7 +6212,6 @@ a¦ ifdef::alt-markdown-links[] [controls_req]: #controls_req - endif::alt-markdown-links[] Specifies if there should be a controls section returned with the request results. @@ -6278,7 +6223,6 @@ The [request-level][controls_req] `controls` parameter specifies this property p If a request does not include this parameter, the node-level `controls` setting will be used. [controls_req]: ../n1ql-rest-query/index.html#controls_req - -- [%hardbreaks] @@ -6302,7 +6246,6 @@ The output file includes a controls section and performance measurements, such a 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 `""`. - -- [%hardbreaks] @@ -6322,7 +6265,6 @@ a¦ Use debug mode. When set to `true`, extra logging is provided. - -- [%hardbreaks] @@ -6342,7 +6284,6 @@ a¦ 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. - -- [%hardbreaks] @@ -6395,7 +6336,6 @@ a¦ ifdef::alt-markdown-links[] [queryLogLevel]: #queryLogLevel - endif::alt-markdown-links[] Log level used in the logger. @@ -6425,7 +6365,6 @@ The [cluster-level][queryLogLevel] `queryLogLevel` setting specifies this proper When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryLogLevel]: ../n1ql-rest-settings/index.html#queryLogLevel - -- [%hardbreaks] @@ -6445,7 +6384,6 @@ a¦ -- Max index API. This setting is provided for technical support only. - -- [%hardbreaks] @@ -6464,7 +6402,6 @@ ifdef::alt-markdown-links[] [queryMaxParallelism]: #queryMaxParallelism [max_parallelism_req]: #max_parallelism_req - endif::alt-markdown-links[] Specifies the maximum parallelism for queries on this node. @@ -6474,6 +6411,9 @@ Similarly, if the value is greater than the number of allowed cores, the maximum (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.) +Refer to [Max Parallelism][max-parallelism] for more information. + +[max-parallelism]: /server/7.6/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism The [cluster-level][queryMaxParallelism] `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. @@ -6483,12 +6423,8 @@ If a request includes this parameter, it will be capped by the node-level `max-p 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][max-parallelism] for more information. - -[max-parallelism]: /server/7.6/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism [queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism [max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req - -- [%hardbreaks] @@ -6509,7 +6445,6 @@ ifdef::alt-markdown-links[] [queryMemoryQuota]: #queryMemoryQuota [memory_quota_req]: #memory_quota_req - endif::alt-markdown-links[] Specifies the maximum amount of memory a request may use on this node, in MB. @@ -6530,7 +6465,6 @@ If a request includes this parameter, it will be capped by the node-level `memor [queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota [memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req - -- [%hardbreaks] @@ -6552,7 +6486,6 @@ 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 `""`. - -- [%hardbreaks] @@ -6571,7 +6504,6 @@ a¦ -- Mutex profile. This setting is provided for technical support only. - -- [%hardbreaks] @@ -6590,7 +6522,6 @@ a¦ ifdef::alt-markdown-links[] [queryN1QLFeatCtrl]: #queryN1QLFeatCtrl - endif::alt-markdown-links[] SQL++ feature control. This setting is provided for technical support only. @@ -6600,7 +6531,6 @@ The [cluster-level][queryN1QLFeatCtrl] `queryN1QLFeatCtrl` setting specifies thi When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryN1QLFeatCtrl]: ../n1ql-rest-settings/index.html#queryN1QLFeatCtrl - -- [%hardbreaks] @@ -6620,7 +6550,6 @@ a¦ ifdef::alt-markdown-links[] [queryNodeQuota]: #queryNodeQuota - endif::alt-markdown-links[] Sets the soft memory limit for the Query service on this node, in MB. The garbage collector tries to keep below this target. @@ -6639,7 +6568,6 @@ The [cluster-level][queryNodeQuota] `queryNodeQuota` setting specifies this prop When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryNodeQuota]: ../n1ql-rest-settings/index.html#queryNodeQuota - -- [%hardbreaks] @@ -6658,7 +6586,6 @@ a¦ ifdef::alt-markdown-links[] [queryNodeQuotaValPercent]: #queryNodeQuotaValPercent - endif::alt-markdown-links[] 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.) @@ -6667,7 +6594,6 @@ The [cluster-level][queryNodeQuotaValPercent] `queryNodeQuotaValPercent` setting When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryNodeQuotaValPercent]: ../n1ql-rest-settings/index.html#queryNodeQuotaValPercent - -- [%hardbreaks] @@ -6688,7 +6614,6 @@ a¦ ifdef::alt-markdown-links[] [queryNumCpus]: #queryNumCpus - endif::alt-markdown-links[] 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. @@ -6703,7 +6628,6 @@ The [cluster-level][queryNumCpus] `queryNumCpus` setting specifies this property When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryNumCpus]: ../n1ql-rest-settings/index.html#queryNumCpus - -- [%hardbreaks] @@ -6723,20 +6647,19 @@ ifdef::alt-markdown-links[] [queryNumAtrs]: #queryNumAtrs [numatrs_req]: #numatrs_req - endif::alt-markdown-links[] Specifies the total number of [active transaction records][additional-storage-use]. +[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + The [cluster-level][queryNumAtrs] `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_req] `numatrs` parameter specifies this property per request. The minimum of that and the node-level `numatrs` setting is applied. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs [numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req - -- [%hardbreaks] @@ -6755,7 +6678,6 @@ ifdef::alt-markdown-links[] [queryPipelineBatch]: #queryPipelineBatch [pipeline_batch_req]: #pipeline_batch_req - endif::alt-markdown-links[] Controls the number of items execution operators can batch for Fetch from the KV. @@ -6767,7 +6689,6 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. [queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch [pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req - -- [%hardbreaks] @@ -6788,7 +6709,6 @@ ifdef::alt-markdown-links[] [queryPipelineCap]: #queryPipelineCap [pipeline_cap_req]: #pipeline_cap_req - endif::alt-markdown-links[] Maximum number of items each execution operator can buffer between various operators. @@ -6800,7 +6720,6 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. [queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap [pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req - -- [%hardbreaks] @@ -6819,7 +6738,6 @@ a¦ -- 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. - -- [%hardbreaks] @@ -6838,7 +6756,6 @@ a¦ ifdef::alt-markdown-links[] [queryPreparedLimit]: #queryPreparedLimit - endif::alt-markdown-links[] 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. @@ -6847,7 +6764,6 @@ The [cluster-level][queryPreparedLimit] `queryPreparedLimit` setting specifies t When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryPreparedLimit]: ../n1ql-rest-settings/index.html#queryPreparedLimit - -- [%hardbreaks] @@ -6867,7 +6783,6 @@ a¦ ifdef::alt-markdown-links[] [pretty_req]: #pretty_req - endif::alt-markdown-links[] Specifies whether query results are returned in pretty format. @@ -6875,7 +6790,6 @@ The [request-level][pretty_req] `pretty` parameter specifies this property per r If a request does not include this parameter, the node-level setting is used, which defaults to `false`. [pretty_req]: ../n1ql-rest-query/index.html#pretty_req - -- [%hardbreaks] @@ -6895,7 +6809,6 @@ a¦ ifdef::alt-markdown-links[] [profile_req]: #profile_req - endif::alt-markdown-links[] Specifies if there should be a profile section returned with the request results. The valid values are: @@ -6912,12 +6825,12 @@ NOTE: If `profile` is not set as one of the above values, then the profile setti Refer to [Monitoring and Profiling Details][monitor-profile-details] for more information and examples. +[monitor-profile-details]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#monitor-profile-details + The [request-level][profile_req] `profile` parameter specifies this property per request. If a request does not include this parameter, the node-level `profile` setting will be used. -[monitor-profile-details]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#monitor-profile-details [profile_req]: ../n1ql-rest-query/index.html#profile_req - -- [%hardbreaks] @@ -6956,7 +6869,6 @@ ifdef::alt-markdown-links[] [queryScanCap]: #queryScanCap [scan_cap_req]: #scan_cap_req - endif::alt-markdown-links[] Maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill. @@ -6972,7 +6884,6 @@ The minimum of that and the node-level `scan-cap` setting is applied. [queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap [scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req - -- [%hardbreaks] @@ -6991,7 +6902,6 @@ a¦ -- The number of service threads for the query. The default is 4 times the number of cores on the query node. - -- [%hardbreaks] @@ -7012,7 +6922,6 @@ ifdef::alt-markdown-links[] [queryTimeout]: #queryTimeout [timeout_req]: #timeout_req - endif::alt-markdown-links[] Maximum time to spend on the request before timing out (ns). @@ -7030,7 +6939,6 @@ The minimum of that and the node-level `timeout` setting is applied. [queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout [timeout_req]: ../n1ql-rest-query/index.html#timeout_req - -- [%hardbreaks] @@ -7052,7 +6960,6 @@ ifdef::alt-markdown-links[] [queryTxTimeout]: #queryTxTimeout [txtimeout_req]: #txtimeout_req - endif::alt-markdown-links[] 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][tximplicit] parameter is set. @@ -7064,16 +6971,16 @@ 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. +[tximplicit]: ../n1ql-rest-query/index.html#tximplicit + The [cluster-level][queryTxTimeout] `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_req] `txtimeout` parameter specifies this property per request. The minimum of that and the node-level `txtimeout` setting is applied. -[tximplicit]: ../n1ql-rest-query/index.html#tximplicit [queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout [txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req - -- [%hardbreaks] @@ -7094,7 +7001,6 @@ ifdef::alt-markdown-links[] [queryUseCBO]: #queryUseCBO [use_cbo_req]: #use_cbo_req - endif::alt-markdown-links[] Specifies whether the cost-based optimizer is enabled. @@ -7106,7 +7012,6 @@ If a request does not include this parameter, the node-level setting is used, wh [queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO [use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req - -- [%hardbreaks] @@ -7127,7 +7032,6 @@ ifdef::alt-markdown-links[] [queryUseReplica]: #queryUseReplica [use_replica_req]: #use_replica_req - endif::alt-markdown-links[] Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -7138,13 +7042,6 @@ The possible values are: * `unset` — read from replica is enabled or disabled at request level. -The [cluster-level][queryUseReplica] `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_req] `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. @@ -7153,9 +7050,15 @@ Reading from replica is only possible if the cluster uses Couchbase Server 7.6.0 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 [cluster-level][queryUseReplica] `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_req] `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. + [queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica [use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req - -- [%hardbreaks] @@ -7231,7 +7134,6 @@ a¦ -- This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] @@ -7248,7 +7150,6 @@ a¦ -- This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] @@ -7265,7 +7166,6 @@ a¦ -- 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. - -- [%hardbreaks] @@ -7282,7 +7182,6 @@ a¦ -- The namespace in which the prepared statement is stored. Currently, only the `default` namespace is available. - -- [%hardbreaks] @@ -7298,7 +7197,6 @@ a¦ [markdown] -- The node on which the prepared statement is stored. - -- [%hardbreaks] @@ -7348,7 +7246,6 @@ 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. - -- [%hardbreaks] @@ -7367,7 +7264,6 @@ The mean amount of calendar time taken to complete the execution of the prepared 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. - -- [%hardbreaks] @@ -7385,7 +7281,6 @@ a¦ Date and time of last use. This property is only returned when the prepared statement has been executed. - -- [%hardbreaks] @@ -7405,7 +7300,6 @@ 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. - -- [%hardbreaks] @@ -7424,7 +7318,6 @@ The maximum amount of calendar time taken to complete the execution of the prepa 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. - -- [%hardbreaks] @@ -7444,7 +7337,6 @@ 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. - -- [%hardbreaks] @@ -7463,7 +7355,6 @@ The minimum amount of calendar time taken to complete the execution of the prepa 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. - -- [%hardbreaks] @@ -7552,7 +7443,6 @@ a¦ 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. - -- [%hardbreaks] @@ -7779,7 +7669,6 @@ a¦ -- Number of query requests processed per second. 15-minute exponentially weighted moving average. - -- [%hardbreaks] @@ -7796,7 +7685,6 @@ a¦ -- Number of query requests processed per second. 1-minute exponentially weighted moving average. - -- [%hardbreaks] @@ -7813,7 +7701,6 @@ a¦ -- Number of query requests processed per second. 5-minute exponentially weighted moving average. - -- [%hardbreaks] @@ -7830,7 +7717,6 @@ a¦ -- End-to-end time to process a query (ns). The 75th percentile. - -- [%hardbreaks] @@ -7847,7 +7733,6 @@ a¦ -- End-to-end time to process a query (ns). The 95th percentile. - -- [%hardbreaks] @@ -7864,7 +7749,6 @@ a¦ -- End-to-end time to process a query (ns). The 99th percentile. - -- [%hardbreaks] @@ -7881,7 +7765,6 @@ a¦ -- End-to-end time to process a query (ns). The 99.9th percentile. - -- [%hardbreaks] @@ -7913,7 +7796,6 @@ a¦ -- End-to-end time to process a query (ns). The maximum value. - -- [%hardbreaks] @@ -7930,7 +7812,6 @@ a¦ -- End-to-end time to process a query (ns). The mean value. - -- [%hardbreaks] @@ -7947,7 +7828,6 @@ a¦ -- Number of query requests processed per second. Mean rate since the query service started. - -- [%hardbreaks] @@ -7964,7 +7844,6 @@ a¦ -- End-to-end time to process a query (ns). The median value. - -- [%hardbreaks] @@ -7981,7 +7860,6 @@ a¦ -- End-to-end time to process a query (ns). The minimum value. - -- [%hardbreaks] @@ -7998,7 +7876,6 @@ a¦ -- End-to-end time to process a query (ns). The standard deviation. - -- [%hardbreaks] @@ -8431,7 +8308,6 @@ a¦ -- The host memory quota. This reflects the node-quota setting. - -- [%hardbreaks] @@ -8508,7 +8384,6 @@ a¦ -- The amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, and decreases as objects are freed. - -- [%hardbreaks] @@ -8525,7 +8400,6 @@ a¦ -- 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. - -- [%hardbreaks] @@ -8542,7 +8416,6 @@ a¦ -- 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. - -- [%hardbreaks] @@ -8574,7 +8447,6 @@ a¦ -- The total number of values allocated to contain documents or computations around documents. (This is only of relevance internally.) - -- [%hardbreaks] @@ -8606,7 +8478,6 @@ a¦ -- CPU usage. The percentage of time spent executing user code since the last time the statistics were checked. - -- [%hardbreaks] @@ -8623,7 +8494,6 @@ a¦ -- CPU usage. The percentage of time spent executing system code since the last time the statistics were checked. - -- [%hardbreaks] @@ -8730,7 +8600,6 @@ a¦ -- Number of query requests processed per second. 1-minute exponentially weighted moving average. - -- [%hardbreaks] @@ -8747,7 +8616,6 @@ a¦ -- Number of query requests processed per second. 5-minute exponentially weighted moving average. - -- [%hardbreaks] @@ -8764,7 +8632,6 @@ a¦ -- Number of query requests processed per second. 15-minute exponentially weighted moving average. - -- [%hardbreaks] @@ -8811,7 +8678,6 @@ a¦ -- End-to-end time to process a query. The mean value. - -- [%hardbreaks] @@ -8828,7 +8694,6 @@ a¦ -- End-to-end time to process a query. The median value. - -- [%hardbreaks] @@ -8845,7 +8710,6 @@ a¦ -- End-to-end time to process a query. The 80th percentile. - -- [%hardbreaks] @@ -8862,7 +8726,6 @@ a¦ -- End-to-end time to process a query. The 95th percentile. - -- [%hardbreaks] @@ -8879,7 +8742,6 @@ a¦ -- End-to-end time to process a query. The 99th percentile. - -- [%hardbreaks] @@ -8911,7 +8773,6 @@ a¦ -- Number of servicers temporarily paused due to memory pressure. (Applies to serverless environments only.) - -- [%hardbreaks] @@ -8928,7 +8789,6 @@ a¦ -- Number of times servicers have been temporarily paused. (Applies to serverless environments only.) - -- [%hardbreaks] @@ -8945,7 +8805,6 @@ a¦ -- High water mark for temp space use directly by query. (Doesn't include use by the GSI and Search clients.) - -- [%hardbreaks] @@ -8962,7 +8821,6 @@ a¦ -- Current Query temp space use. (Doesn't include use by the GSI and Search clients.) - -- [%hardbreaks] @@ -9024,7 +8882,6 @@ a¦ Integer -- The Admin API supports admin credentials. Credentials can be passed via HTTP headers (HTTP basic authentication). - -- [%hardbreaks] diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index 38bfdc8a..d656e675 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -1203,6 +1203,7 @@ endif::collapse-models[] ¦ Property ¦ ¦ Schema a¦ + _additional + property_ a¦ diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc index ab593b21..3ca2ac08 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -27,7 +27,6 @@ include::{specDir}overview/document-before.adoc[opts=optional] -- The Query Service REST API is provided by the Query service. This API enables you to run SQL++ queries and set request-level parameters. - -- [discrete#version] @@ -806,7 +805,6 @@ One of the following SQL++ severity levels, listed in order of severity: 2. Error 3. Warn 4. Info - -- [%hardbreaks] @@ -1054,7 +1052,6 @@ ifdef::model-descriptions[] Present only if `profile` was set to `"timings"` in the [Request Parameters](#Request). The execution details for various phases involved in the query execution, such as kernel and service execution times, number of documents processed at each query operator in each phase, and number of phase switches. - //end::desc-Execution_Timings[] endif::model-descriptions[] @@ -1378,7 +1375,6 @@ a¦ [markdown] -- Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. - -- [%hardbreaks] @@ -1401,7 +1397,6 @@ 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. This is in essence the count of all the operators in the `executionTimings` object. - -- [%hardbreaks] @@ -1418,7 +1413,6 @@ a¦ [markdown] -- Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. - -- [%hardbreaks] @@ -1498,7 +1492,6 @@ The value is an array of JSON values, one for each positional parameter in the s Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for details. [section_srh_tlm_n1b]: /server/7.6/n1ql/n1ql-manage/query-settings.html#section_srh_tlm_n1b - -- [%hardbreaks] @@ -1517,7 +1510,6 @@ a¦ ifdef::alt-markdown-links[] [atrcollection-srv]: #atrcollection-srv - endif::alt-markdown-links[] Specifies the collection where the [active transaction record][additional-storage-use] (ATR) is stored. The collection must be present. @@ -1526,12 +1518,12 @@ If not specified, the ATR is stored in the default collection in the default sco 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 ``. +[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + The [node-level][atrcollection-srv] `atrcollection` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [atrcollection-srv]: ../n1ql-rest-admin/index.html#atrcollection-srv - -- [%hardbreaks] @@ -1553,7 +1545,6 @@ This saves you from having to make two separate requests in cases where you want Refer to [Auto-Execute][auto-execute] for more information. [auto-execute]: /server/7.6/n1ql/n1ql-language-reference/prepare.html#auto-execute - -- [%hardbreaks] @@ -1575,7 +1566,6 @@ SQL++ is agnostic about the content of this parameter; it is just echoed in the * 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. - -- [%hardbreaks] @@ -1593,7 +1583,6 @@ a¦ Compression format to use for response data on the wire. Values are case-insensitive. - -- [%hardbreaks] @@ -1614,7 +1603,6 @@ a¦ ifdef::alt-markdown-links[] [controls-srv]: #controls-srv - endif::alt-markdown-links[] Specifies if there should be a controls section returned with the request results. @@ -1626,7 +1614,6 @@ The [node-level][controls-srv] `controls` setting specifies the default for this The request-level parameter overrides the node-level setting. [controls-srv]: ../n1ql-rest-admin/index.html#controls-srv - -- [%hardbreaks] @@ -1649,7 +1636,6 @@ The format is an identity and password. You can specify credentials for multiple identities. If credentials are supplied in the request header, then HTTP Basic Authentication takes precedence and `creds` is ignored. - -- [%hardbreaks] @@ -1667,7 +1653,7 @@ a¦ -- The level of [durability][durability] for mutations produced by the request. -If the request contains a `BEGIN TRANSACTION` statement, or a DML statement with the [tximplicit](#tximplicit) parameter set to `true`, the durability level is specified for all mutations within that transaction. +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. @@ -1676,7 +1662,6 @@ If not specified, the default durability level is `"majority"`. Set the durability level to `"none"` or `""` to specify no durability. [durability]: /server/7.6/learn/data/durability.html - -- [%hardbreaks] @@ -1696,7 +1681,6 @@ a¦ -- 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. - -- [%hardbreaks] @@ -1714,7 +1698,6 @@ a¦ Desired character encoding for the query results. Only possible value is `UTF-8` and is case-insensitive. - -- [%hardbreaks] @@ -1733,7 +1716,6 @@ a¦ Desired format for the query results. Values are case-insensitive. - -- [%hardbreaks] @@ -1769,7 +1751,6 @@ Valid units are: 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. - -- [%hardbreaks] @@ -1790,10 +1771,11 @@ ifdef::alt-markdown-links[] [max-parallelism-srv]: #max-parallelism-srv [queryMaxParallelism]: #queryMaxParallelism - endif::alt-markdown-links[] 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. + The [node-level][max-parallelism-srv] `max-parallelism` setting specifies the ceiling for this parameter for a single node. If the request-level parameter is zero or negative, the parallelism for the query is set to the node-level setting. If the request-level parameter is greater than zero and less than the node-level setting, the request-level parameter overrides the node-level setting. @@ -1804,11 +1786,8 @@ When you change the cluster-level setting, the node-level setting is overwritten 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. -The default value is the same as the number of partitions of the index selected for the query. - [max-parallelism-srv]: ../n1ql-rest-admin/index.html#max-parallelism-srv [queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism - -- [%hardbreaks] @@ -1828,7 +1807,6 @@ ifdef::alt-markdown-links[] [memory-quota-srv]: #memory-quota-srv [queryMemoryQuota]: #queryMemoryQuota - endif::alt-markdown-links[] Specifies the maximum amount of memory the request may use, in MB. @@ -1850,7 +1828,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [memory-quota-srv]: ../n1ql-rest-admin/index.html#memory-quota-srv [queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota - -- [%hardbreaks] @@ -1905,21 +1882,20 @@ ifdef::alt-markdown-links[] [numatrs-srv]: #numatrs-srv [queryNumAtrs]: #queryNumAtrs - endif::alt-markdown-links[] Specifies the total number of [active transaction records][additional-storage-use]. Must be a positive integer. +[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + The [node-level][numatrs-srv] `numatrs` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. In addition, the [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies the default for this parameter for the whole cluster. When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv [queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs - -- [%hardbreaks] @@ -1940,7 +1916,6 @@ ifdef::alt-markdown-links[] [pipeline-batch-srv]: #pipeline-batch-srv [queryPipelineBatch]: #queryPipelineBatch - endif::alt-markdown-links[] Controls the number of items execution operators can batch for Fetch from the KV. @@ -1952,7 +1927,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [pipeline-batch-srv]: ../n1ql-rest-admin/index.html#pipeline-batch-srv [queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch - -- [%hardbreaks] @@ -1972,7 +1946,6 @@ ifdef::alt-markdown-links[] [pipeline-cap-srv]: #pipeline-cap-srv [queryPipelineCap]: #queryPipelineCap - endif::alt-markdown-links[] Maximum number of items each execution operator can buffer between various operators. @@ -1984,7 +1957,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [pipeline-cap-srv]: ../n1ql-rest-admin/index.html#pipeline-cap-srv [queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap - -- [%hardbreaks] @@ -2008,7 +1980,6 @@ Refer to [EXECUTE][execute] for examples. If both `prepared` and `statement` are present and non-empty, an error is returned. [execute]: /server/7.6/n1ql/n1ql-language-reference/execute.html - -- [%hardbreaks] @@ -2032,7 +2003,6 @@ If the DML statement explicitly specifies the document expiration, the statement 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. - -- [%hardbreaks] @@ -2052,7 +2022,6 @@ a¦ ifdef::alt-markdown-links[] [pretty-srv]: #pretty-srv - endif::alt-markdown-links[] Specifies the query results returned in pretty format. @@ -2060,7 +2029,6 @@ The [node-level][pretty-srv] `pretty` setting specifies the default for this par The request-level parameter overrides the node-level setting. [pretty-srv]: ../n1ql-rest-admin/index.html#pretty-srv - -- [%hardbreaks] @@ -2079,7 +2047,6 @@ a¦ ifdef::alt-markdown-links[] [profile-srv]: #profile-srv - endif::alt-markdown-links[] Specifies if there should be a profile section returned with the request results. The valid values are: @@ -2100,7 +2067,6 @@ The [node-level][profile-srv] `profile` setting specifies the default for this p The request-level parameter overrides the node-level setting. [profile-srv]: ../n1ql-rest-admin/index.html#profile-srv - -- [%hardbreaks] @@ -2122,7 +2088,6 @@ Specifies the namespace, bucket, and scope used to resolve partial keyspace refe 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. - -- [%hardbreaks] @@ -2151,7 +2116,6 @@ If `readonly` is `true`, then the following statements are not allowed: * UPSERT When using GET requests, it's best to set `readonly` to `true`. - -- [%hardbreaks] @@ -2172,7 +2136,6 @@ ifdef::alt-markdown-links[] [scan-cap-srv]: #scan-cap-srv [queryScanCap]: #queryScanCap - endif::alt-markdown-links[] Maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill. @@ -2188,7 +2151,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [scan-cap-srv]: ../n1ql-rest-admin/index.html#scan-cap-srv [queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap - -- [%hardbreaks] @@ -2232,11 +2194,10 @@ 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](#tximplicit) parameter set to `true`, then this parameter sets the transactional scan consistency. +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][transactional-scan-consistency] for details. [transactional-scan-consistency]: /server/7.6/n1ql/n1ql-manage/query-settings.html#transactional-scan-consistency - -- [%hardbreaks] @@ -2271,7 +2232,6 @@ Scan vectors have two forms: 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`. - -- [%hardbreaks] @@ -2293,7 +2253,6 @@ A map from keyspace names to scan vectors. See `scan_vector`. The scan vectors can be Full or Sparse. - -- [%hardbreaks] @@ -2326,7 +2285,6 @@ Valid units are: * `h` (hours) Specify `0` or a negative integer to disable. - -- [%hardbreaks] @@ -2363,7 +2321,6 @@ a¦ 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. - -- [%hardbreaks] @@ -2393,7 +2350,6 @@ 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. - -- [%hardbreaks] @@ -2413,7 +2369,6 @@ ifdef::alt-markdown-links[] [timeout-srv]: #timeout-srv [queryTimeout]: #queryTimeout - endif::alt-markdown-links[] Maximum time to spend on the request before timing out. @@ -2431,7 +2386,7 @@ Valid units are: 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](#tximplicit) or [txid](#txid) is set, this parameter is ignored. +If `tximplicit` or `txid` is set, this parameter is ignored. The request inherits the remaining time of the transaction as timeout. The [node-level][timeout-srv] `timeout` setting specifies the default for this parameter for a single node. @@ -2443,7 +2398,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [timeout-srv]: ../n1ql-rest-admin/index.html#timeout-srv [queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout - -- [%hardbreaks] @@ -2461,7 +2415,6 @@ a¦ -- Transaction data. For internal use only. - -- [%hardbreaks] @@ -2484,7 +2437,6 @@ 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. - -- [%hardbreaks] @@ -2506,8 +2458,7 @@ When this parameter is true, the Query service starts a transaction and executes 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](#txid) request-level parameter is set, the `tximplicit` parameter is ignored. - +If the `txid` request-level parameter is set, the `tximplicit` parameter is ignored. -- [%hardbreaks] @@ -2527,7 +2478,6 @@ a¦ 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. - -- [%hardbreaks] @@ -2547,13 +2497,12 @@ ifdef::alt-markdown-links[] [txtimeout-srv]: #txtimeout-srv [queryTxTimeout]: #queryTxTimeout - endif::alt-markdown-links[] Maximum time to spend on a transaction before timing out. -Only applies to `BEGIN TRANSACTION` statements, or DML statements for which [tximplicit](#tximplicit) is set. +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](#timeout_req) parameter 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. @@ -2571,6 +2520,8 @@ Valid units are: 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. + The [node-level][txtimeout-srv] `txtimeout` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. However, if the node-level setting is greater than 0, the transaction timeout for the query is limited to the node-level setting. @@ -2578,11 +2529,8 @@ However, if the node-level setting is greater than 0, the transaction timeout fo In addition, the [cluster-level][queryTxTimeout] `queryTxTimeout` setting specifies the default for this parameter for the whole cluster. When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. -The default is `"15s"` for cbq files or scripts, `"2m"` for interactive cbq sessions or redirected input. - [txtimeout-srv]: ../n1ql-rest-admin/index.html#txtimeout-srv [queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout - -- [%hardbreaks] @@ -2602,7 +2550,6 @@ ifdef::alt-markdown-links[] [use-cbo-srv]: #use-cbo-srv [queryUseCBO]: #queryUseCBO - endif::alt-markdown-links[] Specifies whether the cost-based optimizer is enabled. @@ -2614,7 +2561,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [use-cbo-srv]: ../n1ql-rest-admin/index.html#use-cbo-srv [queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO - -- [%hardbreaks] @@ -2641,7 +2587,6 @@ If none of the available Search indexes are qualified, the available GSI indexes Refer to [Flex Indexes][flex-indexes] for more information. [flex-indexes]: /server/7.6/n1ql/n1ql-language-reference/flex-indexes.html - -- [%hardbreaks] @@ -2662,7 +2607,6 @@ ifdef::alt-markdown-links[] [use-replica-srv]: #use-replica-srv [queryUseReplica]: #queryUseReplica - endif::alt-markdown-links[] Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -2674,13 +2618,6 @@ The possible values are: * `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. -The [node-level][use-replica-srv] `use-replica` setting specifies the default for this property for a single node. -The request-level parameter usually overrides the node-level setting. -However, when the node-level setting is `off`, the request-level parameter cannot enable the property. - -In addition, the [cluster-level][queryUseReplica] `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. - Do not enable read from replica when you require consistent results. Only SELECT queries that are not within a transaction can read from replica. @@ -2689,9 +2626,15 @@ Reading from replica is only possible if the cluster uses Couchbase Server 7.6.0 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 [node-level][use-replica-srv] `use-replica` setting specifies the default for this property for a single node. +The request-level parameter usually overrides the node-level setting. +However, when the node-level setting is `off`, the request-level parameter cannot enable the property. + +In addition, the [cluster-level][queryUseReplica] `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. + [use-replica-srv]: ../n1ql-rest-admin/index.html#use-replica-srv [queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica - -- [%hardbreaks] @@ -2703,6 +2646,7 @@ a¦ String a¦ [#identifier] +*{lt}$identifier{gt}* + _additional + property_ a¦ @@ -2723,7 +2667,6 @@ The value of the named parameter can be any JSON value. Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for details. [section_srh_tlm_n1b]: /server/7.6/n1ql/n1ql-manage/query-settings.html#section_srh_tlm_n1b - -- [%hardbreaks] @@ -3071,7 +3014,6 @@ Time spent waiting for another service, such as index or data. For index scan, it is time spent waiting for GSI/indexer. For fetch, it is time spent waiting on the KV store. - -- [%hardbreaks] @@ -3134,7 +3076,6 @@ include::{specDir}security/document-begin.adoc[opts=optional] -- Specify a user name and password via HTTP headers. This method can only be used to provide a single credential. - -- [%hardbreaks] diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index e640768d..70574ce2 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -921,7 +921,6 @@ Defines whether the user has access to all URLs, or only URLs specified by the a This field set must be set to `false` to enable the `allowed_urls` and `disallowed_urls` fields. Setting this field to `true` enables access to all endpoints. - -- [%hardbreaks] @@ -944,7 +943,6 @@ For example, if you wish to allow access to all Google APIs, add the URL `https: To allow complete access to `localhost`, use `http://localhost`. Note that each URL must include the port, protocol, and all other components of the URL. - -- [%hardbreaks] @@ -966,7 +964,6 @@ The CURL() function will disallow any URL that starts with this value. If both `allowed_urls` and `disallowed_urls` fields are populated, the `disallowed_urls` field takes precedence over `allowed_urls`. Note that each URL must include the port, protocol, and all other components of the URL. - -- [%hardbreaks] @@ -1025,7 +1022,6 @@ a¦ ifdef::alt-markdown-links[] [cleanupclientattempts]: #cleanupclientattempts - endif::alt-markdown-links[] 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. @@ -1033,7 +1029,6 @@ The [node-level][cleanupclientattempts] `cleanupclientattempts` setting specifie When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [cleanupclientattempts]: ../n1ql-rest-admin/index.html#cleanupclientattempts - -- [%hardbreaks] @@ -1053,7 +1048,6 @@ a¦ ifdef::alt-markdown-links[] [cleanuplostattempts]: #cleanuplostattempts - endif::alt-markdown-links[] When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client. @@ -1061,7 +1055,6 @@ The [node-level][cleanuplostattempts] `cleanuplostattempts` setting specifies th When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [cleanuplostattempts]: ../n1ql-rest-admin/index.html#cleanuplostattempts - -- [%hardbreaks] @@ -1081,7 +1074,6 @@ a¦ ifdef::alt-markdown-links[] [cleanupwindow]: #cleanupwindow - endif::alt-markdown-links[] Specifies how frequently the Query service checks its subset of [active transaction records][additional-storage-use] 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. @@ -1097,12 +1089,12 @@ Valid units are: * `m` (minutes) * `h` (hours) +[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + The [node-level][cleanupwindow] `cleanupwindow` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [cleanupwindow]: ../n1ql-rest-admin/index.html#cleanupwindow - -- [%hardbreaks] @@ -1122,7 +1114,6 @@ a¦ ifdef::alt-markdown-links[] [completed-limit]: #completed-limit - endif::alt-markdown-links[] Sets the number of requests to be logged in the completed requests catalog. As new completed requests are added, old ones are removed. @@ -1131,12 +1122,12 @@ Increase this when the completed request keyspace is not big enough to track the Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + The [node-level][completed-limit] `completed-limit` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [completed-limit]: ../n1ql-rest-admin/index.html#completed-limit - -- [%hardbreaks] @@ -1156,7 +1147,6 @@ a¦ ifdef::alt-markdown-links[] [completed-max-plan-size]: #completed-max-plan-size - endif::alt-markdown-links[] A plan size in bytes. Limits the size of query execution plans that can be logged in the completed requests catalog. @@ -1166,12 +1156,12 @@ You must obtain execution plans for such queries via profiling or using the EXPL Refer to [Configure the Completed Requests][sys-completed-config] for more information. +[sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + The [node-level][completed-max-plan-size] `completed-max-plan-size` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [completed-max-plan-size]: ../n1ql-rest-admin/index.html#completed-max-plan-size - -- [%hardbreaks] @@ -1192,7 +1182,6 @@ a¦ ifdef::alt-markdown-links[] [completed-threshold]: #completed-threshold - endif::alt-markdown-links[] A duration in milliseconds. All completed queries lasting longer than this threshold are logged in the completed requests catalog. @@ -1202,12 +1191,12 @@ Specify any negative number to track none. Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + The [node-level][completed-threshold] `completed-threshold` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [completed-threshold]: ../n1ql-rest-admin/index.html#completed-threshold - -- [%hardbreaks] @@ -1227,7 +1216,6 @@ a¦ ifdef::alt-markdown-links[] [loglevel]: #loglevel - endif::alt-markdown-links[] Log level used in the logger. @@ -1257,7 +1245,6 @@ The [node-level][loglevel] `loglevel` setting specifies this property for a sing When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [loglevel]: ../n1ql-rest-admin/index.html#loglevel - -- [%hardbreaks] @@ -1279,7 +1266,6 @@ ifdef::alt-markdown-links[] [max-parallelism-srv]: #max-parallelism-srv [max_parallelism_req]: #max_parallelism_req - endif::alt-markdown-links[] Specifies the maximum parallelism for queries on all Query nodes in the cluster. @@ -1290,6 +1276,10 @@ Similarly, if the value is greater than the number of allowed cores, the maximum 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.) +Refer to [Max Parallelism][max-parallelism] for more information. + +[max-parallelism]: /server/7.6/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism + The [node-level][max-parallelism-srv] `max-parallelism` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -1298,12 +1288,8 @@ If a request includes this parameter, it will be capped by the node-level `max-p 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][max-parallelism] for more information. - -[max-parallelism]: /server/7.6/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism [max-parallelism-srv]: ../n1ql-rest-admin/index.html#max-parallelism-srv [max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req - -- [%hardbreaks] @@ -1324,7 +1310,6 @@ ifdef::alt-markdown-links[] [memory-quota-srv]: #memory-quota-srv [memory_quota_req]: #memory_quota_req - endif::alt-markdown-links[] Specifies the maximum amount of memory a request may use on any Query node in the cluster, in MB. @@ -1342,7 +1327,6 @@ If a request includes this parameter, it will be capped by the node-level `memor [memory-quota-srv]: ../n1ql-rest-admin/index.html#memory-quota-srv [memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req - -- [%hardbreaks] @@ -1362,7 +1346,6 @@ a¦ ifdef::alt-markdown-links[] [n1ql-feat-ctrl]: #n1ql-feat-ctrl - endif::alt-markdown-links[] SQL++ feature control. This setting is provided for technical support only. @@ -1371,7 +1354,6 @@ The [node-level][n1ql-feat-ctrl] `n1ql-feat-ctrl` setting specifies this propert When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [n1ql-feat-ctrl]: ../n1ql-rest-admin/index.html#n1ql-feat-ctrl - -- [%hardbreaks] @@ -1389,7 +1371,6 @@ a¦ ifdef::alt-markdown-links[] [node-quota]: #node-quota - endif::alt-markdown-links[] Sets the soft memory limit for the Query service on every Query node in the cluster, in MB. The garbage collector tries to keep below this target. @@ -1408,7 +1389,6 @@ The [node-level][node-quota] `node-quota` setting specifies this property for a When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [node-quota]: ../n1ql-rest-admin/index.html#node-quota - -- [%hardbreaks] @@ -1427,7 +1407,6 @@ a¦ ifdef::alt-markdown-links[] [node-quota-val-percent]: #node-quota-val-percent - endif::alt-markdown-links[] The percentage of the `queryNodeQuota` that is dedicated to tracked value content memory across all active requests for every Query node in the cluster. (The `queryMemoryQuota` setting specifies the maximum amount of document memory an individual request may use on any Query node in the cluster.) @@ -1436,7 +1415,6 @@ The [node-level][node-quota-val-percent] `node-quota-val-percent` setting specif When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [node-quota-val-percent]: ../n1ql-rest-admin/index.html#node-quota-val-percent - -- [%hardbreaks] @@ -1458,20 +1436,19 @@ ifdef::alt-markdown-links[] [numatrs-srv]: #numatrs-srv [numatrs_req]: #numatrs_req - endif::alt-markdown-links[] Specifies the total number of [active transaction records][additional-storage-use] for all Query nodes in the cluster. +[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + The [node-level][numatrs-srv] `numatrs` setting specifies this property for a single node. 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][numatrs_req] `numatrs` parameter. If a request includes this parameter, it will be capped by the node-level `numatrs` setting. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv [numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req - -- [%hardbreaks] @@ -1493,7 +1470,6 @@ a¦ ifdef::alt-markdown-links[] [num-cpus]: #num-cpus - endif::alt-markdown-links[] The number of CPUs the Query service can use on any Query node in the cluster. Note that this setting requires a restart of the Query service to take effect. @@ -1508,7 +1484,6 @@ The [node-level][num-cpus] `num-cpus` setting specifies this property for a sing When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [num-cpus]: ../n1ql-rest-admin/index.html#num-cpus - -- [%hardbreaks] @@ -1528,7 +1503,6 @@ ifdef::alt-markdown-links[] [pipeline-batch-srv]: #pipeline-batch-srv [pipeline_batch_req]: #pipeline_batch_req - endif::alt-markdown-links[] Controls the number of items execution operators can batch for Fetch from the KV. @@ -1540,7 +1514,6 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. [pipeline-batch-srv]: ../n1ql-rest-admin/index.html#pipeline-batch-srv [pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req - -- [%hardbreaks] @@ -1561,7 +1534,6 @@ ifdef::alt-markdown-links[] [pipeline-cap-srv]: #pipeline-cap-srv [pipeline_cap_req]: #pipeline_cap_req - endif::alt-markdown-links[] Maximum number of items each execution operator can buffer between various operators. @@ -1573,7 +1545,6 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. [pipeline-cap-srv]: ../n1ql-rest-admin/index.html#pipeline-cap-srv [pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req - -- [%hardbreaks] @@ -1593,7 +1564,6 @@ a¦ ifdef::alt-markdown-links[] [prepared-limit]: #prepared-limit - endif::alt-markdown-links[] 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. @@ -1602,7 +1572,6 @@ The [node-level][prepared-limit] `prepared-limit` setting specifies this propert When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [prepared-limit]: ../n1ql-rest-admin/index.html#prepared-limit - -- [%hardbreaks] @@ -1623,7 +1592,6 @@ ifdef::alt-markdown-links[] [scan-cap-srv]: #scan-cap-srv [scan_cap_req]: #scan_cap_req - endif::alt-markdown-links[] Maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill. @@ -1639,7 +1607,6 @@ The minimum of that and the node-level `scan-cap` setting is applied. [scan-cap-srv]: ../n1ql-rest-admin/index.html#scan-cap-srv [scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req - -- [%hardbreaks] @@ -1660,7 +1627,6 @@ ifdef::alt-markdown-links[] [timeout-srv]: #timeout-srv [timeout_req]: #timeout_req - endif::alt-markdown-links[] Maximum time to spend on the request before timing out (ns). @@ -1678,7 +1644,6 @@ The minimum of that and the node-level `timeout` setting is applied. [timeout-srv]: ../n1ql-rest-admin/index.html#timeout-srv [timeout_req]: ../n1ql-rest-query/index.html#timeout_req - -- [%hardbreaks] @@ -1700,7 +1665,6 @@ ifdef::alt-markdown-links[] [txtimeout-srv]: #txtimeout-srv [txtimeout_req]: #txtimeout_req - endif::alt-markdown-links[] Maximum time to spend on a transaction before timing out. This setting only applies to requests containing the `BEGIN TRANSACTION` statement, or to requests where the [tximplicit][tximplicit] parameter is set. @@ -1720,16 +1684,16 @@ Valid units are: Specify `0ms` (the default value) to disable. When disabled, no timeout is applied and the transaction runs for however long it takes. +[tximplicit]: ../n1ql-rest-query/index.html#tximplicit + The [node-level][txtimeout-srv] `txtimeout` setting specifies this property for a single node. 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][txtimeout_req] `txtimeout` parameter. If a request includes this parameter, it will be capped by the node-level `txtimeout` setting. -[tximplicit]: ../n1ql-rest-query/index.html#tximplicit [txtimeout-srv]: ../n1ql-rest-admin/index.html#txtimeout-srv [txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req - -- [%hardbreaks] @@ -1752,7 +1716,6 @@ The specified path must already exist. Only absolute paths are allowed. The default path is `var/lib/couchbase/tmp` within the Couchbase Server installation directory. - -- [%hardbreaks] @@ -1774,7 +1737,6 @@ Setting the size to `0` disables backfill. Setting the size to `-1` means the size is unlimited. The maximum size is limited only by the available disk space. - -- [%hardbreaks] @@ -1795,7 +1757,6 @@ ifdef::alt-markdown-links[] [use-cbo-srv]: #use-cbo-srv [use_cbo_req]: #use_cbo_req - endif::alt-markdown-links[] Specifies whether the cost-based optimizer is enabled. @@ -1807,7 +1768,6 @@ If a request does not include this parameter, the node-level setting is used, wh [use-cbo-srv]: ../n1ql-rest-admin/index.html#use-cbo-srv [use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req - -- [%hardbreaks] @@ -1828,7 +1788,6 @@ ifdef::alt-markdown-links[] [use-replica-srv]: #use-replica-srv [use_replica_req]: #use_replica_req - endif::alt-markdown-links[] Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -1839,13 +1798,6 @@ The possible values are: * `unset` — read from replica is enabled or disabled at request level. -The [node-level][use-replica-srv] `use-replica` setting specifies this property for a single node. -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_replica_req] `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. @@ -1854,9 +1806,15 @@ Reading from replica is only possible if the cluster uses Couchbase Server 7.6.0 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 [node-level][use-replica-srv] `use-replica` setting specifies this property for a single node. +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_replica_req] `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. + [use-replica-srv]: ../n1ql-rest-admin/index.html#use-replica-srv [use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req - -- [%hardbreaks] diff --git a/src/admin/swagger/admin.yaml b/src/admin/swagger/admin.yaml index 2a0da3a2..938b848c 100644 --- a/src/admin/swagger/admin.yaml +++ b/src/admin/swagger/admin.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Query Admin REST API version: '7.6' - description: | + description: |- The Query Admin REST API is a secondary API provided by the Query service. This API enables you to retrieve statistics about the clusters and nodes running the Query service; view or specify node-level settings; and view or delete requests. @@ -155,7 +155,7 @@ paths: get: operationId: get_prepareds summary: Retrieve All Prepared Statements - description: | + description: |- Returns all prepared statements. tags: - prepared statements @@ -177,7 +177,7 @@ paths: summary: Retrieve a Prepared Statement parameters: - $ref: "#/components/parameters/PathName" - description: | + description: |- Returns the specified prepared statement. tags: - prepared statements @@ -195,7 +195,7 @@ paths: summary: Delete a Prepared Statement parameters: - $ref: "#/components/parameters/PathName" - description: | + description: |- Deletes the specified prepared statement. tags: - prepared statements @@ -215,7 +215,7 @@ paths: get: operationId: get_active_requests summary: Retrieve All Active Requests - description: | + description: |- Returns all active query requests. tags: - active requests @@ -237,7 +237,7 @@ paths: summary: Retrieve an Active Request parameters: - $ref: "#/components/parameters/PathRequest" - description: | + description: |- Returns the specified active query request. tags: - active requests @@ -255,7 +255,7 @@ paths: summary: Delete an Active Request parameters: - $ref: "#/components/parameters/PathRequest" - description: | + description: |- Terminates the specified active query request. tags: - active requests @@ -275,7 +275,7 @@ paths: get: operationId: get_completed_requests summary: Retrieve All Completed Requests - description: | + description: |- Returns all completed requests. tags: - completed requests @@ -297,7 +297,7 @@ paths: summary: Retrieve a Completed Request parameters: - $ref: "#/components/parameters/PathRequest" - description: | + description: |- Returns the specified completed request. tags: - completed requests @@ -315,7 +315,7 @@ paths: summary: Delete a Completed Request parameters: - $ref: "#/components/parameters/PathRequest" - description: | + description: |- Purges the specified completed request. tags: - completed requests @@ -335,7 +335,7 @@ paths: get: operationId: get_prepared_indexes summary: Retrieve Prepared Index Statements - description: | + description: |- Returns all prepared index statements. * Use [Retrieve a Prepared Statement](#get_prepared) to get information about a prepared index statement. @@ -353,7 +353,7 @@ paths: type: array items: type: string - description: | + description: |- 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. @@ -361,7 +361,7 @@ paths: get: operationId: get_active_indexes summary: Retrieve Active Index Requests - description: | + description: |- Returns all active index requests. * Use [Retrieve an Active Request](#get_active_request) to get information about an active index request. @@ -385,7 +385,7 @@ paths: get: operationId: get_completed_indexes summary: Retrieve Completed Index Requests - description: | + description: |- Returns all completed index requests. * Use [Retrieve a Completed Request](#get_completed_request) to get information about a completed index request. @@ -424,7 +424,7 @@ paths: get: operationId: get_gc summary: Run Garbage Collector - description: | + description: |- Runs the garbage collector. A message is written to `query.log` whenever the garbage collector endpoint is invoked. @@ -440,7 +440,7 @@ paths: schema: $ref: "#/components/schemas/Garbage" 401: - description: | + description: |- Error 10000: authentication failure. The invoking user is not a valid full-admin user. content: @@ -450,7 +450,7 @@ paths: post: operationId: post_gc summary: Run Garbage Collector and Release Memory - description: | + description: |- Run the garbage collector and attempts to return freed memory to the OS. A message is written to `query.log` whenever the garbage collector endpoint is invoked. @@ -466,7 +466,7 @@ paths: schema: $ref: "#/components/schemas/Garbage" 401: - description: | + description: |- Error 10000: authentication failure. The invoking user is not a valid full-admin user. content: @@ -482,7 +482,7 @@ paths: get: operationId: get_vitals summary: Retrieve Vitals - description: | + description: |- Returns data about the running state and health of the query engine. This information can be very useful to assess the current workload and performance characteristics of a query engine, and hence load-balance the requests being sent to various query engines. tags: @@ -508,7 +508,7 @@ paths: - Default: [] responses: 200: - description: | + description: |- An object containing all statistics. Each statistic consists of a top-level statistic name and a metric name. Each statistic has a different set of metrics. @@ -530,7 +530,7 @@ paths: - Default: [] responses: 200: - description: | + description: |- An object containing all metrics for the specified statistic. Each statistic has a different set of metrics. content: @@ -558,7 +558,7 @@ paths: get: operationId: get_settings summary: Retrieve Node-Level Query Settings - description: | + description: |- Returns node-level query settings. tags: - settings @@ -574,7 +574,7 @@ paths: post: operationId: post_settings summary: Update Node-Level Query Settings - description: | + description: |- Updates node-level query settings. tags: - settings @@ -649,17 +649,18 @@ components: properties: clientContextID: type: string - description: | + description: |- The opaque ID or context provided by the client. + x-desc-more: |- Refer to the [request-level][client_context_id] `client_context_id` parameter for more information. [client_context_id]: ../n1ql-rest-query/index.html#client_context_id - x-desc-refs: | + x-desc-refs: |- [client_context_id]: #client_context_id elapsedTime: type: string format: duration - description: | + description: |- 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. errorCount: @@ -667,7 +668,7 @@ components: description: Total number of errors encountered while executing the query. memoryQuota: type: integer - description: | + description: |- The memory quota for the request, in MB. This property is only returned if a memory quota is set for the query. node: @@ -675,7 +676,7 @@ components: description: IP address and port number of the node where the query is executed. phaseCounts: type: object - description: | + description: |- 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. @@ -688,7 +689,7 @@ components: x-has-example: true phaseOperators: type: object - description: | + description: |- 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. @@ -703,7 +704,7 @@ components: x-has-example: true phaseTimes: type: object - description: | + description: |- 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. @@ -745,7 +746,7 @@ components: description: Total amount of calendar time taken to complete the query. state: type: string - description: | + description: |- 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. @@ -760,7 +761,7 @@ components: description: Whether the cost-based optimizer is enabled for the query. usedMemory: type: integer - description: | + description: |- The amount of document memory used to execute the request. This property is only returned if a memory quota is set for the query. userAgent: @@ -784,27 +785,27 @@ components: description: The full prepared statement in encoded format. featureControls: type: integer - description: | + description: |- This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. indexApiVersion: type: integer - description: | + description: |- This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. name: type: string - description: | + description: |- 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. namespace: type: string - description: | + description: |- The namespace in which the prepared statement is stored. Currently, only the `default` namespace is available. node: type: string - description: | + description: |- The node on which the prepared statement is stored. statement: type: string @@ -815,7 +816,7 @@ components: avgElapsedTime: type: string format: duration - description: | + description: |- 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. @@ -824,7 +825,7 @@ components: avgServiceTime: type: string format: duration - description: | + description: |- 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. @@ -832,14 +833,14 @@ components: lastUse: type: string format: date-time - description: | + description: |- Date and time of last use. This property is only returned when the prepared statement has been executed. maxElapsedTime: type: string format: duration - description: | + description: |- 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. @@ -848,7 +849,7 @@ components: maxServiceTime: type: string format: duration - description: | + description: |- 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. @@ -856,7 +857,7 @@ components: minElapsedTime: type: string format: duration - description: | + description: |- 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. @@ -865,7 +866,7 @@ components: minServiceTime: type: string format: duration - description: | + description: |- 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. @@ -920,7 +921,7 @@ components: host.memory.quota: type: integer format: int64 - description: | + description: |- The host memory quota. This reflects the node-quota setting. host.memory.total: @@ -940,19 +941,19 @@ components: memory.usage: type: integer format: int64 - description: | + description: |- The amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, and decreases as objects are freed. memory.total: type: integer format: int64 - description: | + description: |- 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. memory.system: type: integer format: int64 - description: | + description: |- 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. node: @@ -960,7 +961,7 @@ components: description: The name or IP address and port of the node. node.allocated.values: type: integer - description: | + description: |- The total number of values allocated to contain documents or computations around documents. (This is only of relevance internally.) node.memory.usage: @@ -969,13 +970,13 @@ components: cpu.user.percent: type: integer format: int64 - description: | + description: |- CPU usage. The percentage of time spent executing user code since the last time the statistics were checked. cpu.sys.percent: type: integer format: int64 - description: | + description: |- CPU usage. The percentage of time spent executing system code since the last time the statistics were checked. process.memory.usage: @@ -998,17 +999,17 @@ components: description: Total number of active requests. request.per.sec.1min: type: number - description: | + description: |- Number of query requests processed per second. 1-minute exponentially weighted moving average. request.per.sec.5min: type: number - description: | + description: |- Number of query requests processed per second. 5-minute exponentially weighted moving average. request.per.sec.15min: type: number - description: | + description: |- Number of query requests processed per second. 15-minute exponentially weighted moving average. request.queued.count: @@ -1020,31 +1021,31 @@ components: request_time.mean: type: string format: duration - description: | + description: |- End-to-end time to process a query. The mean value. request_time.median: type: string format: duration - description: | + description: |- End-to-end time to process a query. The median value. request_time.80percentile: type: string format: duration - description: | + description: |- End-to-end time to process a query. The 80th percentile. request_time.95percentile: type: string format: duration - description: | + description: |- End-to-end time to process a query. The 95th percentile. request_time.99percentile: type: string format: duration - description: | + description: |- End-to-end time to process a query. The 99th percentile. request.prepared.percent: @@ -1052,22 +1053,22 @@ components: description: Percentage of requests that are prepared statements. servicers.paused.count: type: integer - description: | + description: |- Number of servicers temporarily paused due to memory pressure. (Applies to serverless environments only.) servicers.paused.total: type: integer - description: | + description: |- Number of times servicers have been temporarily paused. (Applies to serverless environments only.) temp.hwm: type: integer - description: | + description: |- High water mark for temp space use directly by query. (Doesn't include use by the GSI and Search clients.) temp.usage: type: integer - description: | + description: |- Current Query temp space use. (Doesn't include use by the GSI and Search clients.) @@ -1083,7 +1084,7 @@ components: description: Total number of query requests with `at_plus` index consistency. audit_actions.count: type: integer - description: | + description: |- 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. @@ -1131,37 +1132,37 @@ components: description: Total end-to-end time to process all queries (ns). request_timer.15m.rate: type: number - description: | + description: |- Number of query requests processed per second. 15-minute exponentially weighted moving average. request_timer.1m.rate: type: number - description: | + description: |- Number of query requests processed per second. 1-minute exponentially weighted moving average. request_timer.5m.rate: type: number - description: | + description: |- Number of query requests processed per second. 5-minute exponentially weighted moving average. request_timer.75%: type: number - description: | + description: |- End-to-end time to process a query (ns). The 75th percentile. request_timer.95%: type: number - description: | + description: |- End-to-end time to process a query (ns). The 95th percentile. request_timer.99%: type: number - description: | + description: |- End-to-end time to process a query (ns). The 99th percentile. request_timer.99.9%: type: number - description: | + description: |- End-to-end time to process a query (ns). The 99.9th percentile. request_timer.count: @@ -1169,32 +1170,32 @@ components: description: Total number of query requests. request_timer.max: type: integer - description: | + description: |- End-to-end time to process a query (ns). The maximum value. request_timer.mean: type: number - description: | + description: |- End-to-end time to process a query (ns). The mean value. request_timer.mean.rate: type: number - description: | + description: |- Number of query requests processed per second. Mean rate since the query service started. request_timer.median: type: number - description: | + description: |- End-to-end time to process a query (ns). The median value. request_timer.min: type: integer - description: | + description: |- End-to-end time to process a query (ns). The minimum value. request_timer.stddev: type: number - description: | + description: |- End-to-end time to process a query (ns). The standard deviation. requests.count: @@ -1295,7 +1296,7 @@ components: x-has-default: true x-has-example: true x-desc-name: atrcollection-srv - description: | + description: |- Specifies the collection where [active transaction records][additional-storage-use] 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. @@ -1303,12 +1304,13 @@ components: 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 ``. + [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + x-desc-more: |- The [request-level][atrcollection_req] `atrcollection` parameter specifies this property per request. If a request does not include this parameter, the node-level `atrcollection` setting will be used. - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [atrcollection_req]: ../n1ql-rest-query/index.html#atrcollection_req - x-desc-refs: | + x-desc-refs: |- [atrcollection_req]: #atrcollection_req auto-prepare: type: boolean @@ -1317,7 +1319,7 @@ components: x-has-default: true x-has-example: true x-desc-name: auto-prepare - description: | + description: |- 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][auto-prepare] for more information. @@ -1331,14 +1333,14 @@ components: x-has-default: true x-has-example: true x-desc-name: cleanupclientattempts - description: | + description: |- 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. - + x-desc-more: |- The [cluster-level][queryCleanupClientAttempts] `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. [queryCleanupClientAttempts]: ../n1ql-rest-settings/index.html#queryCleanupClientAttempts - x-desc-refs: | + x-desc-refs: |- [queryCleanupClientAttempts]: #queryCleanupClientAttempts cleanuplostattempts: type: boolean @@ -1347,14 +1349,14 @@ components: x-has-default: true x-has-example: true x-desc-name: cleanuplostattempts - description: | + description: |- When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client. - + x-desc-more: |- The [cluster-level][queryCleanupLostAttempts] `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. [queryCleanupLostAttempts]: ../n1ql-rest-settings/index.html#queryCleanupLostAttempts - x-desc-refs: | + x-desc-refs: |- [queryCleanupLostAttempts]: #queryCleanupLostAttempts cleanupwindow: type: string @@ -1364,7 +1366,7 @@ components: x-has-default: true x-has-example: true x-desc-name: cleanupwindow - description: | + description: |- Specifies how frequently the Query service checks its subset of [active transaction records][additional-storage-use] 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. @@ -1379,12 +1381,13 @@ components: * `m` (minutes) * `h` (hours) + [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + x-desc-more: |- The [cluster-level][queryCleanupWindow] `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. - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [queryCleanupWindow]: ../n1ql-rest-settings/index.html#queryCleanupWindow - x-desc-refs: | + x-desc-refs: |- [queryCleanupWindow]: #queryCleanupWindow completed: type: object @@ -1392,13 +1395,13 @@ components: default: {"aborted": null, "threshold": 1000} example: {"user": "marco", "error": 12003} x-desc-name: completed - description: | + description: |- 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][sys-completed-config] for more information and examples. - [sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config + [sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config properties: aborted: type: boolean @@ -1413,19 +1416,19 @@ components: example: "172.1.2.3" x-has-default: true x-has-example: true - description: | + description: |- The IP address of the client. If specified, all completed requests from this IP address are logged. context: type: string - description: | + description: |- The opaque ID or context provided by the client. If specified, all completed requests with this client context ID are logged. - + x-desc-more: |- Refer to the [request-level][client_context_id] `client_context_id` parameter for more information. [client_context_id]: ../n1ql-rest-query/index.html#client_context_id - x-desc-refs: | + x-desc-refs: |- [client_context_id]: #client_context_id error: type: integer @@ -1434,7 +1437,7 @@ components: example: 12003 x-has-default: true x-has-example: true - description: | + description: |- An error number. If specified, all completed queries returning this error number are logged. tag: @@ -1443,12 +1446,12 @@ components: example: "both_user_and_error" x-has-default: true x-has-example: true - description: | + description: |- A unique string which tags a set of qualifiers. Refer to [Configure Completed Requests][sys-completed-config] for more information. - [sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config + [sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config threshold: type: integer format: int32 @@ -1456,18 +1459,18 @@ components: example: 7000 x-has-default: true x-has-example: true - description: | + description: |- 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) `completed-threshold` setting. + This is another way of specifying the `completed-threshold` setting. user: type: string default: "" example: "marco" x-has-default: true x-has-example: true - description: | + description: |- A user name, as given in the request credentials. If specified, all completed queries with this user name are logged. errors: @@ -1475,7 +1478,7 @@ components: format: int32 example: 5 x-has-example: true - description: | + description: |- The number of errors. If specified, all completed queries that return at least this many errors are logged. Queries with fewer errors are not logged. @@ -1488,7 +1491,7 @@ components: x-has-default: true x-has-example: true x-desc-name: completed-limit - description: | + description: |- Sets the number of requests to be logged in the completed requests catalog. As new completed requests are added, old ones are removed. @@ -1496,12 +1499,13 @@ components: Refer to [Configure Completed Requests][sys-completed-config] for more information and examples. + [sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + x-desc-more: |- The [cluster-level][queryCompletedLimit] `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. - [sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [queryCompletedLimit]: ../n1ql-rest-settings/index.html#queryCompletedLimit - x-desc-refs: | + x-desc-refs: |- [queryCompletedLimit]: #queryCompletedLimit completed-max-plan-size: type: integer @@ -1511,7 +1515,7 @@ components: maximum: 20840448 x-has-default: true x-desc-name: completed-max-plan-size - description: | + description: |- 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. @@ -1520,12 +1524,13 @@ components: Refer to [Configure Completed Requests][sys-completed-config] for more information. + [sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + x-desc-more: |- The [cluster-level][queryCompletedMaxPlanSize] `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. - [sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [queryCompletedMaxPlanSize]: ../n1ql-rest-settings/index.html#queryCompletedMaxPlanSize - x-desc-refs: | + x-desc-refs: |- [queryCompletedMaxPlanSize]: #queryCompletedMaxPlanSize completed-stream-size: type: integer @@ -1533,7 +1538,7 @@ components: default: 0 x-desc-name: completed-stream-size x-desc-status: Couchbase Server 7.6.4 - description: | + description: |- 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`. @@ -1545,7 +1550,7 @@ components: Refer to [Stream Completed Requests][sys-history] for more information and examples. - [sys-history]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-history + [sys-history]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-history completed-threshold: type: integer format: int32 @@ -1554,7 +1559,7 @@ components: x-has-default: true x-has-example: true x-desc-name: completed-threshold - description: | + description: |- A duration in milliseconds. All completed queries lasting longer than this threshold are logged in the completed requests catalog. @@ -1563,12 +1568,13 @@ components: Refer to [Configure Completed Requests][sys-completed-config] for more information and examples. + [sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + x-desc-more: |- The [cluster-level][queryCompletedThreshold] `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. - [sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [queryCompletedThreshold]: ../n1ql-rest-settings/index.html#queryCompletedThreshold - x-desc-refs: | + x-desc-refs: |- [queryCompletedThreshold]: #queryCompletedThreshold controls: type: boolean @@ -1577,18 +1583,18 @@ components: x-has-default: true x-has-example: true x-desc-name: controls-srv - description: | + description: |- 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. - + x-desc-more: |- The [request-level][controls_req] `controls` parameter specifies this property per request. If a request does not include this parameter, the node-level `controls` setting will be used. [controls_req]: ../n1ql-rest-query/index.html#controls_req - x-desc-refs: | + x-desc-refs: |- [controls_req]: #controls_req cpuprofile: type: string @@ -1597,7 +1603,7 @@ components: x-has-default: true x-has-example: true x-desc-name: cpuprofile - description: | + description: |- 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. @@ -1612,7 +1618,7 @@ components: x-has-default: true x-has-example: true x-desc-name: debug - description: | + description: |- Use debug mode. When set to `true`, extra logging is provided. @@ -1621,7 +1627,7 @@ components: example: true x-has-example: true x-desc-name: distribute - description: | + description: |- 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. @@ -1651,7 +1657,7 @@ components: x-has-default: true x-has-example: true x-desc-name: loglevel - description: | + description: |- Log level used in the logger. All values, in descending order of data: @@ -1675,18 +1681,18 @@ components: Major items, like crashes. * `NONE` — Doesn't write anything. - + x-desc-more: |- The [cluster-level][queryLogLevel] `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. [queryLogLevel]: ../n1ql-rest-settings/index.html#queryLogLevel - x-desc-refs: | + x-desc-refs: |- [queryLogLevel]: #queryLogLevel max-index-api: type: integer format: int32 x-desc-name: max-index-api - description: | + description: |- Max index API. This setting is provided for technical support only. max-parallelism: @@ -1697,7 +1703,7 @@ components: x-has-default: true x-has-example: true x-desc-name: max-parallelism-srv - description: | + description: |- 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. @@ -1706,7 +1712,10 @@ components: (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.) + Refer to [Max Parallelism][max-parallelism] for more information. + [max-parallelism]: /server/7.6/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism + x-desc-more: |- The [cluster-level][queryMaxParallelism] `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. @@ -1715,12 +1724,9 @@ components: 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][max-parallelism] for more information. - - [max-parallelism]: /server/7.6/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism [queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism [max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req - x-desc-refs: | + x-desc-refs: |- [queryMaxParallelism]: #queryMaxParallelism [max_parallelism_req]: #max_parallelism_req memory-quota: @@ -1731,7 +1737,7 @@ components: x-has-default: true x-has-example: true x-desc-name: memory-quota-srv - description: | + description: |- Specifies the maximum amount of memory a request may use on this node, in MB. Specify `0` (the default value) to disable. @@ -1742,7 +1748,7 @@ components: Within a transaction, this setting enforces the memory quota for the transaction by tracking the delta table and the transaction log (approximately). - + x-desc-more: |- The [cluster-level][queryMemoryQuota] `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. @@ -1751,7 +1757,7 @@ components: [queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota [memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req - x-desc-refs: | + x-desc-refs: |- [queryMemoryQuota]: #queryMemoryQuota [memory_quota_req]: #memory_quota_req memprofile: @@ -1761,7 +1767,7 @@ components: x-has-default: true x-has-example: true x-desc-name: memprofile - description: | + description: |- 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. @@ -1772,7 +1778,7 @@ components: default: false x-has-default: true x-desc-name: mutexprofile - description: | + description: |- Mutex profile. This setting is provided for technical support only. n1ql-feat-ctrl: @@ -1786,16 +1792,16 @@ components: x-has-default: true x-has-example: true x-desc-name: n1ql-feat-ctrl - description: | + description: |- SQL++ feature control. This setting is provided for technical support only. The value may be an integer, or a string representing a hexadecimal number. - + x-desc-more: |- The [cluster-level][queryN1QLFeatCtrl] `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. [queryN1QLFeatCtrl]: ../n1ql-rest-settings/index.html#queryN1QLFeatCtrl - x-desc-refs: | + x-desc-refs: |- [queryN1QLFeatCtrl]: #queryN1QLFeatCtrl node-quota: type: integer @@ -1803,7 +1809,7 @@ components: default: 0 x-has-default: true x-desc-name: node-quota - description: | + description: |- Sets the soft memory limit for the Query service on 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. @@ -1816,12 +1822,12 @@ components: - If the difference is greater than 8 GiB, the default soft memory limit is set to the total system RAM minus 8 GiB. - If the difference is 8 GiB or less, the default soft memory limit is set to 90% of the total system RAM. - + x-desc-more: |- The [cluster-level][queryNodeQuota] `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. [queryNodeQuota]: ../n1ql-rest-settings/index.html#queryNodeQuota - x-desc-refs: | + x-desc-refs: |- [queryNodeQuota]: #queryNodeQuota node-quota-val-percent: type: integer @@ -1831,15 +1837,15 @@ components: maximum: 100 x-has-default: true x-desc-name: node-quota-val-percent - description: | + description: |- 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.) - + x-desc-more: |- The [cluster-level][queryNodeQuotaValPercent] `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. [queryNodeQuotaValPercent]: ../n1ql-rest-settings/index.html#queryNodeQuotaValPercent - x-desc-refs: | + x-desc-refs: |- [queryNodeQuotaValPercent]: #queryNodeQuotaValPercent num-cpus: type: integer @@ -1847,7 +1853,7 @@ components: default: 0 x-has-default: true x-desc-name: num-cpus - description: | + description: |- 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. @@ -1856,29 +1862,30 @@ components: 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. - + x-desc-more: |- The [cluster-level][queryNumCpus] `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. [queryNumCpus]: ../n1ql-rest-settings/index.html#queryNumCpus - x-desc-refs: | + x-desc-refs: |- [queryNumCpus]: #queryNumCpus numatrs: type: string x-desc-name: numatrs-srv - description: | + description: |- Specifies the total number of [active transaction records][additional-storage-use]. + [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + x-desc-more: |- The [cluster-level][queryNumAtrs] `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_req] `numatrs` parameter specifies this property per request. The minimum of that and the node-level `numatrs` setting is applied. - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs [numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req - x-desc-refs: | + x-desc-refs: |- [queryNumAtrs]: #queryNumAtrs [numatrs_req]: #numatrs_req pipeline-batch: @@ -1889,9 +1896,9 @@ components: x-has-default: true x-has-example: true x-desc-name: pipeline-batch-srv - description: | + description: |- Controls the number of items execution operators can batch for Fetch from the KV. - + x-desc-more: |- The [cluster-level][queryPipelineBatch] `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. @@ -1900,7 +1907,7 @@ components: [queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch [pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req - x-desc-refs: | + x-desc-refs: |- [queryPipelineBatch]: #queryPipelineBatch [pipeline_batch_req]: #pipeline_batch_req pipeline-cap: @@ -1911,9 +1918,9 @@ components: x-has-default: true x-has-example: true x-desc-name: pipeline-cap-srv - description: | + description: |- Maximum number of items each execution operator can buffer between various operators. - + x-desc-more: |- The [cluster-level][queryPipelineCap] `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. @@ -1922,7 +1929,7 @@ components: [queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap [pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req - x-desc-refs: | + x-desc-refs: |- [queryPipelineCap]: #queryPipelineCap [pipeline_cap_req]: #pipeline_cap_req plus-servicers: @@ -1931,7 +1938,7 @@ components: example: 16 x-has-example: true x-desc-name: plus-servicers - description: | + description: |- 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. prepared-limit: @@ -1942,15 +1949,15 @@ components: x-has-default: true x-has-example: true x-desc-name: prepared-limit - description: | + description: |- 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. - + x-desc-more: |- The [cluster-level][queryPreparedLimit] `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. [queryPreparedLimit]: ../n1ql-rest-settings/index.html#queryPreparedLimit - x-desc-refs: | + x-desc-refs: |- [queryPreparedLimit]: #queryPreparedLimit pretty: type: boolean @@ -1959,14 +1966,14 @@ components: x-has-default: true x-has-example: true x-desc-name: pretty-srv - description: | + description: |- Specifies whether query results are returned in pretty format. - + x-desc-more: |- The [request-level][pretty_req] `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`. [pretty_req]: ../n1ql-rest-query/index.html#pretty_req - x-desc-refs: | + x-desc-refs: |- [pretty_req]: #pretty_req profile: type: string @@ -1976,7 +1983,7 @@ components: x-has-example: true enum: ["off","phases","timings"] x-desc-name: profile-srv - description: | + description: |- Specifies if there should be a profile section returned with the request results. The valid values are: @@ -1989,15 +1996,16 @@ components: 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][monitor-profile-details] for more information and examples. + [monitor-profile-details]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#monitor-profile-details + x-desc-more: |- The [request-level][profile_req] `profile` parameter specifies this property per request. If a request does not include this parameter, the node-level `profile` setting will be used. - [monitor-profile-details]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#monitor-profile-details [profile_req]: ../n1ql-rest-query/index.html#profile_req - x-desc-refs: | + x-desc-refs: |- [profile_req]: #profile_req request-size-cap: type: integer @@ -2016,13 +2024,13 @@ components: x-has-default: true x-has-example: true x-desc-name: scan-cap-srv - description: | + description: |- 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. - + x-desc-more: |- The [cluster-level][queryScanCap] `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. @@ -2031,7 +2039,7 @@ components: [queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap [scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req - x-desc-refs: | + x-desc-refs: |- [queryScanCap]: #queryScanCap [scan_cap_req]: #scan_cap_req servicers: @@ -2042,7 +2050,7 @@ components: x-has-default: true x-has-example: true x-desc-name: servicers - description: | + description: |- The number of service threads for the query. The default is 4 times the number of cores on the query node. timeout: @@ -2053,7 +2061,7 @@ components: x-has-default: true x-has-example: true x-desc-name: timeout-srv - description: | + description: |- Maximum time to spend on the request before timing out (ns). The value for this setting is an integer, representing a duration in nanoseconds. @@ -2061,7 +2069,7 @@ components: 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. - + x-desc-more: |- The [cluster-level][queryTimeout] `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. @@ -2070,7 +2078,7 @@ components: [queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout [timeout_req]: ../n1ql-rest-query/index.html#timeout_req - x-desc-refs: | + x-desc-refs: |- [queryTimeout]: #queryTimeout [timeout_req]: #timeout_req txtimeout: @@ -2081,7 +2089,7 @@ components: x-has-default: true x-has-example: true x-desc-name: txtimeout-srv - description: | + description: |- 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][tximplicit] parameter is set. For all other requests, it is ignored. @@ -2092,16 +2100,17 @@ components: Specify `0` (the default value) to disable. When disabled, no timeout is applied and the transaction runs for however long it takes. + [tximplicit]: ../n1ql-rest-query/index.html#tximplicit + x-desc-more: |- The [cluster-level][queryTxTimeout] `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_req] `txtimeout` parameter specifies this property per request. The minimum of that and the node-level `txtimeout` setting is applied. - [tximplicit]: ../n1ql-rest-query/index.html#tximplicit [queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout [txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req - x-desc-refs: | + x-desc-refs: |- [tximplicit]: #tximplicit [queryTxTimeout]: #queryTxTimeout [txtimeout_req]: #txtimeout_req @@ -2112,9 +2121,9 @@ components: x-has-default: true x-has-example: true x-desc-name: use-cbo-srv - description: | + description: |- Specifies whether the cost-based optimizer is enabled. - + x-desc-more: |- The [cluster-level][queryUseCBO] `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. @@ -2123,7 +2132,7 @@ components: [queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO [use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req - x-desc-refs: | + x-desc-refs: |- [queryUseCBO]: #queryUseCBO [use_cbo_req]: #use_cbo_req use-replica: @@ -2134,7 +2143,7 @@ components: x-has-default: true x-has-example: true x-desc-name: use-replica-srv - description: | + description: |- Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -2144,13 +2153,6 @@ components: * `unset` — read from replica is enabled or disabled at request level. - The [cluster-level][queryUseReplica] `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_req] `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. @@ -2158,10 +2160,17 @@ components: 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. + x-desc-more: |- + The [cluster-level][queryUseReplica] `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_req] `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. [queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica [use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req - x-desc-refs: | + x-desc-refs: |- [queryUseReplica]: #queryUseReplica [use_replica_req]: #use_replica_req @@ -2174,7 +2183,7 @@ components: description: The amount of memory freed. released: type: integer - description: | + description: |- Only returned by the POST method. The amount of memory released to the OS. status: @@ -2223,7 +2232,7 @@ components: - unbounded - updates - warnings - description: | + description: |- The name of a statistic. Only top-level statistic names can be used. You cannot specify a metric. @@ -2234,7 +2243,7 @@ components: type: string in: path required: true - description: | + description: |- The name of a prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. @@ -2244,7 +2253,7 @@ components: type: string in: path required: true - description: | + description: |- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. @@ -2268,6 +2277,6 @@ components: Default: type: http scheme: basic - description: | + description: |- The Admin API supports admin credentials. Credentials can be passed via HTTP headers (HTTP basic authentication). diff --git a/src/query-service/swagger/query-service.yaml b/src/query-service/swagger/query-service.yaml index 3fae5749..3eb37389 100644 --- a/src/query-service/swagger/query-service.yaml +++ b/src/query-service/swagger/query-service.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Query Service REST API version: '7.6' - description: | + description: |- The Query Service REST API is provided by the Query service. This API enables you to run SQL++ queries and set request-level parameters. @@ -254,7 +254,7 @@ components: type: array items: {} x-desc-name: args - description: | + description: |- Supplies the values for positional parameters in the statement. Applicable if the statement or prepared statement contains 1 or more positional parameters. @@ -270,7 +270,7 @@ components: atrcollection: type: string x-desc-name: atrcollection_req - description: | + description: |- Specifies the collection where the [active transaction record][additional-storage-use] (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. @@ -278,19 +278,20 @@ components: 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 ``. + [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + x-desc-more: |- The [node-level][atrcollection-srv] `atrcollection` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [atrcollection-srv]: ../n1ql-rest-admin/index.html#atrcollection-srv - x-desc-refs: | + x-desc-refs: |- [atrcollection-srv]: #atrcollection-srv x-has-example: true example: default:`travel-sample`.transaction.test auto_execute: type: boolean x-desc-name: auto_execute - description: | + description: |- 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. @@ -304,7 +305,7 @@ components: client_context_id: type: string x-desc-name: client_context_id - description: | + description: |- 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. @@ -313,7 +314,7 @@ components: compression: type: string x-desc-name: compression - description: | + description: |- Compression format to use for response data on the wire. Values are case-insensitive. @@ -325,18 +326,18 @@ components: controls: type: boolean x-desc-name: controls_req - description: | + description: |- 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. - + x-desc-more: |- The [node-level][controls-srv] `controls` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. [controls-srv]: ../n1ql-rest-admin/index.html#controls-srv - x-desc-refs: | + x-desc-refs: |- [controls-srv]: #controls-srv x-has-example: true example: true @@ -345,7 +346,7 @@ components: items: $ref: "#/components/schemas/Credentials" x-desc-name: creds - description: | + description: |- Specifies the login credentials. The Query API supports two types of identity: local (or bucket) and admin. @@ -362,10 +363,10 @@ components: durability_level: type: string x-desc-name: durability_level - description: | + description: |- The level of [durability][durability] for mutations produced by the request. - If the request contains a `BEGIN TRANSACTION` statement, or a DML statement with the [tximplicit](#tximplicit) parameter set to `true`, the durability level is specified for all mutations within that transaction. + 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. @@ -387,13 +388,13 @@ components: encoded_plan: type: string x-desc-name: encoded_plan - description: | + description: |- 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. encoding: type: string x-desc-name: encoding - description: | + description: |- Desired character encoding for the query results. Only possible value is `UTF-8` and is case-insensitive. @@ -402,7 +403,7 @@ components: format: type: string x-desc-name: format - description: | + description: |- Desired format for the query results. Values are case-insensitive. @@ -414,7 +415,7 @@ components: kvtimeout: type: string x-desc-name: kvtimeout - description: | + description: |- 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. @@ -441,9 +442,11 @@ components: type: integer format: int32 x-desc-name: max_parallelism_req - description: | + description: |- 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. + x-desc-more: |- The [node-level][max-parallelism-srv] `max-parallelism` setting specifies the ceiling for this parameter for a single node. If the request-level parameter is zero or negative, the parallelism for the query is set to the node-level setting. If the request-level parameter is greater than zero and less than the node-level setting, the request-level parameter overrides the node-level setting. @@ -454,11 +457,9 @@ components: 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. - The default value is the same as the number of partitions of the index selected for the query. - [max-parallelism-srv]: ../n1ql-rest-admin/index.html#max-parallelism-srv [queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism - x-desc-refs: | + x-desc-refs: |- [max-parallelism-srv]: #max-parallelism-srv [queryMaxParallelism]: #queryMaxParallelism x-has-example: true @@ -467,7 +468,7 @@ components: type: integer format: int32 x-desc-name: memory_quota_req - description: | + description: |- Specifies the maximum amount of memory the request may use, in MB. Specify `0` (the default value) to disable. @@ -478,7 +479,7 @@ components: Within a transaction, this setting enforces the memory quota for the transaction by tracking the delta table and the transaction log (approximately). - + x-desc-more: |- The [node-level][memory-quota-srv] `memory-quota` setting specifies the ceiling for this parameter for a single node. If the node-level setting is zero (the default), the request-level parameter overrides the node-level setting. If the node-level setting is greater than zero, the request-level parameter is capped by the node-level setting. @@ -488,7 +489,7 @@ components: [memory-quota-srv]: ../n1ql-rest-admin/index.html#memory-quota-srv [queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota - x-desc-refs: | + x-desc-refs: |- [memory-quota-srv]: #memory-quota-srv [queryMemoryQuota]: #queryMemoryQuota x-has-default: true @@ -515,20 +516,21 @@ components: type: integer format: int32 x-desc-name: numatrs_req - description: | + description: |- Specifies the total number of [active transaction records][additional-storage-use]. Must be a positive integer. + [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + x-desc-more: |- The [node-level][numatrs-srv] `numatrs` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. In addition, the [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies the default for this parameter for the whole cluster. When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv [queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs - x-desc-refs: | + x-desc-refs: |- [numatrs-srv]: #numatrs-srv [queryNumAtrs]: #queryNumAtrs x-has-default: true @@ -539,9 +541,9 @@ components: type: integer format: int32 x-desc-name: pipeline_batch_req - description: | + description: |- Controls the number of items execution operators can batch for Fetch from the KV. - + x-desc-more: |- The [node-level][pipeline-batch-srv] `pipeline-batch` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. @@ -550,7 +552,7 @@ components: [pipeline-batch-srv]: ../n1ql-rest-admin/index.html#pipeline-batch-srv [queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch - x-desc-refs: | + x-desc-refs: |- [pipeline-batch-srv]: #pipeline-batch-srv [queryPipelineBatch]: #queryPipelineBatch x-has-example: true @@ -559,9 +561,9 @@ components: type: integer format: int32 x-desc-name: pipeline_cap_req - description: | + description: |- Maximum number of items each execution operator can buffer between various operators. - + x-desc-more: |- The [node-level][pipeline-cap-srv] `pipeline-cap` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. @@ -570,7 +572,7 @@ components: [pipeline-cap-srv]: ../n1ql-rest-admin/index.html#pipeline-cap-srv [queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap - x-desc-refs: | + x-desc-refs: |- [pipeline-cap-srv]: #pipeline-cap-srv [queryPipelineCap]: #queryPipelineCap x-has-example: true @@ -578,7 +580,7 @@ components: prepared: type: string x-desc-name: prepared - description: | + description: |- _Required_ if `statement` not provided. The name of the prepared SQL++ statement to be executed. @@ -592,7 +594,7 @@ components: preserve_expiry: type: boolean x-desc-name: preserve_expiry - description: | + description: |- 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. @@ -608,21 +610,21 @@ components: pretty: type: boolean x-desc-name: pretty_req - description: | + description: |- Specifies the query results returned in pretty format. - + x-desc-more: |- The [node-level][pretty-srv] `pretty` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. [pretty-srv]: ../n1ql-rest-admin/index.html#pretty-srv - x-desc-refs: | + x-desc-refs: |- [pretty-srv]: #pretty-srv x-has-example: true example: false profile: type: string x-desc-name: profile_req - description: | + description: |- Specifies if there should be a profile section returned with the request results. The valid values are: @@ -637,12 +639,12 @@ components: 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. - + x-desc-more: |- The [node-level][profile-srv] `profile` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. [profile-srv]: ../n1ql-rest-admin/index.html#profile-srv - x-desc-refs: | + x-desc-refs: |- [profile-srv]: #profile-srv enum: ["off", "phases", "timings"] x-has-example: true @@ -650,7 +652,7 @@ components: query_context: type: string x-desc-name: query_context - description: | + description: |- 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. @@ -663,7 +665,7 @@ components: readonly: type: boolean x-desc-name: readonly - description: | + description: |- Controls whether a query can change a resulting recordset. If `readonly` is `true`, then the following statements are not allowed: @@ -684,13 +686,13 @@ components: type: integer format: int32 x-desc-name: scan_cap_req - description: | + description: |- 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. - + x-desc-more: |- The [node-level][scan-cap-srv] `scan-cap` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. @@ -699,7 +701,7 @@ components: [scan-cap-srv]: ../n1ql-rest-admin/index.html#scan-cap-srv [queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap - x-desc-refs: | + x-desc-refs: |- [scan-cap-srv]: #scan-cap-srv [queryScanCap]: #queryScanCap x-has-example: true @@ -707,7 +709,7 @@ components: scan_consistency: type: string x-desc-name: scan_consistency - description: | + description: |- Specifies the consistency guarantee or constraint for index scanning. The valid values are: @@ -736,7 +738,7 @@ components: 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](#tximplicit) parameter set to `true`, then this parameter sets the transactional scan consistency. + 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][transactional-scan-consistency] for details. [transactional-scan-consistency]: /server/7.6/n1ql/n1ql-manage/query-settings.html#transactional-scan-consistency @@ -749,7 +751,7 @@ components: type: object x-type: array x-desc-name: scan_vector - description: | + description: |- _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. @@ -779,7 +781,7 @@ components: type: object x-type: array x-desc-name: scan_vectors - description: | + description: |- _Required_ if `scan_consistency` is `at_plus` and `scan_vector` not provided. A map from keyspace names to scan vectors. @@ -790,7 +792,7 @@ components: type: string format: duration x-desc-name: scan_wait - description: | + description: |- 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. @@ -824,7 +826,7 @@ components: sort_projection: type: boolean x-desc-name: sort_projection - description: | + description: |- 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. @@ -835,7 +837,7 @@ components: statement: type: string x-desc-name: statement - description: | + description: |- _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. @@ -855,7 +857,7 @@ components: type: string format: duration x-desc-name: timeout_req - description: | + description: |- Maximum time to spend on the request before timing out. The value for this parameter is a string. @@ -872,9 +874,9 @@ components: 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](#tximplicit) or [txid](#txid) is set, this parameter is ignored. + If `tximplicit` or `txid` is set, this parameter is ignored. The request inherits the remaining time of the transaction as timeout. - + x-desc-more: |- The [node-level][timeout-srv] `timeout` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. However, if the node-level setting is greater than 0, the timeout for the query is limited to the node-level setting. @@ -884,7 +886,7 @@ components: [timeout-srv]: ../n1ql-rest-admin/index.html#timeout-srv [queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout - x-desc-refs: | + x-desc-refs: |- [timeout-srv]: #timeout-srv [queryTimeout]: #queryTimeout x-has-example: true @@ -892,14 +894,14 @@ components: txdata: type: object x-desc-name: txdata - description: | + description: |- Transaction data. For internal use only. txid: type: string format: UUID x-desc-name: txid - description: | + description: |- _Required_ for statements within a transaction. Transaction ID. @@ -913,14 +915,14 @@ components: tximplicit: type: boolean x-desc-name: tximplicit - description: | + description: |- 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](#txid) request-level parameter is set, the `tximplicit` parameter is ignored. + If the `txid` request-level parameter is set, the `tximplicit` parameter is ignored. x-has-default: true x-has-example: true default: false @@ -929,7 +931,7 @@ components: type: integer format: int32 x-desc-name: txstmtnum - description: | + description: |- 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. @@ -939,12 +941,12 @@ components: type: string format: duration x-desc-name: txtimeout_req - description: | + description: |- Maximum time to spend on a transaction before timing out. - Only applies to `BEGIN TRANSACTION` statements, or DML statements for which [tximplicit](#tximplicit) is set. + 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](#timeout_req) parameter 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. @@ -962,6 +964,8 @@ components: 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. + x-desc-more: |- The [node-level][txtimeout-srv] `txtimeout` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. However, if the node-level setting is greater than 0, the transaction timeout for the query is limited to the node-level setting. @@ -969,11 +973,9 @@ components: In addition, the [cluster-level][queryTxTimeout] `queryTxTimeout` setting specifies the default for this parameter for the whole cluster. When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - The default is `"15s"` for cbq files or scripts, `"2m"` for interactive cbq sessions or redirected input. - [txtimeout-srv]: ../n1ql-rest-admin/index.html#txtimeout-srv [queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout - x-desc-refs: | + x-desc-refs: |- [txtimeout-srv]: #txtimeout-srv [queryTxTimeout]: #queryTxTimeout x-has-example: true @@ -981,9 +983,9 @@ components: use_cbo: type: boolean x-desc-name: use_cbo_req - description: | + description: |- Specifies whether the cost-based optimizer is enabled. - + x-desc-more: |- The [node-level][use-cbo-srv] `use-cbo` setting specifies the default for this parameter for a single node. The request-level parameter overrides the node-level setting. @@ -992,7 +994,7 @@ components: [use-cbo-srv]: ../n1ql-rest-admin/index.html#use-cbo-srv [queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO - x-desc-refs: | + x-desc-refs: |- [use-cbo-srv]: #use-cbo-srv [queryUseCBO]: #queryUseCBO x-has-example: true @@ -1001,7 +1003,7 @@ components: type: boolean x-desc-name: use_fts x-desc-edition: "{enterprise}" - description: | + description: |- Specifies that the query should use a Search index. If the query contains a `USING FTS` hint, that takes priority over this parameter. @@ -1025,7 +1027,7 @@ components: default: unset example: on x-desc-name: use_replica_req - description: | + description: |- Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -1036,13 +1038,6 @@ components: * `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. - The [node-level][use-replica-srv] `use-replica` setting specifies the default for this property for a single node. - The request-level parameter usually overrides the node-level setting. - However, when the node-level setting is `off`, the request-level parameter cannot enable the property. - - In addition, the [cluster-level][queryUseReplica] `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. - Do not enable read from replica when you require consistent results. Only SELECT queries that are not within a transaction can read from replica. @@ -1050,16 +1045,23 @@ components: 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. + x-desc-more: |- + The [node-level][use-replica-srv] `use-replica` setting specifies the default for this property for a single node. + The request-level parameter usually overrides the node-level setting. + However, when the node-level setting is `off`, the request-level parameter cannot enable the property. + + In addition, the [cluster-level][queryUseReplica] `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. [use-replica-srv]: ../n1ql-rest-admin/index.html#use-replica-srv [queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica - x-desc-refs: | + x-desc-refs: |- [use-replica-srv]: #use-replica-srv [queryUseReplica]: #queryUseReplica additionalProperties: x-desc-name: identifier x-additionalPropertiesName: $identifier - description: | + description: |- Supplies the value for a named parameter in the statement. Applicable if the statement or prepared statement contains 1 or more named parameters. @@ -1183,7 +1185,7 @@ components: query.execute.index_not_found sev: type: integer - description: | + description: |- One of the following SQL++ severity levels, listed in order of severity: 1. Severe @@ -1291,7 +1293,7 @@ components: description: IP address and port number of the node where the query was executed. phaseCounts: type: object - description: | + description: |- Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. x-has-example: true example: @@ -1301,7 +1303,7 @@ components: } phaseOperators: type: object - description: | + description: |- 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. @@ -1318,7 +1320,7 @@ components: } phaseTimes: type: object - description: | + description: |- Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. x-has-example: true example: @@ -1334,7 +1336,7 @@ components: executionTimings: type: object title: Execution Timings - description: | + description: |- Present only if `profile` was set to `"timings"` in the [Request Parameters](#Request). The execution details for various phases involved in the query execution, such as kernel and service execution times, number of documents processed at each query operator in each phase, and number of phase switches. @@ -1385,7 +1387,7 @@ components: servTime: type: string format: duration - description: | + description: |- Time spent waiting for another service, such as index or data. For index scan, it is time spent waiting for GSI/indexer. @@ -1401,7 +1403,7 @@ components: Header: type: http scheme: basic - description: | + description: |- Specify a user name and password via HTTP headers. This method can only be used to provide a single credential. diff --git a/src/query-settings/swagger/query-settings.yaml b/src/query-settings/swagger/query-settings.yaml index 74a9ee04..65d20fd5 100644 --- a/src/query-settings/swagger/query-settings.yaml +++ b/src/query-settings/swagger/query-settings.yaml @@ -140,14 +140,14 @@ components: x-has-default: true x-has-example: true x-desc-name: queryCleanupClientAttempts - description: | + description: |- 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. - + x-desc-more: |- The [node-level][cleanupclientattempts] `cleanupclientattempts` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [cleanupclientattempts]: ../n1ql-rest-admin/index.html#cleanupclientattempts - x-desc-refs: | + x-desc-refs: |- [cleanupclientattempts]: #cleanupclientattempts queryCleanupLostAttempts: type: boolean @@ -156,14 +156,14 @@ components: x-has-default: true x-has-example: true x-desc-name: queryCleanupLostAttempts - description: | + description: |- When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client. - + x-desc-more: |- The [node-level][cleanuplostattempts] `cleanuplostattempts` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [cleanuplostattempts]: ../n1ql-rest-admin/index.html#cleanuplostattempts - x-desc-refs: | + x-desc-refs: |- [cleanuplostattempts]: #cleanuplostattempts queryCleanupWindow: type: string @@ -173,7 +173,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryCleanupWindow - description: | + description: |- Specifies how frequently the Query service checks its subset of [active transaction records][additional-storage-use] 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. @@ -188,12 +188,13 @@ components: * `m` (minutes) * `h` (hours) + [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + x-desc-more: |- The [node-level][cleanupwindow] `cleanupwindow` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [cleanupwindow]: ../n1ql-rest-admin/index.html#cleanupwindow - x-desc-refs: | + x-desc-refs: |- [cleanupwindow]: #cleanupwindow queryCompletedLimit: type: integer @@ -203,7 +204,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryCompletedLimit - description: | + description: |- Sets the number of requests to be logged in the completed requests catalog. As new completed requests are added, old ones are removed. @@ -211,12 +212,13 @@ components: Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. + [sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + x-desc-more: |- The [node-level][completed-limit] `completed-limit` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - [sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [completed-limit]: ../n1ql-rest-admin/index.html#completed-limit - x-desc-refs: | + x-desc-refs: |- [completed-limit]: #completed-limit queryCompletedMaxPlanSize: type: integer @@ -226,7 +228,7 @@ components: maximum: 20840448 x-has-default: true x-desc-name: queryCompletedMaxPlanSize - description: | + description: |- 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. @@ -235,12 +237,13 @@ components: Refer to [Configure the Completed Requests][sys-completed-config] for more information. + [sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + x-desc-more: |- The [node-level][completed-max-plan-size] `completed-max-plan-size` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - [sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [completed-max-plan-size]: ../n1ql-rest-admin/index.html#completed-max-plan-size - x-desc-refs: | + x-desc-refs: |- [completed-max-plan-size]: #completed-max-plan-size queryCompletedThreshold: type: integer @@ -250,7 +253,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryCompletedThreshold - description: | + description: |- A duration in milliseconds. All completed queries lasting longer than this threshold are logged in the completed requests catalog. @@ -259,12 +262,13 @@ components: Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. + [sys-completed-config]: /server/7.6/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + x-desc-more: |- The [node-level][completed-threshold] `completed-threshold` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - [sys-completed-config]: /server/7.6/manage/monitor/monitoring-n1ql-query.html#sys-completed-config [completed-threshold]: ../n1ql-rest-admin/index.html#completed-threshold - x-desc-refs: | + x-desc-refs: |- [completed-threshold]: #completed-threshold queryLogLevel: type: string @@ -274,7 +278,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryLogLevel - description: | + description: |- Log level used in the logger. All values, in descending order of data: @@ -298,12 +302,12 @@ components: Major items, like crashes. * `NONE` — Doesn't write anything. - + x-desc-more: |- The [node-level][loglevel] `loglevel` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [loglevel]: ../n1ql-rest-admin/index.html#loglevel - x-desc-refs: | + x-desc-refs: |- [loglevel]: #loglevel queryMaxParallelism: type: integer @@ -313,7 +317,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryMaxParallelism - description: | + description: |- Specifies the maximum parallelism for queries on all Query nodes in the cluster. If the value is zero or negative, the maximum parallelism is restricted to the number of allowed cores. @@ -323,6 +327,10 @@ components: 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.) + Refer to [Max Parallelism][max-parallelism] for more information. + + [max-parallelism]: /server/7.6/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism + x-desc-more: |- The [node-level][max-parallelism-srv] `max-parallelism` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -330,13 +338,10 @@ components: 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][max-parallelism] for more information. - [max-parallelism]: /server/7.6/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism [max-parallelism-srv]: ../n1ql-rest-admin/index.html#max-parallelism-srv [max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req - x-desc-refs: | + x-desc-refs: |- [max-parallelism-srv]: #max-parallelism-srv [max_parallelism_req]: #max_parallelism_req queryMemoryQuota: @@ -347,7 +352,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryMemoryQuota - description: | + description: |- Specifies the maximum amount of memory a request may use on any Query node in the cluster, in MB. This parameter enforces a ceiling on the memory used for the tracked documents required for processing a request. @@ -355,7 +360,7 @@ components: Within a transaction, this setting enforces the memory quota for the transaction by tracking the delta table and the transaction log (approximately). - + x-desc-more: |- The [node-level][memory-quota-srv] `memory-quota` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -364,22 +369,22 @@ components: [memory-quota-srv]: ../n1ql-rest-admin/index.html#memory-quota-srv [memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req - x-desc-refs: | + x-desc-refs: |- [memory-quota-srv]: #memory-quota-srv [memory_quota_req]: #memory_quota_req queryN1QLFeatCtrl: type: integer format: int32 x-desc-name: queryN1QLFeatCtrl - description: | + description: |- SQL++ feature control. This setting is provided for technical support only. - + x-desc-more: |- The [node-level][n1ql-feat-ctrl] `n1ql-feat-ctrl` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [n1ql-feat-ctrl]: ../n1ql-rest-admin/index.html#n1ql-feat-ctrl - x-desc-refs: | + x-desc-refs: |- [n1ql-feat-ctrl]: #n1ql-feat-ctrl queryNodeQuota: type: integer @@ -387,7 +392,7 @@ components: default: 0 x-has-default: true x-desc-name: queryNodeQuota - description: | + description: |- Sets the soft memory limit for the Query service on every Query node in the cluster, 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. @@ -400,12 +405,12 @@ components: - If the difference is greater than 8 GiB, the default soft memory limit is set to the total system RAM minus 8 GiB. - If the difference is 8 GiB or less, the default soft memory limit is set to 90% of the total system RAM. - + x-desc-more: |- The [node-level][node-quota] `node-quota` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [node-quota]: ../n1ql-rest-admin/index.html#node-quota - x-desc-refs: | + x-desc-refs: |- [node-quota]: #node-quota queryNodeQuotaValPercent: type: integer @@ -415,15 +420,15 @@ components: maximum: 100 x-has-default: true x-desc-name: queryNodeQuotaValPercent - description: | + description: |- The percentage of the `queryNodeQuota` that is dedicated to tracked value content memory across all active requests for every Query node in the cluster. (The `queryMemoryQuota` setting specifies the maximum amount of document memory an individual request may use on any Query node in the cluster.) - + x-desc-more: |- The [node-level][node-quota-val-percent] `node-quota-val-percent` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [node-quota-val-percent]: ../n1ql-rest-admin/index.html#node-quota-val-percent - x-desc-refs: | + x-desc-refs: |- [node-quota-val-percent]: #node-quota-val-percent queryNumAtrs: type: integer @@ -435,19 +440,20 @@ components: x-has-default: true x-has-example: true x-desc-name: queryNumAtrs - description: | + description: |- Specifies the total number of [active transaction records][additional-storage-use] for all Query nodes in the cluster. + [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries + x-desc-more: |- The [node-level][numatrs-srv] `numatrs` setting specifies this property for a single node. 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][numatrs_req] `numatrs` parameter. If a request includes this parameter, it will be capped by the node-level `numatrs` setting. - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv [numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req - x-desc-refs: | + x-desc-refs: |- [numatrs-srv]: #numatrs-srv [numatrs_req]: #numatrs_req queryNumCpus: @@ -456,7 +462,7 @@ components: default: 0 x-has-default: true x-desc-name: queryNumCpus - description: | + description: |- The number of CPUs the Query service can use on any Query node in the cluster. Note that this setting requires a restart of the Query service to take effect. @@ -465,12 +471,12 @@ components: 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. - + x-desc-more: |- The [node-level][num-cpus] `num-cpus` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [num-cpus]: ../n1ql-rest-admin/index.html#num-cpus - x-desc-refs: | + x-desc-refs: |- [num-cpus]: #num-cpus queryPipelineBatch: type: integer @@ -480,9 +486,9 @@ components: x-has-default: true x-has-example: true x-desc-name: queryPipelineBatch - description: | + description: |- Controls the number of items execution operators can batch for Fetch from the KV. - + x-desc-more: |- The [node-level][pipeline-batch-srv] `pipeline-batch` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -491,7 +497,7 @@ components: [pipeline-batch-srv]: ../n1ql-rest-admin/index.html#pipeline-batch-srv [pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req - x-desc-refs: | + x-desc-refs: |- [pipeline-batch-srv]: #pipeline-batch-srv [pipeline_batch_req]: #pipeline_batch_req queryPipelineCap: @@ -502,9 +508,9 @@ components: x-has-default: true x-has-example: true x-desc-name: queryPipelineCap - description: | + description: |- Maximum number of items each execution operator can buffer between various operators. - + x-desc-more: |- The [node-level][pipeline-cap-srv] `pipeline-cap` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -513,7 +519,7 @@ components: [pipeline-cap-srv]: ../n1ql-rest-admin/index.html#pipeline-cap-srv [pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req - x-desc-refs: | + x-desc-refs: |- [pipeline-cap-srv]: #pipeline-cap-srv [pipeline_cap_req]: #pipeline_cap_req queryPreparedLimit: @@ -524,15 +530,15 @@ components: x-has-default: true x-has-example: true x-desc-name: queryPreparedLimit - description: | + description: |- 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. - + x-desc-more: |- The [node-level][prepared-limit] `prepared-limit` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [prepared-limit]: ../n1ql-rest-admin/index.html#prepared-limit - x-desc-refs: | + x-desc-refs: |- [prepared-limit]: #prepared-limit queryScanCap: type: integer @@ -542,13 +548,13 @@ components: x-has-default: true x-has-example: true x-desc-name: queryScanCap - description: | + description: |- 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. - + x-desc-more: |- The [node-level][scan-cap-srv] `scan-cap` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -557,7 +563,7 @@ components: [scan-cap-srv]: ../n1ql-rest-admin/index.html#scan-cap-srv [scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req - x-desc-refs: | + x-desc-refs: |- [scan-cap-srv]: #scan-cap-srv [scan_cap_req]: #scan_cap_req queryTimeout: @@ -568,7 +574,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryTimeout - description: | + description: |- Maximum time to spend on the request before timing out (ns). The value for this setting is an integer, representing a duration in nanoseconds. @@ -576,7 +582,7 @@ components: 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. - + x-desc-more: |- The [node-level][timeout-srv] `timeout` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -585,7 +591,7 @@ components: [timeout-srv]: ../n1ql-rest-admin/index.html#timeout-srv [timeout_req]: ../n1ql-rest-query/index.html#timeout_req - x-desc-refs: | + x-desc-refs: |- [timeout-srv]: #timeout-srv [timeout_req]: #timeout_req queryTxTimeout: @@ -596,7 +602,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryTxTimeout - description: | + description: |- Maximum time to spend on a transaction before timing out. This setting only applies to requests containing the `BEGIN TRANSACTION` statement, or to requests where the [tximplicit][tximplicit] parameter is set. For all other requests, it is ignored. @@ -615,16 +621,17 @@ components: Specify `0ms` (the default value) to disable. When disabled, no timeout is applied and the transaction runs for however long it takes. + [tximplicit]: ../n1ql-rest-query/index.html#tximplicit + x-desc-more: |- The [node-level][txtimeout-srv] `txtimeout` setting specifies this property for a single node. 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][txtimeout_req] `txtimeout` parameter. If a request includes this parameter, it will be capped by the node-level `txtimeout` setting. - [tximplicit]: ../n1ql-rest-query/index.html#tximplicit [txtimeout-srv]: ../n1ql-rest-admin/index.html#txtimeout-srv [txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req - x-desc-refs: | + x-desc-refs: |- [tximplicit]: #tximplicit [txtimeout-srv]: #txtimeout-srv [txtimeout_req]: #txtimeout_req @@ -633,7 +640,7 @@ components: example: "/opt/couchbase/var/lib/couchbase/tmp" x-has-example: true x-desc-name: queryTmpSpaceDir - description: | + description: |- The path to which the indexer writes temporary backfill files, to store any transient data during query processing. The specified path must already exist. @@ -648,7 +655,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryTmpSpaceSize - description: | + description: |- The maximum size of temporary backfill files (MB). Setting the size to `0` disables backfill. @@ -662,9 +669,9 @@ components: x-has-default: true x-has-example: true x-desc-name: queryUseCBO - description: | + description: |- Specifies whether the cost-based optimizer is enabled. - + x-desc-more: |- The [node-level][use-cbo-srv] `use-cbo` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -673,7 +680,7 @@ components: [use-cbo-srv]: ../n1ql-rest-admin/index.html#use-cbo-srv [use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req - x-desc-refs: | + x-desc-refs: |- [use-cbo-srv]: #use-cbo-srv [use_cbo_req]: #use_cbo_req queryUseReplica: @@ -684,7 +691,7 @@ components: x-has-default: true x-has-example: true x-desc-name: queryUseReplica - description: | + description: |- Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -694,13 +701,6 @@ components: * `unset` — read from replica is enabled or disabled at request level. - The [node-level][use-replica-srv] `use-replica` setting specifies this property for a single node. - 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_replica_req] `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. @@ -708,10 +708,17 @@ components: 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. + x-desc-more: |- + The [node-level][use-replica-srv] `use-replica` setting specifies this property for a single node. + 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_replica_req] `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. [use-replica-srv]: ../n1ql-rest-admin/index.html#use-replica-srv [use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req - x-desc-refs: | + x-desc-refs: |- [use-replica-srv]: #use-replica-srv [use_replica_req]: #use_replica_req queryCurlWhitelist: @@ -726,7 +733,7 @@ components: properties: all_access: type: boolean - description: | + description: |- Defines whether the user has access to all URLs, or only URLs specified by the access list. This field set must be set to `false` to enable the `allowed_urls` and `disallowed_urls` fields. @@ -734,7 +741,7 @@ components: Setting this field to `true` enables access to all endpoints. allowed_urls: type: array - description: | + description: |- An array of strings, each of which is a URL to which you wish to grant access. Each URL is a prefix match. The CURL() function will allow any URL that starts with this value. @@ -748,7 +755,7 @@ components: type: string disallowed_urls: type: array - description: | + description: |- An array of strings, each of which is a URL that will be restricted for all roles. Each URL is a prefix match. The CURL() function will disallow any URL that starts with this value. @@ -764,7 +771,7 @@ components: Default: type: http scheme: basic - description: | + description: |- Users must have one of the following RBAC roles: * Full Admin diff --git a/templates/model.mustache b/templates/model.mustache index 847d5c67..c0d17631 100644 --- a/templates/model.mustache +++ b/templates/model.mustache @@ -29,7 +29,8 @@ a¦ {{>schemas}} {{/vars}} {{#additionalProperties}} {{! ADDITIONAL PROPERTY NAME }} -a¦ {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}}{{/vendorExtensions}} +a¦ {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}} +{{#x-additionalPropertiesName}}*{lt}{{this}}{gt}* +{{/x-additionalPropertiesName}}{{/vendorExtensions}} _additional + property_ {{! ADDITIONAL PROPERTY DESCRIPTION }} diff --git a/templates/property.mustache b/templates/property.mustache index f4f1cfa6..19eccde5 100644 --- a/templates/property.mustache +++ b/templates/property.mustache @@ -15,11 +15,26 @@ endif::alt-markdown-links[] {{#description}} {{{unescapedDescription}}} {{/description}} +{{#vendorExtensions}} +{{#x-desc-more}} + +{{{this}}} +{{/x-desc-more}} +{{/vendorExtensions}} {{! if ref is present, fetch remote description}} {{#ref}} include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{/ref}} -- +{{#vendorExtensions}} +{{#x-enumDescriptions}} + +.Enum Descriptions +.... +{{{this}}} +.... +{{/x-enumDescriptions}} +{{/vendorExtensions}} [%hardbreaks] {{! enumerated values}} @@ -80,4 +95,5 @@ include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{#vendorExtensions.x-has-example}} *Example:* `{{#isString}}+++"{{/isString}}{{{example}}}{{#isString}}"+++{{/isString}}` {{/vendorExtensions.x-has-example}} +{{! OpenAPI generator doesn't support externalDocs in schemas, so don't try }} {blank} \ No newline at end of file