From 3781769470bd0ed7f16977038abf318c1d058e5e Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 10 Jul 2025 17:13:35 +0100 Subject: [PATCH 1/9] Add support for extended descriptions --- templates/property.mustache | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/templates/property.mustache b/templates/property.mustache index f4f1cfa6..167ee440 100644 --- a/templates/property.mustache +++ b/templates/property.mustache @@ -15,11 +15,25 @@ 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}} + +.... +{{{this}}} +.... +{{/x-enumDescriptions}} +{{/vendorExtensions}} [%hardbreaks] {{! enumerated values}} From aaa0a76d4dbff6e23e0e978a162a155c116be0ae Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 10 Jul 2025 17:13:58 +0100 Subject: [PATCH 2/9] Add support for additional property names --- templates/model.mustache | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 }} From 90521a6a19caf05755d4059e3a52ce96219d692c Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 10 Jul 2025 18:36:23 +0100 Subject: [PATCH 3/9] Update Query specs --- src/admin/swagger/admin.yaml | 395 +++++++++--------- src/query-service/swagger/query-service.yaml | 182 ++++---- .../swagger/query-settings.yaml | 167 ++++---- 3 files changed, 381 insertions(+), 363 deletions(-) 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 From 68b8c71a6bd05e376a9398b919cf4b8165ffd253 Mon Sep 17 00:00:00 2001 From: tech-comm-team-couchbase Date: Thu, 10 Jul 2025 17:40:13 +0000 Subject: [PATCH 4/9] Build output documentation --- .../analytics-rest-admin/pages/index.adoc | 2 + .../analytics-rest-service/pages/index.adoc | 1 + .../fts-rest-advanced/pages/index.adoc | 1 + .../fts-rest-indexing/pages/index.adoc | 4 + docs/modules/fts-rest-nodes/pages/index.adoc | 5 + docs/modules/fts-rest-query/pages/index.adoc | 1 + .../modules/index-rest-stats/pages/index.adoc | 2 + docs/modules/n1ql-rest-admin/pages/index.adoc | 213 +++--------------- .../n1ql-rest-functions/pages/index.adoc | 1 + docs/modules/n1ql-rest-query/pages/index.adoc | 103 ++------- .../n1ql-rest-settings/pages/index.adoc | 88 ++------ 11 files changed, 97 insertions(+), 324 deletions(-) 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] From c59e1ae1a69793694929545e137b9938f4b55a36 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 10 Jul 2025 18:50:20 +0100 Subject: [PATCH 5/9] Minor tweak --- templates/property.mustache | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/templates/property.mustache b/templates/property.mustache index 167ee440..ff0b7e4f 100644 --- a/templates/property.mustache +++ b/templates/property.mustache @@ -29,6 +29,7 @@ include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{#vendorExtensions}} {{#x-enumDescriptions}} +.Enum Descriptions .... {{{this}}} .... @@ -94,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}} -{blank} \ No newline at end of file +{blank} +{{! OpenAPI generator doesn't support externalDocs in schemas, so don't try }} \ No newline at end of file From 48626c155eb6132d1a993e39832acabce0ddd8c7 Mon Sep 17 00:00:00 2001 From: tech-comm-team-couchbase Date: Thu, 10 Jul 2025 17:51:25 +0000 Subject: [PATCH 6/9] Build output documentation --- .../analytics-rest-admin/pages/index.adoc | 75 +++++++ .../analytics-rest-config/pages/index.adoc | 50 +++++ .../analytics-rest-library/pages/index.adoc | 4 + .../analytics-rest-links/pages/index.adoc | 43 ++++ .../analytics-rest-service/pages/index.adoc | 44 ++++ .../analytics-rest-settings/pages/index.adoc | 1 + .../eventing-rest-api/pages/index.adoc | 77 +++++++ .../fts-rest-advanced/pages/index.adoc | 33 +++ .../fts-rest-indexing/pages/index.adoc | 114 ++++++++++ docs/modules/fts-rest-manage/pages/index.adoc | 3 + docs/modules/fts-rest-nodes/pages/index.adoc | 81 +++++++ docs/modules/fts-rest-query/pages/index.adoc | 21 ++ docs/modules/fts-rest-stats/pages/index.adoc | 111 ++++++++++ .../modules/index-rest-stats/pages/index.adoc | 36 ++++ docs/modules/n1ql-rest-admin/pages/index.adoc | 203 ++++++++++++++++++ .../n1ql-rest-functions/pages/index.adoc | 5 + docs/modules/n1ql-rest-query/pages/index.adoc | 88 ++++++++ .../n1ql-rest-settings/pages/index.adoc | 28 +++ 18 files changed, 1017 insertions(+) diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index c5bfb933..1755f7d7 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -1586,6 +1586,7 @@ An array of objects, each giving information about a single linked Analytics sco [%hardbreaks] {blank} + a¦ xref:IngestionLink[] array @@ -1643,6 +1644,7 @@ The name of the link. [%hardbreaks] *Example:* `+++"Local"+++` {blank} + a¦ String @@ -1659,6 +1661,7 @@ The name of the Analytics scope. [%hardbreaks] *Example:* `+++"travel-sample/inventory"+++` {blank} + a¦ String @@ -1676,6 +1679,7 @@ The status of the Analytics scope. *Values:* `"healthy"`, `"stopped"`, `"unhealthy"`, `"suspended"` *Example:* `+++"healthy"+++` {blank} + a¦ String @@ -1694,6 +1698,7 @@ Analytics collections which have the same ingestion state within this Analytics [%hardbreaks] {blank} + a¦ xref:IngestionLinkState[] array @@ -1751,6 +1756,7 @@ The time since epoch that this sample was calculated, in milliseconds. [%hardbreaks] *Example:* `1631273689161` {blank} + a¦ Integer @@ -1769,6 +1775,7 @@ The percentage (fraction from 0 to 1) of ingestion progress at the current time. *Maximum:* `1` *Example:* `0` {blank} + a¦ Double (double) @@ -1786,6 +1793,7 @@ The estimated time that the ingestion lags behind the Data service, in milliseco [%hardbreaks] *Example:* `9744` {blank} + a¦ Integer @@ -1805,6 +1813,7 @@ Note that this value is reset on connect, so it may appear to get smaller. [%hardbreaks] *Example:* `12301` {blank} + a¦ Integer @@ -1822,6 +1831,7 @@ The change in sequence number (seqno) since last connect. Only displayed for Ana [%hardbreaks] *Example:* `61` {blank} + a¦ Integer @@ -1837,6 +1847,7 @@ An array of objects, each one giving information about a single Analytics scope. [%hardbreaks] {blank} + a¦ xref:IngestionLinkStateScope[] array @@ -1894,6 +1905,7 @@ The name of the Analytics scope. [%hardbreaks] *Example:* `+++"travel-sample/inventory"+++` {blank} + a¦ String @@ -1909,6 +1921,7 @@ An array of objects, each one giving information about a single Analytics collec [%hardbreaks] {blank} + a¦ xref:IngestionLinkStateScopeColl[] array @@ -1966,6 +1979,7 @@ The name of the Analytics collection. [%hardbreaks] *Example:* `+++"route"+++` {blank} + a¦ String @@ -2028,6 +2042,7 @@ include::index.adoc[tag=desc-MutationsColl, opts=optional] [%hardbreaks] {blank} + a¦ xref:MutationsColl[] @@ -2094,6 +2109,7 @@ The number of mutations in the DCP queue that have not yet been ingested. The na [%hardbreaks] {blank} + a¦ Integer @@ -2155,6 +2171,7 @@ Whether this request can be cancelled. [%hardbreaks] {blank} + a¦ Boolean @@ -2171,6 +2188,7 @@ A context ID for debugging purposes. [%hardbreaks] *Example:* `+++"28379d60-7139-44d6-b57a-95935540b586"+++` {blank} + a¦ String @@ -2187,6 +2205,7 @@ How long the request has been running in seconds. [%hardbreaks] *Example:* `0.126` {blank} + a¦ Big Decimal @@ -2203,6 +2222,7 @@ The date and time when the request's job was created. [%hardbreaks] *Example:* `+++"2024-05-28T19:47:02.512"+++` {blank} + a¦ String @@ -2220,6 +2240,7 @@ The request's job ID. This value can be null if request did not run (for example [%hardbreaks] *Example:* `+++"JID:0.14"+++` {blank} + a¦ String @@ -2236,6 +2257,7 @@ How long the request's job has been in the queue waiting to run in seconds. [%hardbreaks] *Example:* `0` {blank} + a¦ Big Decimal @@ -2252,6 +2274,7 @@ The number of CPU cores required to run this request. [%hardbreaks] *Example:* `1` {blank} + a¦ Integer @@ -2269,6 +2292,7 @@ The bytes of RAM being used to process this request. [%hardbreaks] *Example:* `34013184` {blank} + a¦ Integer @@ -2285,6 +2309,7 @@ The date and time the request's job began running. [%hardbreaks] *Example:* `+++"2024-05-28T19:47:02.514"+++` {blank} + a¦ String @@ -2302,6 +2327,7 @@ The state of the request's job. *Values:* `"PENDING"`, `"RUNNING"`, `"TERMINATED"`, `"FAILURE"`, `"FAILURE_BEFORE_EXECUTION"`, `"null"` *Example:* `+++"RUNNING"+++` {blank} + a¦ String @@ -2317,6 +2343,7 @@ The query plan for this request. [%hardbreaks] {blank} + a¦ String @@ -2333,6 +2360,7 @@ The Analytics node that received the request. [%hardbreaks] *Example:* `+++"172.20.0.2:8095"+++` {blank} + a¦ String @@ -2349,6 +2377,7 @@ The network address and port of the client that made the request. [%hardbreaks] *Example:* `+++"172.20.0.123:53612"+++` {blank} + a¦ String @@ -2365,6 +2394,7 @@ The date and time the request was received. [%hardbreaks] *Example:* `+++"2024-05-28T19:44:07.730"+++` {blank} + a¦ String @@ -2381,6 +2411,7 @@ The Scan Consistency setting used for the request's query. [%hardbreaks] *Example:* `+++"not_bounded"+++` {blank} + a¦ String @@ -2398,6 +2429,7 @@ The state of the request. *Values:* `"received"`, `"running"`, `"cancelled"`, `"completed"` *Example:* `+++"running"+++` {blank} + a¦ String @@ -2414,6 +2446,7 @@ The SQL++ query statement being run by the request. [%hardbreaks] *Example:* `+++"select count(*) from hotel_endorsement_view;"+++` {blank} + a¦ String @@ -2430,6 +2463,7 @@ The user agent string of the browser that made the request. [%hardbreaks] *Example:* `+++"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:126.0) Gecko/20100101 Firefox/126.0"+++` {blank} + a¦ String @@ -2446,6 +2480,7 @@ The user who made the request. [%hardbreaks] *Example:* `+++"Administrator"+++` {blank} + a¦ String @@ -2462,6 +2497,7 @@ The unique identifier for this request. [%hardbreaks] *Example:* `+++"91f60338-a3e0-4163-9287-5e723fda29ef"+++` {blank} + a¦ String @@ -2524,6 +2560,7 @@ An array of strings, each of which is the ID of an authorized Analytics node. [%hardbreaks] *Example:* `["86586a966202b5aa4aed31633f330aba","948fb3af810a9b7bc6c76e2a69ba35d9"]` {blank} + a¦ String array @@ -2540,6 +2577,7 @@ The ID of the cluster controller node. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} + a¦ String @@ -2556,6 +2594,7 @@ The path of the Analytics Node Configuration REST API. [%hardbreaks] *Example:* `+++"/analytics/config/node"+++` {blank} + a¦ String @@ -2573,6 +2612,7 @@ The path of the Analytics Node Diagnostics REST API. For internal use only. [%hardbreaks] *Example:* `+++"/analytics/node/diagnostics"+++` {blank} + a¦ String @@ -2589,6 +2629,7 @@ The path of the Analytics Node Restart REST API. [%hardbreaks] *Example:* `+++"/analytics/node/restart"+++` {blank} + a¦ String @@ -2605,6 +2646,7 @@ The path of the Analytics Query Service REST API. [%hardbreaks] *Example:* `+++"/analytics/service"+++` {blank} + a¦ String @@ -2621,6 +2663,7 @@ The path of the Analytics Service Configuration REST API. [%hardbreaks] *Example:* `+++"/analytics/config/service"+++` {blank} + a¦ String @@ -2638,6 +2681,7 @@ The full URI of the Analytics Service Diagnostics REST API. For internal use onl [%hardbreaks] *Example:* `+++"http://localhost:8095/analytics/cluster/diagnostics"+++` {blank} + a¦ String @@ -2654,6 +2698,7 @@ The full URI of the Analytics Cluster Restart REST API. [%hardbreaks] *Example:* `+++"http://localhost:8095/analytics/cluster/restart"+++` {blank} + a¦ String @@ -2671,6 +2716,7 @@ The state of the Analytics Service. *Values:* `"ACTIVE"`, `"REBALANCE_REQUIRED"`, `"UNUSABLE"`, `"SHUTTING_DOWN"` *Example:* `+++"ACTIVE"+++` {blank} + a¦ String @@ -2686,6 +2732,7 @@ An array of objects, each giving information about one Analytics node. [%hardbreaks] {blank} + a¦ xref:StatusNodes[] array @@ -2701,6 +2748,7 @@ An array of objects, each giving information about one Analytics partition. [%hardbreaks] {blank} + a¦ xref:StatusPartitions[] array @@ -2716,6 +2764,7 @@ include::index.adoc[tag=desc-StatusTopology, opts=optional] [%hardbreaks] {blank} + a¦ xref:StatusTopology[] @@ -2773,6 +2822,7 @@ The URI scheme, host, and port for HTTP access to Analytics REST APIs on this no [%hardbreaks] *Example:* `+++"http://192.168.8.101:8095"+++` {blank} + a¦ String @@ -2789,6 +2839,7 @@ The URI scheme, host, and port for secure HTTPS access to Analytics REST APIs on [%hardbreaks] *Example:* `+++"https://192.168.8.101:18095"+++` {blank} + a¦ String @@ -2805,6 +2856,7 @@ The ID of the node. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} + a¦ String @@ -2821,6 +2873,7 @@ The name or IP address of the node, including the cluster administration port. [%hardbreaks] *Example:* `+++"192.168.8.101:8091"+++` {blank} + a¦ String @@ -2878,6 +2931,7 @@ Indicates whether this partition is active. [%hardbreaks] *Example:* `true` {blank} + a¦ Boolean @@ -2894,6 +2948,7 @@ The ID of the node where this partition is currently active. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} + a¦ String @@ -2910,6 +2965,7 @@ The number of the IO Device where this partition is located. [%hardbreaks] *Example:* `0` {blank} + a¦ Integer @@ -2926,6 +2982,7 @@ The ID of the node where this partition originated. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} + a¦ String @@ -2942,6 +2999,7 @@ The ID of this partition. [%hardbreaks] *Example:* `0` {blank} + a¦ Integer @@ -2958,6 +3016,7 @@ The path of the IO Device where this partition is located. [%hardbreaks] *Example:* `+++"/data/@analytics/v_iodevice_0"+++` {blank} + a¦ String @@ -2974,6 +3033,7 @@ Indicates whether this partition is waiting to become active. [%hardbreaks] *Example:* `false` {blank} + a¦ Boolean @@ -3036,6 +3096,7 @@ Indicates whether the Analytics nodes are balanced. [%hardbreaks] *Example:* `true` {blank} + a¦ Boolean @@ -3052,6 +3113,7 @@ The ID of the cluster controller node. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} + a¦ String @@ -3068,6 +3130,7 @@ The ID of the metadata partition. [%hardbreaks] *Example:* `-1` {blank} + a¦ Integer @@ -3084,6 +3147,7 @@ The number of Analytics replicas. [%hardbreaks] *Example:* `1` {blank} + a¦ Integer @@ -3100,6 +3164,7 @@ The revision number of the partition topology. [%hardbreaks] *Example:* `1` {blank} + a¦ Integer @@ -3116,6 +3181,7 @@ The version number of the partition topology. [%hardbreaks] *Example:* `1` {blank} + a¦ Integer @@ -3131,6 +3197,7 @@ An array of objects, each giving information about the state of one Analytics pa [%hardbreaks] {blank} + a¦ xref:StatusTopologyState[] array @@ -3188,6 +3255,7 @@ The partition ID. [%hardbreaks] *Example:* `0` {blank} + a¦ Integer @@ -3204,6 +3272,7 @@ The ID of the node where the partition is currently active. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} + a¦ String @@ -3220,6 +3289,7 @@ The ID of the node where the partition originated. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} + a¦ String @@ -3235,6 +3305,7 @@ An array of objects, each giving information about the state of one Analytics re [%hardbreaks] {blank} + a¦ xref:StatusTopologyStateReplicas[] array @@ -3292,6 +3363,7 @@ The name or IP address of the node where this replica is located, including the [%hardbreaks] *Example:* `+++"192.168.8.102:9120"+++` {blank} + a¦ String @@ -3308,6 +3380,7 @@ The ID of the node where this replica is located. [%hardbreaks] *Example:* `+++"948fb3af810a9b7bc6c76e2a69ba35d9"+++` {blank} + a¦ String @@ -3325,6 +3398,7 @@ The synchronization status of the replica. *Values:* `"IN_SYNC"`, `"CATCHING_UP"`, `"DISCONNECTED"` *Example:* `+++"IN_SYNC"+++` {blank} + a¦ String @@ -3343,6 +3417,7 @@ The percentage (fraction from 0 to 1) of synchronization progress for this repli *Maximum:* `1` *Example:* `1` {blank} + a¦ Double (double) diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc index 3adc1689..69fd8f4c 100644 --- a/docs/modules/analytics-rest-config/pages/index.adoc +++ b/docs/modules/analytics-rest-config/pages/index.adoc @@ -958,6 +958,7 @@ An error message. [%hardbreaks] {blank} + a¦ String @@ -1025,6 +1026,7 @@ To pass arguments opaquely, you may use [Java command-line argument files][3]. [%hardbreaks] {blank} + a¦ String @@ -1043,6 +1045,7 @@ The default is 1/4 of the allocated Analytics Service memory. [%hardbreaks] {blank} + a¦ Integer @@ -1061,6 +1064,7 @@ The default is 1/4 of the allocated Analytics Service memory. [%hardbreaks] {blank} + a¦ Integer @@ -1118,6 +1122,7 @@ The memory budget (in bytes) for the active runtime. [%hardbreaks] *Default:* `67108864` {blank} + a¦ Integer (int32) @@ -1134,6 +1139,7 @@ The maximum time (in seconds) to wait for a graceful stop of an active runtime. [%hardbreaks] *Default:* `3600` {blank} + a¦ Integer (int32) @@ -1150,6 +1156,7 @@ The maximum time (in seconds) to wait for a graceful suspend of an active runtim [%hardbreaks] *Default:* `3600` {blank} + a¦ Integer (int32) @@ -1166,6 +1173,7 @@ The number of processed mutations after which the DCP state is broadcast to stor [%hardbreaks] *Default:* `10000` {blank} + a¦ Integer (int32) @@ -1182,6 +1190,7 @@ The maximum number of HTTP requests to queue pending ability to execute. [%hardbreaks] *Default:* `256` {blank} + a¦ Integer (int32) @@ -1198,6 +1207,7 @@ The number of threads to service HTTP requests. [%hardbreaks] *Default:* `16` {blank} + a¦ Integer (int32) @@ -1213,6 +1223,7 @@ The bind address to use. [%hardbreaks] {blank} + a¦ String @@ -1229,6 +1240,7 @@ Bind to configured hostname instead of wildcard address. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -1245,6 +1257,7 @@ Number of attempts to contact CC before giving up. [%hardbreaks] *Default:* `5` {blank} + a¦ Integer (int32) @@ -1261,6 +1274,7 @@ The maximum time to wait to collect DCP state from all nodes in seconds. [%hardbreaks] *Default:* `600` {blank} + a¦ Integer (int32) @@ -1277,6 +1291,7 @@ The page size (in bytes) for computation. [%hardbreaks] *Default:* `32768` {blank} + a¦ Integer (int32) @@ -1293,6 +1308,7 @@ The memory budget (in bytes) for a group by operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} + a¦ Integer (int32) @@ -1309,6 +1325,7 @@ The memory budget (in bytes) for a join operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} + a¦ Integer (int32) @@ -1326,6 +1343,7 @@ The degree of parallelism for query execution. Zero means to use the storage par [%hardbreaks] *Default:* `0` {blank} + a¦ Integer (int32) @@ -1342,6 +1360,7 @@ Enables or disables full parallel sort. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -1358,6 +1377,7 @@ The memory budget (in bytes) for a sort operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} + a¦ Integer (int32) @@ -1374,6 +1394,7 @@ The memory budget (in bytes) for a window operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} + a¦ Integer (int32) @@ -1390,6 +1411,7 @@ The factor to multiply by the number of cores to determine maximum query concurr [%hardbreaks] *Default:* `3` {blank} + a¦ Integer (int32) @@ -1409,6 +1431,7 @@ The percentage of DCP connection buffer size at which to acknowledge bytes consu *Minimum:* `1` *Maximum:* `100` {blank} + a¦ Integer (int32) @@ -1426,6 +1449,7 @@ Reconnect remote DCP channels that are idle for the specified number of seconds [%hardbreaks] *Default:* `120` {blank} + a¦ Integer (int32) @@ -1444,6 +1468,7 @@ Otherwise, the default is 1% of the JVM maximum heap size divided by the number [%hardbreaks] {blank} + a¦ Integer (int32) @@ -1460,6 +1485,7 @@ The delay (in seconds) to wait for graceful shutdown due to deadlocked threads, [%hardbreaks] *Default:* `120` {blank} + a¦ Integer (int32) @@ -1476,6 +1502,7 @@ The frequency (in seconds) to scan for deadlocked threads. [%hardbreaks] *Default:* `300` {blank} + a¦ Integer (int32) @@ -1492,6 +1519,7 @@ Limits the number of historical jobs remembered by the system to the specified v [%hardbreaks] *Default:* `10` {blank} + a¦ Integer (int32) @@ -1508,6 +1536,7 @@ The maximum number of jobs to queue before rejecting new jobs. [%hardbreaks] *Default:* `4096` {blank} + a¦ Integer (int32) @@ -1531,6 +1560,7 @@ To pass arguments opaquely, you may use [Java command-line argument files][3]. [%hardbreaks] {blank} + a¦ String @@ -1547,6 +1577,7 @@ The logging level. [%hardbreaks] *Default:* `+++"DEBUG"+++` {blank} + a¦ String @@ -1563,6 +1594,7 @@ The maximum accepted web request size in bytes. [%hardbreaks] *Default:* `52428800` {blank} + a¦ Integer (int32) @@ -1579,6 +1611,7 @@ Number of network buffers per input/output channel. [%hardbreaks] *Default:* `1` {blank} + a¦ Integer (int32) @@ -1595,6 +1628,7 @@ Number of threads to use for Network I/O. [%hardbreaks] *Default:* `1` {blank} + a¦ Integer (int32) @@ -1611,6 +1645,7 @@ The frequency at which the Analytics collection size is pulled from nodes during [%hardbreaks] *Default:* `5` {blank} + a¦ Integer (int32) @@ -1628,6 +1663,7 @@ The maximum time (in seconds) to wait for a remote link connection to establish. [%hardbreaks] *Default:* `60` {blank} + a¦ Integer (int32) @@ -1645,6 +1681,7 @@ The maximum time (in seconds) to wait after establishing the connection for remo [%hardbreaks] *Default:* `60` {blank} + a¦ Integer (int32) @@ -1661,6 +1698,7 @@ The maximum number of archived requests to maintain. [%hardbreaks] *Default:* `50` {blank} + a¦ Integer (int32) @@ -1677,6 +1715,7 @@ The duration within which an instance of the result cleanup should be invoked in [%hardbreaks] *Default:* `60000` {blank} + a¦ Integer (int32) @@ -1693,6 +1732,7 @@ Limits the amount of time results for asynchronous jobs should be retained by th [%hardbreaks] *Default:* `86400000` {blank} + a¦ Integer (int32) @@ -1709,6 +1749,7 @@ The maximum number of open files in the buffer cache. [%hardbreaks] *Default:* `2147483647` {blank} + a¦ Integer (int32) @@ -1725,6 +1766,7 @@ The page size in bytes for pages in the buffer cache. [%hardbreaks] *Default:* `131072` {blank} + a¦ Integer (int32) @@ -1741,6 +1783,7 @@ The default compression scheme for the storage. [%hardbreaks] *Default:* `+++"snappy"+++` {blank} + a¦ String @@ -1757,6 +1800,7 @@ The number of memory components to be used per LSM index. [%hardbreaks] *Default:* `2` {blank} + a¦ Integer (int32) @@ -1773,6 +1817,7 @@ The page size in bytes for pages allocated to memory components. [%hardbreaks] *Default:* `131072` {blank} + a¦ Integer (int32) @@ -1790,6 +1835,7 @@ The maximum disk write rate for each storage partition in bytes per second. Disa [%hardbreaks] *Default:* `0` {blank} + a¦ Long (int64) @@ -1806,6 +1852,7 @@ The frequency (in seconds) at which to log diagnostic thread dumps. [%hardbreaks] *Default:* `300` {blank} + a¦ Integer (int32) @@ -1822,6 +1869,7 @@ The log level at which to emit diagnostic thread dumps. [%hardbreaks] *Default:* `+++"DEBUG"+++` {blank} + a¦ String @@ -1839,6 +1887,7 @@ Categories for tracing. The default is the empty array — no categories. [%hardbreaks] *Default:* `[]` {blank} + a¦ String array @@ -1855,6 +1904,7 @@ The interval (in seconds) after which an Analytics collection is considered idle [%hardbreaks] *Default:* `3600` {blank} + a¦ Integer (int32) diff --git a/docs/modules/analytics-rest-library/pages/index.adoc b/docs/modules/analytics-rest-library/pages/index.adoc index d6dac74d..7e286ad4 100644 --- a/docs/modules/analytics-rest-library/pages/index.adoc +++ b/docs/modules/analytics-rest-library/pages/index.adoc @@ -876,6 +876,7 @@ An error message. [%hardbreaks] {blank} + a¦ String @@ -936,6 +937,7 @@ The scope name may contain one or two identifiers, separated by a slash (/). [%hardbreaks] *Example:* `+++"travel-sample/inventory"+++` {blank} + a¦ String @@ -951,6 +953,7 @@ A MD5 hash of the library residing on the server. [%hardbreaks] {blank} + a¦ String @@ -967,6 +970,7 @@ The name of the library. [%hardbreaks] *Example:* `+++"mylib"+++` {blank} + a¦ String diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc index 379d5527..ad3a9b35 100644 --- a/docs/modules/analytics-rest-links/pages/index.adoc +++ b/docs/modules/analytics-rest-links/pages/index.adoc @@ -4103,6 +4103,7 @@ The scope name may contain one or two identifiers, separated by a slash (/). [%hardbreaks] *Example:* `+++"travel-sample/inventory"+++` {blank} + a¦ String @@ -4119,6 +4120,7 @@ The name of the link. [%hardbreaks] *Example:* `+++"myLink"+++` {blank} + a¦ String @@ -4140,6 +4142,7 @@ The type of the link. [%hardbreaks] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} + a¦ String @@ -4257,6 +4260,7 @@ The account key. Used for shared key authentication. This is redacted for the sa [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -4274,6 +4278,7 @@ The account name. Used for shared key authentication. If not set, this property [%hardbreaks] *Example:* `+++"myAccountName"+++` {blank} + a¦ String @@ -4291,6 +4296,7 @@ The client certificate for the registered application. Used for Azure Active Dir [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -4308,6 +4314,7 @@ The client certificate password for the registered application. Used for Azure A [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -4325,6 +4332,7 @@ The client ID for the registered application. Used for Azure Active Directory cl [%hardbreaks] *Example:* `+++"myClientID"+++` {blank} + a¦ String @@ -4342,6 +4350,7 @@ The client secret for the registered application. Used for Azure Active Director [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -4358,6 +4367,7 @@ The endpoint URI. [%hardbreaks] *Example:* `+++"my.endpoint.uri"+++` {blank} + a¦ String @@ -4375,6 +4385,7 @@ The managed identity ID. Used for managed identity authentication. If not set, t [%hardbreaks] *Example:* `+++"myManagedIdentityID"+++` {blank} + a¦ String @@ -4392,6 +4403,7 @@ A token that can be used for authentication. Used for shared access signature au [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -4409,6 +4421,7 @@ The tenant ID where the registered application is created. Used for Azure Active [%hardbreaks] *Example:* `+++"myTenantID"+++` {blank} + a¦ String @@ -4503,6 +4516,7 @@ The remote hostname. [%hardbreaks] *Example:* `+++"remoteHostName:8091"+++` {blank} + a¦ String @@ -4519,6 +4533,7 @@ Specifies whether the provided (bootstrap) hostname is an alternative address. [%hardbreaks] *Example:* `false` {blank} + a¦ Boolean @@ -4535,6 +4550,7 @@ The provided (bootstrap) hostname. [%hardbreaks] *Example:* `+++"remoteHostName:8091"+++` {blank} + a¦ String @@ -4551,6 +4567,7 @@ The content of the target cluster root certificate. Only set for links with full [%hardbreaks] {blank} + a¦ String @@ -4567,6 +4584,7 @@ The content of the client certificate. Only set for links with full encryption u [%hardbreaks] {blank} + a¦ String @@ -4583,6 +4601,7 @@ The content of the client key. Only set for links with full encryption using cli [%hardbreaks] {blank} + a¦ String @@ -4599,6 +4618,7 @@ For internal use only. [%hardbreaks] *Example:* `393221` {blank} + a¦ Integer @@ -4620,6 +4640,7 @@ The type of encryption used by the link. [%hardbreaks] *Values:* `"none"`, `"half"`, `"full"` {blank} + a¦ String @@ -4635,6 +4656,7 @@ An array of objects, each of which contains information about a node in the targ [%hardbreaks] {blank} + a¦ xref:ResponseCouchbaseSpecificNode[] array @@ -4652,6 +4674,7 @@ The password used to connect to the link. This is redacted for the sake of secur [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -4669,6 +4692,7 @@ The remote username. Not set for links with full encryption using client certifi [%hardbreaks] *Example:* `+++"remote.user"+++` {blank} + a¦ String @@ -4685,6 +4709,7 @@ A UUID uniquely identifying the link. [%hardbreaks] *Example:* `+++"6331e2a390125b662f7bcfd63ecb3a73"+++` {blank} + a¦ UUID (UUID) @@ -4742,6 +4767,7 @@ The alternate address defined on the node, if any. If not defined, this property [%hardbreaks] {blank} + a¦ String @@ -4758,6 +4784,7 @@ The hostname of the node. If not defined, this property returns `null`. [%hardbreaks] {blank} + a¦ String @@ -4773,6 +4800,7 @@ include::index.adoc[tag=desc-ResponseCouchbaseSpecificNodeServices, opts=optiona [%hardbreaks] {blank} + a¦ xref:ResponseCouchbaseSpecificNodeServices[] @@ -4835,6 +4863,7 @@ The port number for a connection to the Analytics service. [%hardbreaks] *Example:* `8095` {blank} + a¦ Integer @@ -4851,6 +4880,7 @@ The port number for an encrypted connection to the Analytics service. [%hardbreaks] *Example:* `18095` {blank} + a¦ Integer @@ -4867,6 +4897,7 @@ The port number for a connection to the Data service. [%hardbreaks] *Example:* `11210` {blank} + a¦ Integer @@ -4883,6 +4914,7 @@ The port number for an encrypted connection to the Data service. [%hardbreaks] *Example:* `11207` {blank} + a¦ Integer @@ -4899,6 +4931,7 @@ The port number for a connection to the Cluster Manager service. [%hardbreaks] *Example:* `8091` {blank} + a¦ Integer @@ -4915,6 +4948,7 @@ The port number for an encrypted connection to the Cluster Manager service. [%hardbreaks] *Example:* `18091` {blank} + a¦ Integer @@ -5011,6 +5045,7 @@ If present, indicates that the link should use the Google Application Default Cr *Values:* `"true"` *Example:* `+++"true"+++` {blank} + a¦ String @@ -5028,6 +5063,7 @@ The endpoint URI. If not set, this property returns `null`. [%hardbreaks] *Example:* `+++"https://storage.googleapis.com"+++` {blank} + a¦ String @@ -5045,6 +5081,7 @@ The JSON credentials of the link. If not set, this property returns `null`. [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -5139,6 +5176,7 @@ The Amazon S3 access key ID. [%hardbreaks] *Example:* `+++"myAccessKey"+++` {blank} + a¦ String @@ -5155,6 +5193,7 @@ The Amazon S3 region. [%hardbreaks] *Example:* `+++"us-east-1"+++` {blank} + a¦ String @@ -5172,6 +5211,7 @@ The Amazon S3 secret access key. This is redacted for the sake of security. [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -5189,6 +5229,7 @@ The Amazon S3 session token. Indicates that the link has temporary access, and t [%hardbreaks] *Example:* `+++""+++` {blank} + a¦ String @@ -5206,6 +5247,7 @@ Amazon S3 service endpoint. If not set, this property returns `null`. [%hardbreaks] *Example:* `+++"my.endpoint.uri"+++` {blank} + a¦ String @@ -5262,6 +5304,7 @@ An error message. [%hardbreaks] {blank} + a¦ String diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index 61345e26..bffeda95 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -1082,6 +1082,7 @@ Specifies at least one valid SQL\+\+ for Analytics statement to run. [%hardbreaks] {blank} + a¦ String @@ -1098,6 +1099,7 @@ An identifier passed by the client that is returned verbatim in the query respon [%hardbreaks] {blank} + a¦ String @@ -1118,6 +1120,7 @@ Note that the only possible format is `JSON`. *Values:* `"JSON"` *Default:* `+++"JSON"+++` {blank} + a¦ String @@ -1134,6 +1137,7 @@ If `true`, the result is indented. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -1151,6 +1155,7 @@ A scope for the statement. The value of this parameter must start with `default: [%hardbreaks] *Default:* `+++"default:Default"+++` {blank} + a¦ String @@ -1167,6 +1172,7 @@ If `true`, then DDL statements are not allowed. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -1185,6 +1191,7 @@ The consistency guarantee constraint for index scanning. If `not_bounded`, the q *Values:* `"not_bounded"`, `"request_plus"` *Default:* `+++"not_bounded"+++` {blank} + a¦ String @@ -1202,6 +1209,7 @@ The maximum time to wait for datasets to be updated before the query is executed [%hardbreaks] *Default:* `+++""+++` {blank} + a¦ String @@ -1219,6 +1227,7 @@ Maximum time to spend on the request before timing out. The format includes an a [%hardbreaks] *Default:* `+++""+++` {blank} + a¦ String @@ -1234,6 +1243,7 @@ An array of positional parameter values. [%hardbreaks] {blank} + a¦ Any Type array @@ -1250,6 +1260,7 @@ A named parameter value. [%hardbreaks] {blank} + a¦ Any Type @@ -1308,6 +1319,7 @@ The plan format. *Values:* `"JSON"`, `"STRING"` *Default:* `+++"JSON"+++` {blank} + a¦ String @@ -1324,6 +1336,7 @@ If `true`, the logical plan is included in the query response. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -1340,6 +1353,7 @@ If `true`, the optimized logical plan is included in the query response. [%hardbreaks] *Default:* `true` {blank} + a¦ Boolean @@ -1356,6 +1370,7 @@ If `true`, the expression tree is included in the query response. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -1372,6 +1387,7 @@ If `true`, the rewritten expression tree is included in the query response. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -1388,6 +1404,7 @@ If `true`, the job details are included in the query response. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -1404,6 +1421,7 @@ An integer specifying the maximum number of warning messages to be included in t [%hardbreaks] *Default:* `0` {blank} + a¦ Integer (int32) @@ -1497,6 +1515,7 @@ A unique identifier for the response. [%hardbreaks] {blank} + a¦ UUID (UUID) @@ -1519,6 +1538,7 @@ refer to `client_context_id` in [Query Parameters][1]. [%hardbreaks] {blank} + a¦ String @@ -1535,6 +1555,7 @@ The schema of the results. Present only when the query completes successfully. [%hardbreaks] {blank} + a¦ Object @@ -1551,6 +1572,7 @@ An array of all the objects returned by the query. An object can be any JSON val [%hardbreaks] {blank} + a¦ Any Type array @@ -1567,6 +1589,7 @@ The status of the request. [%hardbreaks] *Values:* `"success"`, `"running"`, `"failed"`, `"timeout"`, `"fatal"` {blank} + a¦ String @@ -1583,6 +1606,7 @@ An array of error objects. Present only if 1 or more errors are returned during [%hardbreaks] {blank} + a¦ xref:ResponsesCommonErrors[] array @@ -1610,6 +1634,7 @@ By default, no warnings are returned, even if warnings have occurred during proc [%hardbreaks] {blank} + a¦ xref:ResponsesCommonWarnings[] array @@ -1625,6 +1650,7 @@ include::index.adoc[tag=desc-ResponsesCommonYardsticks, opts=optional] [%hardbreaks] {blank} + a¦ xref:ResponsesCommonYardsticks[] @@ -1681,6 +1707,7 @@ A number that identifies the error. [%hardbreaks] {blank} + a¦ Integer @@ -1697,6 +1724,7 @@ A message describing the error in detail. Refer to [Error Codes](/server/7.6/ana [%hardbreaks] {blank} + a¦ String @@ -1753,6 +1781,7 @@ A number that identifies the warning. [%hardbreaks] {blank} + a¦ Integer @@ -1768,6 +1797,7 @@ A message describing the warning in detail. [%hardbreaks] {blank} + a¦ String @@ -1830,6 +1860,7 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} + a¦ String @@ -1846,6 +1877,7 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} + a¦ String @@ -1861,6 +1893,7 @@ The total number of objects in the results. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1876,6 +1909,7 @@ The total number of bytes in the results. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1891,6 +1925,7 @@ The number of errors that occurred during the request. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1906,6 +1941,7 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1962,6 +1998,7 @@ include::index.adoc[tag=desc-ResponsesLocalPlans, opts=optional] [%hardbreaks] {blank} + a¦ xref:ResponsesLocalPlans[] @@ -1977,6 +2014,7 @@ include::index.adoc[tag=desc-ResponsesLocalYardsticks, opts=optional] [%hardbreaks] {blank} + a¦ xref:ResponsesLocalYardsticks[] @@ -2038,6 +2076,7 @@ The logical plan. [%hardbreaks] {blank} + a¦ Object @@ -2053,6 +2092,7 @@ The optimized logical plan. [%hardbreaks] {blank} + a¦ Object @@ -2068,6 +2108,7 @@ The rewritten expression tree. [%hardbreaks] {blank} + a¦ String @@ -2083,6 +2124,7 @@ The expression tree. [%hardbreaks] {blank} + a¦ String @@ -2098,6 +2140,7 @@ The job details. [%hardbreaks] {blank} + a¦ Object @@ -2159,6 +2202,7 @@ Number of processed tuples during query execution. [%hardbreaks] {blank} + a¦ Long (int64) diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc index a3baf6f4..3356326a 100644 --- a/docs/modules/analytics-rest-settings/pages/index.adoc +++ b/docs/modules/analytics-rest-settings/pages/index.adoc @@ -585,6 +585,7 @@ Specifies the number of replicas for Analytics. *Maximum:* `3` *Example:* `3` {blank} + a¦ Integer diff --git a/docs/modules/eventing-rest-api/pages/index.adoc b/docs/modules/eventing-rest-api/pages/index.adoc index 530f8516..2f8b7d35 100644 --- a/docs/modules/eventing-rest-api/pages/index.adoc +++ b/docs/modules/eventing-rest-api/pages/index.adoc @@ -7100,6 +7100,7 @@ a¦ [%hardbreaks] {blank} + a¦ xref:depcfg_schema_buckets_inner[] array @@ -7114,6 +7115,7 @@ a¦ [%hardbreaks] {blank} + a¦ xref:depcfg_schema_curl_inner[] array @@ -7130,6 +7132,7 @@ bucket to store eventing checkpoints and timers [%hardbreaks] *Minimum length:* `1` {blank} + a¦ String @@ -7145,6 +7148,7 @@ scope to store eventing checkpoints and timers [%hardbreaks] {blank} + a¦ String @@ -7160,6 +7164,7 @@ collection to store eventing checkpoints and timers [%hardbreaks] {blank} + a¦ String @@ -7176,6 +7181,7 @@ bucket to listen to for document mutations [%hardbreaks] *Minimum length:* `1` {blank} + a¦ String @@ -7191,6 +7197,7 @@ scope to listen to for document mutations [%hardbreaks] {blank} + a¦ String @@ -7206,6 +7213,7 @@ collection to listen to for document mutations [%hardbreaks] {blank} + a¦ String @@ -7220,6 +7228,7 @@ a¦ [%hardbreaks] {blank} + a¦ xref:depcfg_schema_constants_inner[] array @@ -7279,6 +7288,7 @@ alias name of the constant binding *Minimum length:* `1` *Maximum length:* `64` {blank} + a¦ String @@ -7295,6 +7305,7 @@ literal value bound to the alias name [%hardbreaks] *Minimum length:* `1` {blank} + a¦ String @@ -7354,6 +7365,7 @@ symbolic name used in code to refer to this binding *Minimum length:* `1` *Maximum length:* `64` {blank} + a¦ String @@ -7370,6 +7382,7 @@ name of the bucket this binding maps to [%hardbreaks] *Minimum length:* `1` {blank} + a¦ String @@ -7385,6 +7398,7 @@ name of the scope this binding maps to [%hardbreaks] {blank} + a¦ String @@ -7400,6 +7414,7 @@ name of the collection this binding maps to [%hardbreaks] {blank} + a¦ String @@ -7416,6 +7431,7 @@ bucket access level (read or read+write) [%hardbreaks] *Values:* `"r"`, `"rw"` {blank} + a¦ String @@ -7474,6 +7490,7 @@ full URL (including any path) that this binding connects *Pattern:* `+++/^https?:\/\//+++` *Minimum length:* `1` {blank} + a¦ URI (uri) @@ -7492,6 +7509,7 @@ symbolic name used in code to refer to this binding *Minimum length:* `1` *Maximum length:* `64` {blank} + a¦ String @@ -7508,6 +7526,7 @@ http authentication method to use with this endpoint [%hardbreaks] *Values:* `"no-auth"`, `"basic"`, `"bearer"`, `"digest"` {blank} + a¦ String @@ -7523,6 +7542,7 @@ username for http auth methods that use it [%hardbreaks] {blank} + a¦ String @@ -7538,6 +7558,7 @@ password for http auth methods that use it [%hardbreaks] {blank} + a¦ String @@ -7553,6 +7574,7 @@ bearer key for bearer auth [%hardbreaks] {blank} + a¦ String @@ -7568,6 +7590,7 @@ allow cookies on the session [%hardbreaks] {blank} + a¦ Boolean @@ -7583,6 +7606,7 @@ validate remote server certificate using OS mechanisms [%hardbreaks] {blank} + a¦ Boolean @@ -7640,6 +7664,7 @@ handler code [%hardbreaks] *Minimum length:* `1` {blank} + a¦ String @@ -7655,6 +7680,7 @@ include::index.adoc[tag=desc-depcfg_schema, opts=optional] [%hardbreaks] {blank} + a¦ xref:depcfg_schema[] @@ -7671,6 +7697,7 @@ authoring tool. use 'external' if authored or edited outside eventing ui [%hardbreaks] *Pattern:* `+++/^evt-[5-7].[0-9]+.[0-9]+-[0-9]{4}-(ee|ce)$/+++` {blank} + a¦ String @@ -7686,6 +7713,7 @@ enforces stricter validation for all settings and configuration fields. [%hardbreaks] {blank} + a¦ Boolean @@ -7702,6 +7730,7 @@ unique id of the the handler. generated by server [%hardbreaks] *Minimum:* `0` {blank} + a¦ Integer @@ -7718,6 +7747,7 @@ unique id of the deployment of the handler. generated by server [%hardbreaks] *Minimum length:* `0` {blank} + a¦ String @@ -7735,6 +7765,7 @@ a¦ *Minimum length:* `1` *Maximum length:* `100` {blank} + a¦ String @@ -7750,6 +7781,7 @@ include::index.adoc[tag=desc-settings_schema, opts=optional] [%hardbreaks] {blank} + a¦ xref:settings_schema[] @@ -7765,6 +7797,7 @@ include::index.adoc[tag=desc-function_scope_schema, opts=optional] [%hardbreaks] {blank} + a¦ xref:function_scope_schema[] @@ -7827,6 +7860,7 @@ bucket to which function belongs [%hardbreaks] *Minimum length:* `1` {blank} + a¦ String @@ -7843,6 +7877,7 @@ scope to which function belongs [%hardbreaks] *Minimum length:* `1` {blank} + a¦ String @@ -7900,6 +7935,7 @@ number of threads each worker utilizes [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -7916,6 +7952,7 @@ indicates where to start dcp stream from (beginning of time, present point) 'fro [%hardbreaks] *Values:* `"everything"`, `"from_now"` {blank} + a¦ String @@ -7931,6 +7968,7 @@ indicates if the function is deployed. true=deployed, false=undeployed [%hardbreaks] {blank} + a¦ Boolean @@ -7946,6 +7984,7 @@ free form text for user to describe the handler. no functional role [%hardbreaks] {blank} + a¦ String @@ -7962,6 +8001,7 @@ maximum time the handler can run before it is forcefully terminated (in seconds) [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -7978,6 +8018,7 @@ The maximum time the checkpoint writer can run before it is forcefully terminate [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -7994,6 +8035,7 @@ maximum time the OnDeploy handler can run before it is terminated (in seconds) [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -8010,6 +8052,7 @@ eventing language version this handler assumes in terms of syntax and behavior [%hardbreaks] *Values:* `"6.6.2"`, `"6.0.0"`, `"6.5.0"`, `"7.2.0"` {blank} + a¦ String @@ -8026,6 +8069,7 @@ maximum number of libcouchbase connections that may be opened and pooled [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -8042,6 +8086,7 @@ number of retries of retriable libcouchbase failures. 0 keeps trying till execut [%hardbreaks] *Minimum:* `0` {blank} + a¦ Integer @@ -8058,6 +8103,7 @@ maximum time the lcb command is waited until completion before we terminate the [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -8074,6 +8120,7 @@ level of detail in system logging [%hardbreaks] *Values:* `"INFO"`, `"ERROR"`, `"WARNING"`, `"DEBUG"`, `"TRACE"` {blank} + a¦ String @@ -8090,6 +8137,7 @@ consistency level used by n1ql statements in the handler [%hardbreaks] *Values:* `"none"`, `"request"` {blank} + a¦ String @@ -8106,6 +8154,7 @@ number of timer shards. defaults to number of vbuckets [%hardbreaks] *Values:* `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, `256`, `512`, `1024` {blank} + a¦ Integer @@ -8121,6 +8170,7 @@ indicates if the function is running (i.e., not paused). true=running, false=pau [%hardbreaks] {blank} + a¦ Boolean @@ -8137,6 +8187,7 @@ batch size for messages from producer to consumer. normally, this must not be sp [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -8152,6 +8203,7 @@ duration to log stats from this handler, in milliseconds [%hardbreaks] {blank} + a¦ Integer @@ -8169,6 +8221,7 @@ size limit of timer context object *Minimum:* `20` *Maximum:* `20971520` {blank} + a¦ Integer @@ -8185,6 +8238,7 @@ key prefix for all data stored in metadata by this handler [%hardbreaks] *Minimum length:* `1` {blank} + a¦ String @@ -8201,6 +8255,7 @@ number of worker processes handler utilizes on each eventing node [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -8216,6 +8271,7 @@ automatically prepare all n1ql statements in the handler [%hardbreaks] {blank} + a¦ Boolean @@ -8231,6 +8287,7 @@ code to automatically prepend to top of handler code [%hardbreaks] {blank} + a¦ String array @@ -8246,6 +8303,7 @@ code to automatically append to bottom of handler code [%hardbreaks] {blank} + a¦ String array @@ -8261,6 +8319,7 @@ enable rotating this handlers log() message files [%hardbreaks] {blank} + a¦ Boolean @@ -8276,6 +8335,7 @@ directory to write content of log() message files [%hardbreaks] {blank} + a¦ String @@ -8292,6 +8352,7 @@ rotate logs when file grows to this size in bytes approximately [%hardbreaks] *Minimum:* `1024` {blank} + a¦ Integer @@ -8308,6 +8369,7 @@ number of log() message files to retain when rotating [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -8324,6 +8386,7 @@ number of seconds before writing a progress checkpoint [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -8340,6 +8403,7 @@ maximum size in bytes the bucket cache can grow to [%hardbreaks] *Minimum:* `20971520` {blank} + a¦ Integer @@ -8356,6 +8420,7 @@ time in milliseconds after which a cached bucket object is considered stale [%hardbreaks] *Minimum:* `1` {blank} + a¦ Integer @@ -8371,6 +8436,7 @@ maximum allowable curl call response in 'MegaBytes'. Setting the value to 0 lift [%hardbreaks] {blank} + a¦ Integer @@ -8386,6 +8452,7 @@ allow staged transaction mutations [%hardbreaks] {blank} + a¦ Boolean @@ -8409,6 +8476,7 @@ You must ensure that none of the documents which contain your own working data h [%hardbreaks] {blank} + a¦ Boolean @@ -8428,6 +8496,7 @@ Note that enabling this setting may have a noticeable impact on the performance [%hardbreaks] {blank} + a¦ Boolean @@ -8443,6 +8512,7 @@ number of milliseconds before checking for high seq number [%hardbreaks] {blank} + a¦ Integer @@ -8458,6 +8528,7 @@ max MBs to wait to send more bytes to c++ side [%hardbreaks] {blank} + a¦ Integer @@ -8473,6 +8544,7 @@ max number of messages on c++ side [%hardbreaks] {blank} + a¦ Integer @@ -8488,6 +8560,7 @@ number of milliseconds before sending message to c++ side [%hardbreaks] {blank} + a¦ Integer @@ -8503,6 +8576,7 @@ number of parallel vb request per cpp thread [%hardbreaks] {blank} + a¦ Integer @@ -8561,6 +8635,7 @@ The memory allocation for the Eventing Service, per node. *Default:* `256` *Example:* `512` {blank} + a¦ Integer @@ -8578,6 +8653,7 @@ For details, see [Debugging and Diagnosability](/server/7.6/eventing/eventing-de [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -8600,6 +8676,7 @@ Decreasing this setting prevents further cursor-aware Eventing functions from be *Minimum:* `1` *Maximum:* `20` {blank} + a¦ Integer diff --git a/docs/modules/fts-rest-advanced/pages/index.adoc b/docs/modules/fts-rest-advanced/pages/index.adoc index 8d0a64f8..df083982 100644 --- a/docs/modules/fts-rest-advanced/pages/index.adoc +++ b/docs/modules/fts-rest-advanced/pages/index.adoc @@ -1197,6 +1197,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -1212,6 +1213,7 @@ The document count for the specified index. [%hardbreaks] {blank} + a¦ Integer @@ -1268,6 +1270,7 @@ include::index.adoc[tag=desc-indexPartitionPIndex, opts=optional] [%hardbreaks] {blank} + a¦ xref:indexPartitionPIndex[] @@ -1283,6 +1286,7 @@ The status of the request. [%hardbreaks] {blank} + a¦ String @@ -1345,6 +1349,7 @@ include::index.adoc[tag=desc-indexPartitionPIndexInner, opts=optional] [%hardbreaks] {blank} + a¦ xref:indexPartitionPIndexInner[] @@ -1408,6 +1413,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -1424,6 +1430,7 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} + a¦ Object @@ -1440,6 +1447,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -1456,6 +1464,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -1471,6 +1480,7 @@ The name of the Search index partition. [%hardbreaks] {blank} + a¦ String @@ -1487,6 +1497,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -1503,6 +1514,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ Object @@ -1517,6 +1529,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -1533,6 +1546,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -1549,6 +1563,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -1564,6 +1579,7 @@ The UUID of the Search index partition. [%hardbreaks] {blank} + a¦ String @@ -1621,6 +1637,7 @@ For more information, see [Query Object](../search/search-request-params.html#qu [%hardbreaks] {blank} + a¦ Object @@ -1637,6 +1654,7 @@ For more information, see [Knn Objects](../search/search-request-params.html#knn [%hardbreaks] {blank} + a¦ Object array @@ -1653,6 +1671,7 @@ For more information, see [Ctl Object](../search/search-request-params.html#ctl) [%hardbreaks] {blank} + a¦ Object @@ -1668,6 +1687,7 @@ Set the total number of results to return for a single page of search results. [%hardbreaks] {blank} + a¦ Integer @@ -1683,6 +1703,7 @@ Set an offset value to change where pagination starts for search results. [%hardbreaks] {blank} + a¦ Integer @@ -1699,6 +1720,7 @@ For more information, see [Highlight Objects](../search/search-request-params.ht [%hardbreaks] {blank} + a¦ Object @@ -1714,6 +1736,7 @@ An array of strings to specify each indexed field you want to return in search r [%hardbreaks] {blank} + a¦ String array @@ -1730,6 +1753,7 @@ For more information, see [Facet Objects](../search/search-request-params.html#f [%hardbreaks] {blank} + a¦ Object @@ -1745,6 +1769,7 @@ Whether to create an explanation for a search result's score in search results. [%hardbreaks] {blank} + a¦ Boolean @@ -1761,6 +1786,7 @@ For more information, see [Sort Object](../search/search-request-params.html#sor [%hardbreaks] {blank} + a¦ Any Type array @@ -1776,6 +1802,7 @@ Whether to return the position of each occurrence of a search term inside a docu [%hardbreaks] {blank} + a¦ Boolean @@ -1791,6 +1818,7 @@ Whether to include document relevancy scoring in search results. [%hardbreaks] {blank} + a¦ String @@ -1806,6 +1834,7 @@ Use to control pagination in search results. [%hardbreaks] {blank} + a¦ String array @@ -1821,6 +1850,7 @@ Use to control pagination in search results. [%hardbreaks] {blank} + a¦ String array @@ -1836,6 +1866,7 @@ An array of strings that specify the collections where you want to run the query [%hardbreaks] {blank} + a¦ String array @@ -1892,6 +1923,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -1907,6 +1939,7 @@ The results of the Search query. [%hardbreaks] {blank} + a¦ Object array diff --git a/docs/modules/fts-rest-indexing/pages/index.adoc b/docs/modules/fts-rest-indexing/pages/index.adoc index ebd68375..e2e85e08 100644 --- a/docs/modules/fts-rest-indexing/pages/index.adoc +++ b/docs/modules/fts-rest-indexing/pages/index.adoc @@ -5187,6 +5187,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -5203,6 +5204,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -5259,6 +5261,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -5274,6 +5277,7 @@ An array of objects containing the analysis of the document. [%hardbreaks] {blank} + a¦ xref:DocumentAnalysisItem[] array @@ -5336,6 +5340,7 @@ include::index.adoc[tag=desc-DocumentAnalysisItemToken, opts=optional] [%hardbreaks] {blank} + a¦ xref:DocumentAnalysisItemToken[] @@ -5397,6 +5402,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -5412,6 +5418,7 @@ An array of objects describing the locations of the search term or token in the [%hardbreaks] {blank} + a¦ xref:DocumentAnalysisItemTokenLocation[] array @@ -5473,6 +5480,7 @@ The field in the document where the token was found. [%hardbreaks] {blank} + a¦ String @@ -5487,6 +5495,7 @@ a¦ [%hardbreaks] {blank} + a¦ Any Type array @@ -5502,6 +5511,7 @@ The starting point of the token in the field. [%hardbreaks] {blank} + a¦ Integer @@ -5517,6 +5527,7 @@ The ending point of the token in the field. [%hardbreaks] {blank} + a¦ Integer @@ -5532,6 +5543,7 @@ The position of the token in the field. [%hardbreaks] {blank} + a¦ Integer @@ -5588,6 +5600,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -5603,6 +5616,7 @@ The document count for the specified index. [%hardbreaks] {blank} + a¦ Integer @@ -5659,6 +5673,7 @@ include::index.adoc[tag=desc-IndexDefinition, opts=optional] [%hardbreaks] {blank} + a¦ xref:IndexDefinition[] @@ -5674,6 +5689,7 @@ An array of objects, each containing information about a single Search index par [%hardbreaks] {blank} + a¦ xref:GetIndexResponsePIndex[] array @@ -5689,6 +5705,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -5704,6 +5721,7 @@ An array of warnings. [%hardbreaks] {blank} + a¦ String array @@ -5766,6 +5784,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -5782,6 +5801,7 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} + a¦ Object @@ -5798,6 +5818,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -5814,6 +5835,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -5829,6 +5851,7 @@ The name of the Search index partition. [%hardbreaks] {blank} + a¦ String @@ -5844,6 +5867,7 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] [%hardbreaks] {blank} + a¦ xref:GetIndexResponsePIndexNodesWrapper[] @@ -5860,6 +5884,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -5876,6 +5901,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ Object @@ -5890,6 +5916,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -5906,6 +5933,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -5922,6 +5950,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -5937,6 +5966,7 @@ The UUID of the Search index partition. [%hardbreaks] {blank} + a¦ String @@ -5999,6 +6029,7 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapperNode, opts=option [%hardbreaks] {blank} + a¦ xref:GetIndexResponsePIndexNodesWrapperNode[] @@ -6060,6 +6091,7 @@ a¦ [%hardbreaks] {blank} + a¦ Boolean @@ -6074,6 +6106,7 @@ a¦ [%hardbreaks] {blank} + a¦ Boolean @@ -6088,6 +6121,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -6144,6 +6178,7 @@ include::index.adoc[tag=desc-GetIndexesResponseIndexes, opts=optional] [%hardbreaks] {blank} + a¦ xref:GetIndexesResponseIndexes[] @@ -6159,6 +6194,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -6219,6 +6255,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -6234,6 +6271,7 @@ include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] [%hardbreaks] {blank} + a¦ xref:GetIndexesResponseIndexesWrapper[] @@ -6248,6 +6286,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -6310,6 +6349,7 @@ include::index.adoc[tag=desc-IndexDefinition, opts=optional] [%hardbreaks] {blank} + a¦ xref:IndexDefinition[] @@ -6373,6 +6413,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -6389,6 +6430,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -6405,6 +6447,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -6421,6 +6464,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -6437,6 +6481,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ Object @@ -6453,6 +6498,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -6469,6 +6515,7 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} + a¦ Object @@ -6484,6 +6531,7 @@ include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] [%hardbreaks] {blank} + a¦ xref:IndexDefinitionPlanParams[] @@ -6500,6 +6548,7 @@ Intended for clients that want to check that they are not overwriting the Search [%hardbreaks] {blank} + a¦ String @@ -6516,6 +6565,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -6577,6 +6627,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -6593,6 +6644,7 @@ Use `indexPartitions` instead. [%hardbreaks] {blank} + a¦ Integer @@ -6608,6 +6660,7 @@ The number of partitions to split the Search index into, across the nodes you ha [%hardbreaks] {blank} + a¦ Integer @@ -6622,6 +6675,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -6637,6 +6691,7 @@ The number of replicas the Search Service creates for the Search index to ensure [%hardbreaks] {blank} + a¦ Integer @@ -6651,6 +6706,7 @@ a¦ [%hardbreaks] {blank} + a¦ Boolean @@ -6707,6 +6763,7 @@ The document ID to look up in the Search index. [%hardbreaks] {blank} + a¦ String @@ -6763,6 +6820,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -6778,6 +6836,7 @@ include::index.adoc[tag=desc-LookupResponsePartitions, opts=optional] [%hardbreaks] {blank} + a¦ xref:LookupResponsePartitions[] @@ -6840,6 +6899,7 @@ include::index.adoc[tag=desc-LookupResponsePartitionsID, opts=optional] [%hardbreaks] {blank} + a¦ xref:LookupResponsePartitionsID[] @@ -6902,6 +6962,7 @@ The Search index partition ID. [%hardbreaks] {blank} + a¦ String @@ -6958,6 +7019,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -7014,6 +7076,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -7030,6 +7093,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -7046,6 +7110,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -7103,6 +7168,7 @@ For more information, see [Query Object](../search/search-request-params.html#qu [%hardbreaks] {blank} + a¦ Object @@ -7119,6 +7185,7 @@ For more information, see [Knn Objects](../search/search-request-params.html#knn [%hardbreaks] {blank} + a¦ Object array @@ -7135,6 +7202,7 @@ For more information, see [Ctl Object](../search/search-request-params.html#ctl) [%hardbreaks] {blank} + a¦ Object @@ -7150,6 +7218,7 @@ Set the total number of results to return for a single page of search results. [%hardbreaks] {blank} + a¦ Integer @@ -7165,6 +7234,7 @@ Set an offset value to change where pagination starts for search results. [%hardbreaks] {blank} + a¦ Integer @@ -7181,6 +7251,7 @@ For more information, see [Highlight Objects](../search/search-request-params.ht [%hardbreaks] {blank} + a¦ Object @@ -7196,6 +7267,7 @@ An array of strings to specify each indexed field you want to return in search r [%hardbreaks] {blank} + a¦ String array @@ -7212,6 +7284,7 @@ For more information, see [Facet Objects](../search/search-request-params.html#f [%hardbreaks] {blank} + a¦ Object @@ -7227,6 +7300,7 @@ Whether to create an explanation for a search result's score in search results. [%hardbreaks] {blank} + a¦ Boolean @@ -7243,6 +7317,7 @@ For more information, see [Sort Object](../search/search-request-params.html#sor [%hardbreaks] {blank} + a¦ Any Type array @@ -7258,6 +7333,7 @@ Whether to return the position of each occurrence of a search term inside a docu [%hardbreaks] {blank} + a¦ Boolean @@ -7273,6 +7349,7 @@ Whether to include document relevancy scoring in search results. [%hardbreaks] {blank} + a¦ String @@ -7288,6 +7365,7 @@ Use to control pagination in search results. [%hardbreaks] {blank} + a¦ String array @@ -7303,6 +7381,7 @@ Use to control pagination in search results. [%hardbreaks] {blank} + a¦ String array @@ -7318,6 +7397,7 @@ An array of strings that specify the collections where you want to run the query [%hardbreaks] {blank} + a¦ String array @@ -7374,6 +7454,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -7389,6 +7470,7 @@ The results of the Search query. [%hardbreaks] {blank} + a¦ Object array @@ -7444,6 +7526,7 @@ a¦ [%hardbreaks] {blank} + a¦ Object @@ -7458,6 +7541,7 @@ a¦ [%hardbreaks] {blank} + a¦ Object @@ -7513,6 +7597,7 @@ a¦ [%hardbreaks] {blank} + a¦ Object @@ -7528,6 +7613,7 @@ include::index.adoc[tag=desc-StatsNodeResponseMgr, opts=optional] [%hardbreaks] {blank} + a¦ xref:StatsNodeResponseMgr[] @@ -7542,6 +7628,7 @@ a¦ [%hardbreaks] {blank} + a¦ Object @@ -7597,6 +7684,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7611,6 +7699,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7625,6 +7714,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7639,6 +7729,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7653,6 +7744,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7667,6 +7759,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7681,6 +7774,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7695,6 +7789,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7709,6 +7804,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7723,6 +7819,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7737,6 +7834,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7751,6 +7849,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7765,6 +7864,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7779,6 +7879,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7793,6 +7894,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7807,6 +7909,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7821,6 +7924,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7835,6 +7939,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7849,6 +7954,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7863,6 +7969,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7877,6 +7984,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7891,6 +7999,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7905,6 +8014,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7919,6 +8029,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7933,6 +8044,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -7989,6 +8101,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -8004,6 +8117,7 @@ The status of the Search index. [%hardbreaks] {blank} + a¦ String diff --git a/docs/modules/fts-rest-manage/pages/index.adoc b/docs/modules/fts-rest-manage/pages/index.adoc index a240073e..57cc72ce 100644 --- a/docs/modules/fts-rest-manage/pages/index.adoc +++ b/docs/modules/fts-rest-manage/pages/index.adoc @@ -433,6 +433,7 @@ If the value is `true`, partitions are created by means of partition build, from [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -490,6 +491,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -506,6 +508,7 @@ The error message, if the operation was not successful. [%hardbreaks] {blank} + a¦ String diff --git a/docs/modules/fts-rest-nodes/pages/index.adoc b/docs/modules/fts-rest-nodes/pages/index.adoc index 69705b61..46dad428 100644 --- a/docs/modules/fts-rest-nodes/pages/index.adoc +++ b/docs/modules/fts-rest-nodes/pages/index.adoc @@ -2219,6 +2219,7 @@ include::index.adoc[tag=desc-clusterConfigIndexes, opts=optional] [%hardbreaks] {blank} + a¦ xref:clusterConfigIndexes[] @@ -2234,6 +2235,7 @@ Search index definition concurrency (compare and swap) value. [%hardbreaks] {blank} + a¦ Integer @@ -2249,6 +2251,7 @@ Search index definition error. [%hardbreaks] {blank} + a¦ String @@ -2264,6 +2267,7 @@ include::index.adoc[tag=desc-clusterConfigNodesKnown, opts=optional] [%hardbreaks] {blank} + a¦ xref:clusterConfigNodesKnown[] @@ -2279,6 +2283,7 @@ Known node definition concurrency (compare and swap) value. [%hardbreaks] {blank} + a¦ Integer @@ -2294,6 +2299,7 @@ Known node definition error. [%hardbreaks] {blank} + a¦ String @@ -2309,6 +2315,7 @@ include::index.adoc[tag=desc-clusterConfigNodesWanted, opts=optional] [%hardbreaks] {blank} + a¦ xref:clusterConfigNodesWanted[] @@ -2324,6 +2331,7 @@ Wanted node definition concurrency (compare and swap) value. [%hardbreaks] {blank} + a¦ Integer @@ -2339,6 +2347,7 @@ Wanted node definition error. [%hardbreaks] {blank} + a¦ String @@ -2354,6 +2363,7 @@ include::index.adoc[tag=desc-clusterConfigPlan, opts=optional] [%hardbreaks] {blank} + a¦ xref:clusterConfigPlan[] @@ -2369,6 +2379,7 @@ Search index partition concurrency (compare and swap) value. [%hardbreaks] {blank} + a¦ Integer @@ -2384,6 +2395,7 @@ Search index partition error. [%hardbreaks] {blank} + a¦ String @@ -2399,6 +2411,7 @@ The status of the operation. [%hardbreaks] {blank} + a¦ String @@ -2459,6 +2472,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2474,6 +2488,7 @@ include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] [%hardbreaks] {blank} + a¦ xref:GetIndexesResponseIndexesWrapper[] @@ -2534,6 +2549,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2549,6 +2565,7 @@ include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] [%hardbreaks] {blank} + a¦ xref:clusterConfigNodesWrapper[] @@ -2563,6 +2580,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2623,6 +2641,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2638,6 +2657,7 @@ include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] [%hardbreaks] {blank} + a¦ xref:clusterConfigNodesWrapper[] @@ -2652,6 +2672,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2714,6 +2735,7 @@ include::index.adoc[tag=desc-clusterConfigNodesWrapperNode, opts=optional] [%hardbreaks] {blank} + a¦ xref:clusterConfigNodesWrapperNode[] @@ -2775,6 +2797,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2789,6 +2812,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2803,6 +2827,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2817,6 +2842,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2831,6 +2857,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2845,6 +2872,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2859,6 +2887,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -2919,6 +2948,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2934,6 +2964,7 @@ include::index.adoc[tag=desc-clusterConfigPlanWrapper, opts=optional] [%hardbreaks] {blank} + a¦ xref:clusterConfigPlanWrapper[] @@ -2948,6 +2979,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -2963,6 +2995,7 @@ include::index.adoc[tag=desc-GetIndexResponsePlanWrng, opts=optional] [%hardbreaks] {blank} + a¦ xref:GetIndexResponsePlanWrng[] @@ -3025,6 +3058,7 @@ include::index.adoc[tag=desc-GetIndexResponsePIndex, opts=optional] [%hardbreaks] {blank} + a¦ xref:GetIndexResponsePIndex[] @@ -3087,6 +3121,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3103,6 +3138,7 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} + a¦ Object @@ -3119,6 +3155,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3135,6 +3172,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3150,6 +3188,7 @@ The name of the Search index partition. [%hardbreaks] {blank} + a¦ String @@ -3165,6 +3204,7 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] [%hardbreaks] {blank} + a¦ xref:GetIndexResponsePIndexNodesWrapper[] @@ -3181,6 +3221,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3197,6 +3238,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ Object @@ -3211,6 +3253,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -3227,6 +3270,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3243,6 +3287,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3258,6 +3303,7 @@ The UUID of the Search index partition. [%hardbreaks] {blank} + a¦ String @@ -3320,6 +3366,7 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapperNode, opts=option [%hardbreaks] {blank} + a¦ xref:GetIndexResponsePIndexNodesWrapperNode[] @@ -3381,6 +3428,7 @@ a¦ [%hardbreaks] {blank} + a¦ Boolean @@ -3395,6 +3443,7 @@ a¦ [%hardbreaks] {blank} + a¦ Boolean @@ -3409,6 +3458,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -3471,6 +3521,7 @@ include::index.adoc[tag=desc-GetIndexResponsePlanWrngIndex, opts=optional] [%hardbreaks] {blank} + a¦ xref:GetIndexResponsePlanWrngIndex[] @@ -3519,6 +3570,7 @@ The name of the property is the name of the Search index. [%hardbreaks] {blank} + .Schema String @@ -3577,6 +3629,7 @@ include::index.adoc[tag=desc-IndexDefinition, opts=optional] [%hardbreaks] {blank} + a¦ xref:IndexDefinition[] @@ -3640,6 +3693,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3656,6 +3710,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3672,6 +3727,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3688,6 +3744,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3704,6 +3761,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ Object @@ -3720,6 +3778,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3736,6 +3795,7 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} + a¦ Object @@ -3751,6 +3811,7 @@ include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] [%hardbreaks] {blank} + a¦ xref:IndexDefinitionPlanParams[] @@ -3767,6 +3828,7 @@ Intended for clients that want to check that they are not overwriting the Search [%hardbreaks] {blank} + a¦ String @@ -3783,6 +3845,7 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} + a¦ String @@ -3844,6 +3907,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -3860,6 +3924,7 @@ Use `indexPartitions` instead. [%hardbreaks] {blank} + a¦ Integer @@ -3875,6 +3940,7 @@ The number of partitions to split the Search index into, across the nodes you ha [%hardbreaks] {blank} + a¦ Integer @@ -3889,6 +3955,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -3904,6 +3971,7 @@ The number of replicas the Search Service creates for the Search index to ensure [%hardbreaks] {blank} + a¦ Integer @@ -3918,6 +3986,7 @@ a¦ [%hardbreaks] {blank} + a¦ Boolean @@ -3973,6 +4042,7 @@ a¦ [%hardbreaks] {blank} + a¦ Object array @@ -3987,6 +4057,7 @@ a¦ [%hardbreaks] {blank} + a¦ Object array @@ -4043,6 +4114,7 @@ The architecture of the node. [%hardbreaks] {blank} + a¦ String @@ -4058,6 +4130,7 @@ include::index.adoc[tag=desc-runtimeInfoGo, opts=optional] [%hardbreaks] {blank} + a¦ xref:runtimeInfoGo[] @@ -4073,6 +4146,7 @@ The number of CPUs on the node. [%hardbreaks] {blank} + a¦ Integer @@ -4088,6 +4162,7 @@ The operating system of the node. [%hardbreaks] {blank} + a¦ String @@ -4102,6 +4177,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -4116,6 +4192,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -4171,6 +4248,7 @@ a¦ [%hardbreaks] {blank} + a¦ Integer @@ -4185,6 +4263,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -4199,6 +4278,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -4213,6 +4293,7 @@ a¦ [%hardbreaks] {blank} + a¦ String diff --git a/docs/modules/fts-rest-query/pages/index.adoc b/docs/modules/fts-rest-query/pages/index.adoc index d01f7a1d..e82a7ab4 100644 --- a/docs/modules/fts-rest-query/pages/index.adoc +++ b/docs/modules/fts-rest-query/pages/index.adoc @@ -855,6 +855,7 @@ The status of the request. [%hardbreaks] {blank} + a¦ String @@ -870,6 +871,7 @@ include::index.adoc[tag=desc-ActiveResponseStats, opts=optional] [%hardbreaks] {blank} + a¦ xref:ActiveResponseStats[] @@ -885,6 +887,7 @@ The total number of active queries. [%hardbreaks] {blank} + a¦ Integer @@ -900,6 +903,7 @@ include::index.adoc[tag=desc-ActiveResponseFilter, opts=optional] [%hardbreaks] {blank} + a¦ xref:ActiveResponseFilter[] @@ -962,6 +966,7 @@ Only included if viewing active queries for a specific index. [%hardbreaks] {blank} + a¦ String @@ -978,6 +983,7 @@ Only included if the `longerThan` query parameter is used. [%hardbreaks] {blank} + a¦ String (duration) @@ -993,6 +999,7 @@ The number of filtered active queries. [%hardbreaks] {blank} + a¦ Integer @@ -1008,6 +1015,7 @@ include::index.adoc[tag=desc-ActiveResponseFilterMap, opts=optional] [%hardbreaks] {blank} + a¦ xref:ActiveResponseFilterMap[] @@ -1070,6 +1078,7 @@ include::index.adoc[tag=desc-ActiveResponseFilterMapItem, opts=optional] [%hardbreaks] {blank} + a¦ xref:ActiveResponseFilterMapItem[] @@ -1132,6 +1141,7 @@ include::index.adoc[tag=desc-ActiveResponseFilterMapItemContext, opts=optional] [%hardbreaks] {blank} + a¦ xref:ActiveResponseFilterMapItemContext[] @@ -1147,6 +1157,7 @@ The time taken to execute the query. [%hardbreaks] {blank} + a¦ String (duration) @@ -1209,6 +1220,7 @@ For more information, see [Search Request JSON Properties](../search/search-requ [%hardbreaks] {blank} + a¦ Object @@ -1224,6 +1236,7 @@ a¦ [%hardbreaks] *Example:* `10` {blank} + a¦ Integer @@ -1239,6 +1252,7 @@ a¦ [%hardbreaks] *Example:* `0` {blank} + a¦ Integer @@ -1254,6 +1268,7 @@ a¦ [%hardbreaks] *Example:* `120000` {blank} + a¦ Integer @@ -1269,6 +1284,7 @@ The name of a Search index. [%hardbreaks] {blank} + a¦ String @@ -1330,6 +1346,7 @@ a¦ [%hardbreaks] *Example:* `3` {blank} + a¦ Integer @@ -1345,6 +1362,7 @@ a¦ [%hardbreaks] *Example:* `3` {blank} + a¦ Integer @@ -1402,6 +1420,7 @@ This parameter allows the user to cancel a query anywhere in the system by speci [%hardbreaks] {blank} + a¦ String @@ -1458,6 +1477,7 @@ The status of the request. [%hardbreaks] {blank} + a¦ String @@ -1473,6 +1493,7 @@ The response message, giving details of the node UUID and query ID. [%hardbreaks] {blank} + a¦ String diff --git a/docs/modules/fts-rest-stats/pages/index.adoc b/docs/modules/fts-rest-stats/pages/index.adoc index ca7d6e27..6e0af4c7 100644 --- a/docs/modules/fts-rest-stats/pages/index.adoc +++ b/docs/modules/fts-rest-stats/pages/index.adoc @@ -624,6 +624,7 @@ The average latency of all Search queries run on the cluster, in milliseconds. [%hardbreaks] {blank} + a¦ Big Decimal @@ -641,6 +642,7 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} + a¦ Integer @@ -660,6 +662,7 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} + a¦ Integer @@ -679,6 +682,7 @@ This statistic appears on the Server Web Console dashboard as **DCP Batches Bloc [%hardbreaks] {blank} + a¦ Integer @@ -696,6 +700,7 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} + a¦ Integer @@ -713,6 +718,7 @@ This statistic appears on the Server Web Console dashboard as **RAM Quota for Se [%hardbreaks] {blank} + a¦ Integer @@ -728,6 +734,7 @@ The total number of bytes used on disk by Search indexes in the cluster. [%hardbreaks] {blank} + a¦ Integer @@ -745,6 +752,7 @@ This statistic appears on the Server Web Console dashboard as **RAM Used by Sear [%hardbreaks] {blank} + a¦ Integer @@ -762,6 +770,7 @@ This amount is included as part of the total number of bytes used in memory, giv [%hardbreaks] {blank} + a¦ Integer @@ -777,6 +786,7 @@ The total number of files on disk for all Search indexes. [%hardbreaks] {blank} + a¦ Integer @@ -794,6 +804,7 @@ The number of Go SDK DCP agents should be less than or equal to the number of Se [%hardbreaks] {blank} + a¦ Integer @@ -811,6 +822,7 @@ Typically, the Search Service uses one agent pair for each bucket on a node. [%hardbreaks] {blank} + a¦ Integer @@ -826,6 +838,7 @@ The total number of [Vector Search](https://docs.couchbase.com/server/7.6/vector [%hardbreaks] {blank} + a¦ Integer @@ -842,6 +855,7 @@ Garbage collection involves cleanup actions like removing unnecessary index entr [%hardbreaks] {blank} + a¦ Big Decimal @@ -859,6 +873,7 @@ This statistic appears on the Server Web Console dashboard as **Pct RAM Used by [%hardbreaks] {blank} + a¦ Big Decimal @@ -877,6 +892,7 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} + a¦ Integer @@ -892,6 +908,7 @@ The total number of batches executed at regular intervals. [%hardbreaks] {blank} + a¦ Integer @@ -910,6 +927,7 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} + a¦ Integer @@ -927,6 +945,7 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} + a¦ Integer @@ -942,6 +961,7 @@ The total number of times a Search index partition closed to new Search requests [%hardbreaks] {blank} + a¦ Integer @@ -959,6 +979,7 @@ Opening a Search index partition creates a file lock for concurrent access reque [%hardbreaks] {blank} + a¦ Integer @@ -978,6 +999,7 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} + a¦ Integer @@ -997,6 +1019,7 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} + a¦ Integer @@ -1016,6 +1039,7 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} + a¦ Integer @@ -1035,6 +1059,7 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} + a¦ Integer @@ -1054,6 +1079,7 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} + a¦ Integer @@ -1071,6 +1097,7 @@ HTTP limit listeners manage limits on incoming HTTP requests to the Search Servi [%hardbreaks] {blank} + a¦ Integer @@ -1088,6 +1115,7 @@ HTTP limit listeners manage limits on incoming HTTP requests to the Search Servi [%hardbreaks] {blank} + a¦ Integer @@ -1105,6 +1133,7 @@ HTTPS limit listeners manage limits on incoming HTTPS requests to the Search Ser [%hardbreaks] {blank} + a¦ Integer @@ -1122,6 +1151,7 @@ HTTPS limit listeners manage limits on incoming HTTPS requests to the Search Ser [%hardbreaks] {blank} + a¦ Integer @@ -1139,6 +1169,7 @@ For more information about how to set the Search Service's quota, see [ftsMemory [%hardbreaks] {blank} + a¦ Integer @@ -1156,6 +1187,7 @@ A request is remote if it comes from a different node in the cluster. [%hardbreaks] {blank} + a¦ Integer @@ -1173,6 +1205,7 @@ A request is remote if it comes from a different node in the cluster. [%hardbreaks] {blank} + a¦ Integer @@ -1188,6 +1221,7 @@ This metric is deprecated. [%hardbreaks] {blank} + a¦ Integer @@ -1208,6 +1242,7 @@ Use gRPC requests, instead. [%hardbreaks] {blank} + a¦ Integer @@ -1228,6 +1263,7 @@ Use gRPC requests, instead. [%hardbreaks] {blank} + a¦ Integer @@ -1248,6 +1284,7 @@ Use gRPC requests, instead. [%hardbreaks] {blank} + a¦ Integer @@ -1268,6 +1305,7 @@ If the Search Service's index snapshots are too far ahead of the Data Service's [%hardbreaks] {blank} + a¦ Integer @@ -1288,6 +1326,7 @@ If the Search Service's index snapshots are too far ahead of the Data Service's [%hardbreaks] {blank} + a¦ Integer @@ -1304,6 +1343,7 @@ This includes the size of all JSON sent. [%hardbreaks] {blank} + a¦ Integer @@ -1319,6 +1359,7 @@ The total number of bad request errors returned for requests to create new Searc [%hardbreaks] {blank} + a¦ Integer @@ -1334,6 +1375,7 @@ The total number of internal server errors returned for requests to create new S [%hardbreaks] {blank} + a¦ Integer @@ -1349,6 +1391,7 @@ The total number of requests received by the Search Service for creating new Sea [%hardbreaks] {blank} + a¦ Integer @@ -1364,6 +1407,7 @@ The total number of requests received by the Search Service for creating new Sea [%hardbreaks] {blank} + a¦ Integer @@ -1379,6 +1423,7 @@ The total number of bad request errors returned for requests to delete Search in [%hardbreaks] {blank} + a¦ Integer @@ -1394,6 +1439,7 @@ The total number of internal server errors returned for requests to delete Searc [%hardbreaks] {blank} + a¦ Integer @@ -1409,6 +1455,7 @@ The total number of requests received by the Search Service to delete Search ind [%hardbreaks] {blank} + a¦ Integer @@ -1424,6 +1471,7 @@ The total number of requests received by the Search Service to delete Search ind [%hardbreaks] {blank} + a¦ Integer @@ -1441,6 +1489,7 @@ Garbage collection events include removing unnecessary index entries. [%hardbreaks] {blank} + a¦ Integer @@ -1460,6 +1509,7 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} + a¦ Integer @@ -1475,6 +1525,7 @@ The total number of Search queries per second across all Search indexes in the c [%hardbreaks] {blank} + a¦ Integer @@ -1490,6 +1541,7 @@ The total number of bad request errors returned for Search queries on the cluste [%hardbreaks] {blank} + a¦ Integer @@ -1507,6 +1559,7 @@ For more information about consistency in Search queries, see [Search Request JS [%hardbreaks] {blank} + a¦ Integer @@ -1522,6 +1575,7 @@ The total number of Search queries that encountered an error on the cluster. [%hardbreaks] {blank} + a¦ Integer @@ -1537,6 +1591,7 @@ The total number of Search queries that exceeded the [bleveMaxResultWindow](http [%hardbreaks] {blank} + a¦ Integer @@ -1554,6 +1609,7 @@ A Search query can return partial results if it times out before all partitions [%hardbreaks] {blank} + a¦ Integer @@ -1573,6 +1629,7 @@ This statistic appears on the Server Web Console dashboard as **Rejected Queries [%hardbreaks] {blank} + a¦ Integer @@ -1590,6 +1647,7 @@ These errors are typically internal server errors. [%hardbreaks] {blank} + a¦ Integer @@ -1605,6 +1663,7 @@ The total number of Search queries that were added to the slow query log. [%hardbreaks] {blank} + a¦ Integer @@ -1622,6 +1681,7 @@ You can set the timeout for a query with the [ctl object](https://docs.couchbase [%hardbreaks] {blank} + a¦ Integer @@ -1639,6 +1699,7 @@ For more information, see the [validate property](https://docs.couchbase.com/ser [%hardbreaks] {blank} + a¦ Integer @@ -1654,6 +1715,7 @@ The total time, in nanoseconds, spent processing Search queries across the clust [%hardbreaks] {blank} + a¦ Integer @@ -1718,6 +1780,7 @@ The coordinator is the Search node that receives the Search request and scatters [%hardbreaks] {blank} + a¦ Integer @@ -1735,6 +1798,7 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} + a¦ Integer @@ -1750,6 +1814,7 @@ The average latency, in milliseconds, for inter-node queries for the given Searc [%hardbreaks] {blank} + a¦ Integer @@ -1767,6 +1832,7 @@ This statistic appears on the Server Web Console dashboard as **Search Query Lat [%hardbreaks] {blank} + a¦ Integer @@ -1784,6 +1850,7 @@ This statistic appears on the Server Web Console dashboard as **Search Docs**. [%hardbreaks] {blank} + a¦ Integer @@ -1799,6 +1866,7 @@ The last date and time that a query ran against the given Search index. [%hardbreaks] {blank} + a¦ Date (date-time) @@ -1814,6 +1882,7 @@ The total number of bytes read by all queries against the given Search index. [%hardbreaks] {blank} + a¦ Integer @@ -1831,6 +1900,7 @@ This statistic appears on the Server Web Console dashboard as **Search Disk Size [%hardbreaks] {blank} + a¦ Integer @@ -1852,6 +1922,7 @@ The `num_bytes_used_disk_by_root` value will be less than the `num_bytes_used_di [%hardbreaks] {blank} + a¦ Integer @@ -1871,6 +1942,7 @@ Stale segments are deleted when they're not used by any new queries. [%hardbreaks] {blank} + a¦ Integer @@ -1886,6 +1958,7 @@ The total cumulative number of bytes written to disk as part of introducing segm [%hardbreaks] {blank} + a¦ Integer @@ -1907,6 +1980,7 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} + a¦ Integer @@ -1924,6 +1998,7 @@ This statistic appears on the Server Web Console dashboard as **Search Disk File [%hardbreaks] {blank} + a¦ Integer @@ -1945,6 +2020,7 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} + a¦ Integer @@ -1962,6 +2038,7 @@ This statistic appears on the Server Web Console dashboard as **Search Mutations [%hardbreaks] {blank} + a¦ Integer @@ -1983,6 +2060,7 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} + a¦ Integer @@ -2004,6 +2082,7 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} + a¦ Integer @@ -2021,6 +2100,7 @@ This statistic appears on the Server Web Console dashboard as **Search Partition [%hardbreaks] {blank} + a¦ Integer @@ -2038,6 +2118,7 @@ This statistic appears on the Server Web Console dashboard as **Search Partition [%hardbreaks] {blank} + a¦ Integer @@ -2055,6 +2136,7 @@ This statistic appears on the Server Web Console dashboard as **Search Records t [%hardbreaks] {blank} + a¦ Integer @@ -2074,6 +2156,7 @@ This statistic appears on the Server Web Console dashboard as **Search Disk Segm [%hardbreaks] {blank} + a¦ Integer @@ -2093,6 +2176,7 @@ This statistic appears on the Server Web Console dashboard as **Search Memory Se [%hardbreaks] {blank} + a¦ Integer @@ -2111,6 +2195,7 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} + a¦ Integer @@ -2126,6 +2211,7 @@ The total number of delete operations received from DCP for the given Search ind [%hardbreaks] {blank} + a¦ Integer @@ -2141,6 +2227,7 @@ The total number of create or update operations received from DCP for the given [%hardbreaks] {blank} + a¦ Integer @@ -2158,6 +2245,7 @@ If the DCP connection closes, the Search Service can use this stored metadata to [%hardbreaks] {blank} + a¦ Integer @@ -2173,6 +2261,7 @@ The total number of times the DCP consumer updated stored metadata, based on cha [%hardbreaks] {blank} + a¦ Integer @@ -2188,6 +2277,7 @@ The total number of DCP Rollback messages received for the given Search index. [%hardbreaks] {blank} + a¦ Integer @@ -2205,6 +2295,7 @@ Snapshots contain a representation of document mutations on either a write queue [%hardbreaks] {blank} + a¦ Integer @@ -2220,6 +2311,7 @@ This metric is no longer used and will soon be deprecated. [%hardbreaks] {blank} + a¦ Integer @@ -2237,6 +2329,7 @@ This statistic appears on the Server Web Console dashboard as **Search Index Rat [%hardbreaks] {blank} + a¦ Integer @@ -2255,6 +2348,7 @@ This statistic appears on the Server Web Console dashboard as **Search Result Ra [%hardbreaks] {blank} + a¦ Integer @@ -2272,6 +2366,7 @@ This statistic appears on the Server Web Console dashboard as **Search Compactio [%hardbreaks] {blank} + a¦ Integer @@ -2291,6 +2386,7 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} + a¦ Integer @@ -2306,6 +2402,7 @@ The total number of queries, using gRPC for streaming, for the given Search inde [%hardbreaks] {blank} + a¦ Integer @@ -2321,6 +2418,7 @@ The total number of queries that resulted in an error that used gRPC for streami [%hardbreaks] {blank} + a¦ Integer @@ -2336,6 +2434,7 @@ The total number of queries added to the slow query log that used gRPC for strea [%hardbreaks] {blank} + a¦ Integer @@ -2351,6 +2450,7 @@ The total number of queries that timed out that used gRPC for streaming on the g [%hardbreaks] {blank} + a¦ Integer @@ -2370,6 +2470,7 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} + a¦ Integer @@ -2389,6 +2490,7 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} + a¦ Integer @@ -2404,6 +2506,7 @@ The total number of [Vector Search](https://docs.couchbase.com/server/7.6/vector [%hardbreaks] {blank} + a¦ Integer @@ -2419,6 +2522,7 @@ The total number of Search queries per second on the given Search index. [%hardbreaks] {blank} + a¦ Integer @@ -2436,6 +2540,7 @@ This statistic appears on the Server Web Console dashboard as **Search Query Err [%hardbreaks] {blank} + a¦ Integer @@ -2455,6 +2560,7 @@ This statistic appears on the Server Web Console dashboard as **Search Slow Quer [%hardbreaks] {blank} + a¦ Integer @@ -2472,6 +2578,7 @@ This statistic appears on the Server Web Console dashboard as **Search Query Tim [%hardbreaks] {blank} + a¦ Integer @@ -2487,6 +2594,7 @@ The total time, in nanoseconds, spent processing Search query requests for the g [%hardbreaks] {blank} + a¦ Integer @@ -2509,6 +2617,7 @@ This statistic appears on the Server Web Console dashboard as **Term Searchers S [%hardbreaks] {blank} + a¦ Integer @@ -2524,6 +2633,7 @@ The total number of term searchers on the given Search index that have finished [%hardbreaks] {blank} + a¦ Integer @@ -2541,6 +2651,7 @@ If there are no vectors inside the Search index, the REST API does not return th [%hardbreaks] {blank} + a¦ Integer diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc index 7e65e00f..cca24d14 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -1057,6 +1057,7 @@ include::index.adoc[tag=desc-NodeIdxNodeIndexer, opts=optional] [%hardbreaks] {blank} + a¦ xref:NodeIdxNodeIndexer[] @@ -1120,6 +1121,7 @@ Current state of the Index service on this node. *Values:* `"Active"`, `"Pause"`, `"Warmup"` *Example:* `+++"Active"+++` {blank} + a¦ String @@ -1138,6 +1140,7 @@ Memory quota assigned to the Index service on this node by user configuration (b *Maximum:* `1099511992567` *Example:* `536870912` {blank} + a¦ Long (int64) @@ -1156,6 +1159,7 @@ This also accounts for memory fragmentation. [%hardbreaks] *Example:* `71794688` {blank} + a¦ Integer @@ -1172,6 +1176,7 @@ Amount of memory used by the Index service on this node (bytes). [%hardbreaks] *Example:* `360192000` {blank} + a¦ Integer @@ -1188,6 +1193,7 @@ The total time the indexer has spent in GC pause since last startup (ns). [%hardbreaks] *Example:* `309778455` {blank} + a¦ Integer @@ -1282,6 +1288,7 @@ include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] [%hardbreaks] {blank} + a¦ xref:PartIdxPartitionsIndex[] @@ -1339,6 +1346,7 @@ include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] [%hardbreaks] {blank} + a¦ xref:PartIdxPartitionsIndex[] @@ -1402,6 +1410,7 @@ The average number of items indexed per document. [%hardbreaks] {blank} + a¦ Integer @@ -1417,6 +1426,7 @@ Average number of items flushed from memory to disk storage per second. [%hardbreaks] {blank} + a¦ Integer @@ -1432,6 +1442,7 @@ Average size of the keys. [%hardbreaks] {blank} + a¦ Integer @@ -1447,6 +1458,7 @@ Average time to serve a scan request (nanoseconds). [%hardbreaks] {blank} + a¦ Integer @@ -1462,6 +1474,7 @@ Percentage of memory accesses that were served from the managed cache. [%hardbreaks] {blank} + a¦ Integer @@ -1477,6 +1490,7 @@ Accesses to this index data from RAM. [%hardbreaks] {blank} + a¦ Integer @@ -1492,6 +1506,7 @@ Accesses to this index data from disk. [%hardbreaks] {blank} + a¦ Integer @@ -1508,6 +1523,7 @@ The size of indexable data that is maintained for the index or partition (bytes) [%hardbreaks] *Example:* `95728` {blank} + a¦ Integer @@ -1524,6 +1540,7 @@ Total disk file size consumed by the index or partition. [%hardbreaks] *Example:* `889054` {blank} + a¦ Integer @@ -1541,6 +1558,7 @@ The number of documents currently indexed. [%hardbreaks] {blank} + a¦ Integer @@ -1559,6 +1577,7 @@ TIP: At small index sizes of less than a hundred kB, the static overhead of the [%hardbreaks] {blank} + a¦ Integer @@ -1579,6 +1598,7 @@ For an index partition, the value is listed as `0`. [%hardbreaks] *Example:* `100` {blank} + a¦ Integer @@ -1595,6 +1615,7 @@ The number of items currently indexed. [%hardbreaks] *Example:* `2155` {blank} + a¦ Integer @@ -1614,6 +1635,7 @@ NOTE: This statistic is persisted to disk every 15 minutes, so it is preserved w [%hardbreaks] {blank} + a¦ Long (int64) @@ -1629,6 +1651,7 @@ Number of documents indexed by the indexer since last startup. [%hardbreaks] {blank} + a¦ Integer @@ -1644,6 +1667,7 @@ Number of documents pending to be indexed. [%hardbreaks] {blank} + a¦ Integer @@ -1659,6 +1683,7 @@ Number of documents queued to be indexed. [%hardbreaks] {blank} + a¦ Integer @@ -1674,6 +1699,7 @@ Number of items flushed from memory to disk storage. [%hardbreaks] {blank} + a¦ Integer @@ -1689,6 +1715,7 @@ Number of requests received but not yet served by the indexer. [%hardbreaks] {blank} + a¦ Integer @@ -1704,6 +1731,7 @@ Number of requests served by the indexer since last startup. [%hardbreaks] {blank} + a¦ Integer @@ -1719,6 +1747,7 @@ Total number of rows returned so far by the indexer. [%hardbreaks] {blank} + a¦ Integer @@ -1734,6 +1763,7 @@ Number of requests that failed due to errors other than timeout. [%hardbreaks] {blank} + a¦ Integer @@ -1749,6 +1779,7 @@ Number of requests that timed out, either waiting for snapshots or during scan i [%hardbreaks] {blank} + a¦ Integer @@ -1768,6 +1799,7 @@ For memory-optimized index storage, this is the same as `items_count`. [%hardbreaks] *Example:* `2155` {blank} + a¦ Integer @@ -1784,6 +1816,7 @@ For memory-optimized index storage, this is `0`. [%hardbreaks] {blank} + a¦ Integer @@ -1800,6 +1833,7 @@ Percentage of the data held in memory. [%hardbreaks] *Example:* `100` {blank} + a¦ Integer @@ -1815,6 +1849,7 @@ Number of bytes read by a scan since last startup. [%hardbreaks] {blank} + a¦ Integer @@ -1830,6 +1865,7 @@ Total time spent by the indexer in scanning rows since last startup (nanoseconds [%hardbreaks] {blank} + a¦ Integer diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index 9079ee3f..9efcd067 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -4737,6 +4737,7 @@ The name of the cluster. [%hardbreaks] {blank} + a¦ String @@ -4752,6 +4753,7 @@ The URL of the datastore. [%hardbreaks] {blank} + a¦ String @@ -4767,6 +4769,7 @@ The URL of the configstore. [%hardbreaks] {blank} + a¦ String @@ -4782,6 +4785,7 @@ The URL of the accountstore. [%hardbreaks] {blank} + a¦ String @@ -4796,6 +4800,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -4852,6 +4857,7 @@ The amount of memory freed. [%hardbreaks] {blank} + a¦ Integer @@ -4868,6 +4874,7 @@ The amount of memory released to the OS. [%hardbreaks] {blank} + a¦ Integer @@ -4883,6 +4890,7 @@ The status of the garbage collector. [%hardbreaks] {blank} + a¦ String @@ -4951,6 +4959,7 @@ If true, all requests that generate a panic are logged. *Default:* `null` *Example:* `true` {blank} + a¦ Boolean @@ -4969,6 +4978,7 @@ If specified, all completed requests from this IP address are logged. *Default:* `+++""+++` *Example:* `+++"172.1.2.3"+++` {blank} + a¦ String @@ -4993,6 +5003,7 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo [%hardbreaks] {blank} + a¦ String @@ -5011,6 +5022,7 @@ If specified, all completed queries returning this error number are logged. *Default:* `null` *Example:* `12003` {blank} + a¦ Integer (int32) @@ -5032,6 +5044,7 @@ Refer to [Configure Completed Requests][sys-completed-config] for more informati *Default:* `+++""+++` *Example:* `+++"both_user_and_error"+++` {blank} + a¦ String @@ -5052,6 +5065,7 @@ This is another way of specifying the `completed-threshold` setting. *Default:* `1000` *Example:* `7000` {blank} + a¦ Integer (int32) @@ -5070,6 +5084,7 @@ If specified, all completed queries with this user name are logged. *Default:* `+++""+++` *Example:* `+++"marco"+++` {blank} + a¦ String @@ -5088,6 +5103,7 @@ Queries with fewer errors are not logged. [%hardbreaks] *Example:* `5` {blank} + a¦ Integer (int32) @@ -5144,6 +5160,7 @@ A single value that represents the current state. [%hardbreaks] {blank} + a¦ Integer @@ -5159,6 +5176,7 @@ a¦ [%hardbreaks] {blank} + a¦ Big Decimal @@ -5174,6 +5192,7 @@ a¦ [%hardbreaks] {blank} + a¦ Big Decimal @@ -5189,6 +5208,7 @@ a¦ [%hardbreaks] {blank} + a¦ Big Decimal @@ -5204,6 +5224,7 @@ Mean rate since the query service started. [%hardbreaks] {blank} + a¦ Big Decimal @@ -5219,6 +5240,7 @@ The maximum value. [%hardbreaks] {blank} + a¦ Integer @@ -5234,6 +5256,7 @@ The mean value. [%hardbreaks] {blank} + a¦ Big Decimal @@ -5249,6 +5272,7 @@ The median value. [%hardbreaks] {blank} + a¦ Big Decimal @@ -5264,6 +5288,7 @@ The minimum value. [%hardbreaks] {blank} + a¦ Integer @@ -5279,6 +5304,7 @@ The standard deviation. [%hardbreaks] {blank} + a¦ Big Decimal @@ -5294,6 +5320,7 @@ The 75th percentile. [%hardbreaks] {blank} + a¦ Big Decimal @@ -5309,6 +5336,7 @@ The 95th percentile. [%hardbreaks] {blank} + a¦ Big Decimal @@ -5324,6 +5352,7 @@ The 99th percentile. [%hardbreaks] {blank} + a¦ Big Decimal @@ -5339,6 +5368,7 @@ The 99.9th percentile. [%hardbreaks] {blank} + a¦ Big Decimal @@ -5395,6 +5425,7 @@ The name of the cluster. [%hardbreaks] {blank} + a¦ String @@ -5410,6 +5441,7 @@ The URL of the node, including port number. [%hardbreaks] {blank} + a¦ String @@ -5425,6 +5457,7 @@ The HTTP URL of the query endpoint. [%hardbreaks] {blank} + a¦ String @@ -5440,6 +5473,7 @@ The HTTP URL of the admin endpoint. [%hardbreaks] {blank} + a¦ String @@ -5455,6 +5489,7 @@ The HTTPS URL of the query endpoint. [%hardbreaks] {blank} + a¦ String @@ -5470,6 +5505,7 @@ The HTTPS URL of the admin endpoint. [%hardbreaks] {blank} + a¦ String @@ -5484,6 +5520,7 @@ a¦ [%hardbreaks] {blank} + a¦ String @@ -5548,6 +5585,7 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo [%hardbreaks] {blank} + a¦ String @@ -5564,6 +5602,7 @@ It includes the time taken by the service to schedule the request. [%hardbreaks] {blank} + a¦ String (duration) @@ -5579,6 +5618,7 @@ Total number of errors encountered while executing the query. [%hardbreaks] {blank} + a¦ Integer @@ -5595,6 +5635,7 @@ This property is only returned if a memory quota is set for the query. [%hardbreaks] {blank} + a¦ Integer @@ -5610,6 +5651,7 @@ IP address and port number of the node where the query is executed. [%hardbreaks] {blank} + a¦ String @@ -5629,6 +5671,7 @@ Polling the active requests again may return different values. [%hardbreaks] *Example:* `{"fetch":16,"indexScan":187}` {blank} + a¦ Object @@ -5649,6 +5692,7 @@ A union select would have twice as many operator counts, one per each branch of [%hardbreaks] *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} + a¦ Object @@ -5668,6 +5712,7 @@ Polling the active requests again may return different values. [%hardbreaks] *Example:* `{"authorize":"823.631µs","fetch":"656.873µs","indexScan":"29.146543ms","instantiate":"236.221µs","parse":"826.382µs","plan":"11.831101ms","run":"16.892181ms"}` {blank} + a¦ Object @@ -5683,6 +5728,7 @@ IP address and port number of the client application, from where the query is re [%hardbreaks] {blank} + a¦ String @@ -5698,6 +5744,7 @@ Unique request ID internally generated for the query. [%hardbreaks] {blank} + a¦ UUID (uuid) @@ -5713,6 +5760,7 @@ Timestamp when the query is received. [%hardbreaks] {blank} + a¦ Date (date-time) @@ -5728,6 +5776,7 @@ Total number of documents returned in the query result. [%hardbreaks] {blank} + a¦ Integer @@ -5743,6 +5792,7 @@ Total number of bytes returned in the query result. [%hardbreaks] {blank} + a¦ Integer @@ -5758,6 +5808,7 @@ The value of the query setting Scan Consistency used for the query. [%hardbreaks] {blank} + a¦ String @@ -5773,6 +5824,7 @@ Total amount of calendar time taken to complete the query. [%hardbreaks] {blank} + a¦ String (duration) @@ -5793,6 +5845,7 @@ To find requests that were successful, use this field in conjunction with the `e [%hardbreaks] {blank} + a¦ String @@ -5808,6 +5861,7 @@ The query statement being executed. [%hardbreaks] {blank} + a¦ String @@ -5823,6 +5877,7 @@ Whether the cost-based optimizer is enabled for the query. [%hardbreaks] {blank} + a¦ Boolean @@ -5839,6 +5894,7 @@ This property is only returned if a memory quota is set for the query. [%hardbreaks] {blank} + a¦ Integer @@ -5854,6 +5910,7 @@ Name of the client application or program that issued the query. [%hardbreaks] {blank} + a¦ String @@ -5869,6 +5926,7 @@ Username with whose privileges the query is run. [%hardbreaks] {blank} + a¦ String @@ -5943,6 +6001,7 @@ If a request does not include this parameter, the node-level `atrcollection` set *Default:* `+++""+++` *Example:* `+++"default:`travel-sample`.transaction.test"+++` {blank} + a¦ String @@ -5964,6 +6023,7 @@ Refer to [Auto-Prepare][auto-prepare] for more information. *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -5990,6 +6050,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} + a¦ Boolean @@ -6016,6 +6077,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} + a¦ Boolean @@ -6056,6 +6118,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `+++"60s"+++` *Example:* `+++"30s"+++` {blank} + a¦ String (duration) @@ -6071,6 +6134,7 @@ include::index.adoc[tag=desc-Logging_Parameters, opts=optional] [%hardbreaks] {blank} + a¦ xref:Logging_Parameters[] @@ -6104,6 +6168,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `4000` *Example:* `7000` {blank} + a¦ Integer (int32) @@ -6139,6 +6204,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `20840448` {blank} + a¦ Integer (int32) @@ -6165,6 +6231,7 @@ Refer to [Stream Completed Requests][sys-history] for more information and examp [%hardbreaks] {blank} + a¦ Integer (int32) @@ -6199,6 +6266,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `1000` *Example:* `7000` {blank} + a¦ Integer (int32) @@ -6229,6 +6297,7 @@ If a request does not include this parameter, the node-level `controls` setting *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -6252,6 +6321,7 @@ To stop `cpuprofile`, run with the empty setting of `""`. *Default:* `+++""+++` *Example:* `+++"/tmp/info.txt"+++` {blank} + a¦ String @@ -6271,6 +6341,7 @@ When set to `true`, extra logging is provided. *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -6289,6 +6360,7 @@ The actual value of this field is ignored. [%hardbreaks] *Example:* `true` {blank} + a¦ Boolean @@ -6306,6 +6378,7 @@ Maximum number of user-defined functions. *Default:* `16384` *Example:* `7000` {blank} + a¦ Integer (int32) @@ -6323,6 +6396,7 @@ Maximum size of buffered result. *Default:* `16384` *Example:* `7000` {blank} + a¦ Integer (int32) @@ -6372,6 +6446,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `+++"INFO"+++` *Example:* `+++"DEBUG"+++` {blank} + a¦ String @@ -6388,6 +6463,7 @@ This setting is provided for technical support only. [%hardbreaks] {blank} + a¦ Integer (int32) @@ -6431,6 +6507,7 @@ NOTE: To enable queries to run in parallel, you must specify the cluster-level ` *Default:* `1` *Example:* `0` {blank} + a¦ Integer (int32) @@ -6471,6 +6548,7 @@ If a request includes this parameter, it will be capped by the node-level `memor *Default:* `0` *Example:* `4` {blank} + a¦ Integer (int32) @@ -6492,6 +6570,7 @@ To stop `memprofile`, run with the empty setting of `""`. *Default:* `+++""+++` *Example:* `+++"/tmp/memory-usage.log"+++` {blank} + a¦ String @@ -6509,6 +6588,7 @@ This setting is provided for technical support only. [%hardbreaks] *Default:* `false` {blank} + a¦ Boolean @@ -6537,6 +6617,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `76` *Example:* `16460` {blank} + a¦ Integer (int32) @@ -6573,6 +6654,7 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} + a¦ Integer (int32) @@ -6601,6 +6683,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `100` {blank} + a¦ Integer (int32) @@ -6633,6 +6716,7 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} + a¦ Integer (int32) @@ -6664,6 +6748,7 @@ The minimum of that and the node-level `numatrs` setting is applied. [%hardbreaks] {blank} + a¦ String @@ -6695,6 +6780,7 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. *Default:* `16` *Example:* `64` {blank} + a¦ Integer (int32) @@ -6726,6 +6812,7 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} + a¦ Integer (int32) @@ -6743,6 +6830,7 @@ The default is 16 times the number of logical cores. [%hardbreaks] *Example:* `16` {blank} + a¦ Integer (int32) @@ -6770,6 +6858,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `16384` *Example:* `65536` {blank} + a¦ Integer (int32) @@ -6796,6 +6885,7 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -6838,6 +6928,7 @@ If a request does not include this parameter, the node-level `profile` setting w *Default:* `+++"off"+++` *Example:* `+++"phases"+++` {blank} + a¦ String @@ -6855,6 +6946,7 @@ Maximum size of a request. *Default:* `67108864` *Example:* `70000` {blank} + a¦ Integer (int32) @@ -6890,6 +6982,7 @@ The minimum of that and the node-level `scan-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} + a¦ Integer (int32) @@ -6908,6 +7001,7 @@ The default is 4 times the number of cores on the query node. *Default:* `32` *Example:* `8` {blank} + a¦ Integer (int32) @@ -6945,6 +7039,7 @@ The minimum of that and the node-level `timeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} + a¦ Long (int64) @@ -6987,6 +7082,7 @@ The minimum of that and the node-level `txtimeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} + a¦ Long (int64) @@ -7018,6 +7114,7 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `true` *Example:* `false` {blank} + a¦ Boolean @@ -7066,6 +7163,7 @@ If the request-level parameter and the node-level setting are both `unset`, read *Default:* `+++"unset"+++` *Example:* `+++"on"+++` {blank} + a¦ String @@ -7122,6 +7220,7 @@ The full prepared statement in encoded format. [%hardbreaks] {blank} + a¦ String @@ -7138,6 +7237,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} + a¦ Integer @@ -7154,6 +7254,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} + a¦ Integer @@ -7170,6 +7271,7 @@ This may be a UUID that was assigned automatically, or a name that was user-spec [%hardbreaks] {blank} + a¦ String @@ -7186,6 +7288,7 @@ Currently, only the `default` namespace is available. [%hardbreaks] {blank} + a¦ String @@ -7201,6 +7304,7 @@ The node on which the prepared statement is stored. [%hardbreaks] {blank} + a¦ String @@ -7216,6 +7320,7 @@ The text of the query. [%hardbreaks] {blank} + a¦ String @@ -7231,6 +7336,7 @@ The count of times the prepared statement has been executed. [%hardbreaks] {blank} + a¦ Integer @@ -7250,6 +7356,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} + a¦ String (duration) @@ -7268,6 +7375,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} + a¦ String (duration) @@ -7285,6 +7393,7 @@ This property is only returned when the prepared statement has been executed. [%hardbreaks] {blank} + a¦ Date (date-time) @@ -7304,6 +7413,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} + a¦ String (duration) @@ -7322,6 +7432,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} + a¦ String (duration) @@ -7341,6 +7452,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} + a¦ String (duration) @@ -7359,6 +7471,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} + a¦ String (duration) @@ -7415,6 +7528,7 @@ Total number of active requests. [%hardbreaks] {blank} + a¦ Integer @@ -7430,6 +7544,7 @@ Total number of query requests with `at_plus` index consistency. [%hardbreaks] {blank} + a¦ Integer @@ -7447,6 +7562,7 @@ Records in the output queue that have not yet been sent to the server are not co [%hardbreaks] {blank} + a¦ Integer @@ -7462,6 +7578,7 @@ The total number of audit records sent to the server that failed. [%hardbreaks] {blank} + a¦ Integer @@ -7477,6 +7594,7 @@ The number of potentially auditable requests that cause no audit action to be ta [%hardbreaks] {blank} + a¦ Integer @@ -7492,6 +7610,7 @@ The total number of potentially auditable requests sent to the query engine. [%hardbreaks] {blank} + a¦ Integer @@ -7507,6 +7626,7 @@ Total number of cancelled requests. [%hardbreaks] {blank} + a¦ Integer @@ -7522,6 +7642,7 @@ Total number of DELETE operations. [%hardbreaks] {blank} + a¦ Integer @@ -7537,6 +7658,7 @@ The total number of query errors returned so far. [%hardbreaks] {blank} + a¦ Integer @@ -7552,6 +7674,7 @@ Total number of secondary index scans. [%hardbreaks] {blank} + a¦ Integer @@ -7567,6 +7690,7 @@ Total number of INSERT operations. [%hardbreaks] {blank} + a¦ Integer @@ -7582,6 +7706,7 @@ Total number of requests for unsupported endpoints. [%hardbreaks] {blank} + a¦ Integer @@ -7597,6 +7722,7 @@ Total number of document mutations. [%hardbreaks] {blank} + a¦ Integer @@ -7612,6 +7738,7 @@ Total number of prepared statements executed. [%hardbreaks] {blank} + a¦ Integer @@ -7627,6 +7754,7 @@ Total number of primary index scans. [%hardbreaks] {blank} + a¦ Integer @@ -7642,6 +7770,7 @@ Total number of queued requests. [%hardbreaks] {blank} + a¦ Integer @@ -7657,6 +7786,7 @@ Total end-to-end time to process all queries (ns). [%hardbreaks] {blank} + a¦ Integer @@ -7673,6 +7803,7 @@ Number of query requests processed per second. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7689,6 +7820,7 @@ Number of query requests processed per second. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7705,6 +7837,7 @@ Number of query requests processed per second. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7721,6 +7854,7 @@ The 75th percentile. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7737,6 +7871,7 @@ The 95th percentile. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7753,6 +7888,7 @@ The 99th percentile. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7769,6 +7905,7 @@ The 99.9th percentile. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7784,6 +7921,7 @@ Total number of query requests. [%hardbreaks] {blank} + a¦ Integer @@ -7800,6 +7938,7 @@ The maximum value. [%hardbreaks] {blank} + a¦ Integer @@ -7816,6 +7955,7 @@ The mean value. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7832,6 +7972,7 @@ Mean rate since the query service started. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7848,6 +7989,7 @@ The median value. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7864,6 +8006,7 @@ The minimum value. [%hardbreaks] {blank} + a¦ Integer @@ -7880,6 +8023,7 @@ The standard deviation. [%hardbreaks] {blank} + a¦ Big Decimal @@ -7895,6 +8039,7 @@ Total number of query requests. [%hardbreaks] {blank} + a¦ Integer @@ -7910,6 +8055,7 @@ Number of queries that take longer than 1000ms. [%hardbreaks] {blank} + a¦ Integer @@ -7925,6 +8071,7 @@ Number of queries that take longer than 250ms. [%hardbreaks] {blank} + a¦ Integer @@ -7940,6 +8087,7 @@ Number of queries that take longer than 5000ms. [%hardbreaks] {blank} + a¦ Integer @@ -7955,6 +8103,7 @@ Number of queries that take longer than 500ms. [%hardbreaks] {blank} + a¦ Integer @@ -7970,6 +8119,7 @@ Total number of results (documents) returned by the query engine. [%hardbreaks] {blank} + a¦ Integer @@ -7985,6 +8135,7 @@ Total size of data returned by the query engine (bytes). [%hardbreaks] {blank} + a¦ Integer @@ -8000,6 +8151,7 @@ Total number of query requests with `request_plus` index consistency. [%hardbreaks] {blank} + a¦ Integer @@ -8015,6 +8167,7 @@ Total number of SELECT requests. [%hardbreaks] {blank} + a¦ Integer @@ -8030,6 +8183,7 @@ Time to execute all queries (ns). [%hardbreaks] {blank} + a¦ Integer @@ -8045,6 +8199,7 @@ Total number of query requests with `not_bounded` index consistency. [%hardbreaks] {blank} + a¦ Integer @@ -8060,6 +8215,7 @@ Total number of UPDATE requests. [%hardbreaks] {blank} + a¦ Integer @@ -8075,6 +8231,7 @@ The total number of query warnings returned so far. [%hardbreaks] {blank} + a¦ Integer @@ -8131,6 +8288,7 @@ The number of reads and retries for each bucket. [%hardbreaks] {blank} + a¦ Object @@ -8146,6 +8304,7 @@ The uptime of the query engine. [%hardbreaks] {blank} + a¦ String (duration) @@ -8161,6 +8320,7 @@ The local time of the query engine. [%hardbreaks] {blank} + a¦ Date (date-time) @@ -8176,6 +8336,7 @@ The version of the query engine. [%hardbreaks] {blank} + a¦ String @@ -8191,6 +8352,7 @@ The number of active threads used by the query engine. [%hardbreaks] {blank} + a¦ Integer @@ -8206,6 +8368,7 @@ The maximum number of logical cores available to the query engine. [%hardbreaks] {blank} + a¦ Integer @@ -8221,6 +8384,7 @@ The total number of times FFDC has been invoked since the last restart. [%hardbreaks] {blank} + a¦ Integer @@ -8236,6 +8400,7 @@ The target heap size of the next garbage collection cycle. [%hardbreaks] {blank} + a¦ Long (int64) @@ -8251,6 +8416,7 @@ The total time spent pausing for garbage collection since the query engine start [%hardbreaks] {blank} + a¦ String (duration) @@ -8266,6 +8432,7 @@ The percentage of time spent pausing for garbage collection since the last time [%hardbreaks] {blank} + a¦ Long (int64) @@ -8281,6 +8448,7 @@ False when either the unbounded or plus request queues are full; true otherwise. [%hardbreaks] {blank} + a¦ Boolean @@ -8296,6 +8464,7 @@ Amount of free memory on the host. [%hardbreaks] {blank} + a¦ Long (int64) @@ -8312,6 +8481,7 @@ This reflects the node-quota setting. [%hardbreaks] {blank} + a¦ Long (int64) @@ -8327,6 +8497,7 @@ Total memory on the host. [%hardbreaks] {blank} + a¦ Long (int64) @@ -8342,6 +8513,7 @@ This the total document memory quota on the node. [%hardbreaks] {blank} + a¦ Long (int64) @@ -8357,6 +8529,7 @@ A calculation for how busy the server is. [%hardbreaks] {blank} + a¦ Integer @@ -8372,6 +8545,7 @@ The moving 15 minute average of the load calculation. [%hardbreaks] {blank} + a¦ Integer @@ -8388,6 +8562,7 @@ This increases as heap objects are allocated, and decreases as objects are freed [%hardbreaks] {blank} + a¦ Long (int64) @@ -8404,6 +8579,7 @@ This increases as heap objects are allocated, but does not decrease when objects [%hardbreaks] {blank} + a¦ Long (int64) @@ -8420,6 +8596,7 @@ This measures the virtual address space reserved by the query engine for heaps, [%hardbreaks] {blank} + a¦ Long (int64) @@ -8435,6 +8612,7 @@ The name or IP address and port of the node. [%hardbreaks] {blank} + a¦ String @@ -8451,6 +8629,7 @@ The total number of values allocated to contain documents or computations around [%hardbreaks] {blank} + a¦ Integer @@ -8466,6 +8645,7 @@ The currently allocated document memory on the node. [%hardbreaks] {blank} + a¦ Integer @@ -8482,6 +8662,7 @@ The percentage of time spent executing user code since the last time the statist [%hardbreaks] {blank} + a¦ Long (int64) @@ -8498,6 +8679,7 @@ The percentage of time spent executing system code since the last time the stati [%hardbreaks] {blank} + a¦ Long (int64) @@ -8513,6 +8695,7 @@ Current process memory use. [%hardbreaks] {blank} + a¦ Integer @@ -8528,6 +8711,7 @@ Average CPU usage per core. [%hardbreaks] {blank} + a¦ Big Decimal @@ -8543,6 +8727,7 @@ Process RSS (bytes) [%hardbreaks] {blank} + a¦ Integer @@ -8558,6 +8743,7 @@ The number of active servicers for the dominant workload — unbound queue s [%hardbreaks] {blank} + a¦ Integer @@ -8573,6 +8759,7 @@ Total number of completed requests. [%hardbreaks] {blank} + a¦ Integer @@ -8588,6 +8775,7 @@ Total number of active requests. [%hardbreaks] {blank} + a¦ Integer @@ -8604,6 +8792,7 @@ Number of query requests processed per second. [%hardbreaks] {blank} + a¦ Big Decimal @@ -8620,6 +8809,7 @@ Number of query requests processed per second. [%hardbreaks] {blank} + a¦ Big Decimal @@ -8636,6 +8826,7 @@ Number of query requests processed per second. [%hardbreaks] {blank} + a¦ Big Decimal @@ -8651,6 +8842,7 @@ Number of queued requests. [%hardbreaks] {blank} + a¦ Integer @@ -8666,6 +8858,7 @@ High water mark for request quota use. [%hardbreaks] {blank} + a¦ Integer @@ -8682,6 +8875,7 @@ The mean value. [%hardbreaks] {blank} + a¦ String (duration) @@ -8698,6 +8892,7 @@ The median value. [%hardbreaks] {blank} + a¦ String (duration) @@ -8714,6 +8909,7 @@ The 80th percentile. [%hardbreaks] {blank} + a¦ String (duration) @@ -8730,6 +8926,7 @@ The 95th percentile. [%hardbreaks] {blank} + a¦ String (duration) @@ -8746,6 +8943,7 @@ The 99th percentile. [%hardbreaks] {blank} + a¦ String (duration) @@ -8761,6 +8959,7 @@ Percentage of requests that are prepared statements. [%hardbreaks] {blank} + a¦ Integer @@ -8777,6 +8976,7 @@ Number of servicers temporarily paused due to memory pressure. [%hardbreaks] {blank} + a¦ Integer @@ -8793,6 +8993,7 @@ Number of times servicers have been temporarily paused. [%hardbreaks] {blank} + a¦ Integer @@ -8809,6 +9010,7 @@ High water mark for temp space use directly by query. [%hardbreaks] {blank} + a¦ Integer @@ -8825,6 +9027,7 @@ Current Query temp space use. [%hardbreaks] {blank} + a¦ Integer diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index d656e675..89406815 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -1219,6 +1219,7 @@ The name of the property is the name of the library. [%hardbreaks] *Example:* `+++"function add(a, b) { return a + b; } function mul(a, b) { return a * b; }"+++` {blank} + a¦ String @@ -1276,6 +1277,7 @@ The name of a library. [%hardbreaks] *Example:* `+++"math"+++` {blank} + a¦ String @@ -1293,6 +1295,7 @@ For scoped libraries, the bucket in which the library is stored. For global libr [%hardbreaks] *Example:* `+++"travel-sample"+++` {blank} + a¦ String @@ -1310,6 +1313,7 @@ For scoped libraries, the scope in which the library is stored. For global libra [%hardbreaks] *Example:* `+++"inventory"+++` {blank} + a¦ String @@ -1327,6 +1331,7 @@ The JavaScript code for all functions in the library. [%hardbreaks] *Example:* `+++"function add(a, b) { return a + b; } function mul(a, b) { return a * b; }"+++` {blank} + a¦ String diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc index 3ca2ac08..e68f7b54 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -754,6 +754,7 @@ This property is always present in every condition returned in the Query REST AP [%hardbreaks] {blank} + a¦ Integer @@ -770,6 +771,7 @@ This property is always present in every condition returned in the Query REST AP [%hardbreaks] {blank} + a¦ String @@ -789,6 +791,7 @@ The name should be fully qualified. [%hardbreaks] *Example:* `+++"indexing.scan.io_failure"+++` {blank} + a¦ String @@ -809,6 +812,7 @@ One of the following SQL++ severity levels, listed in order of severity: [%hardbreaks] {blank} + a¦ Integer @@ -825,6 +829,7 @@ If the value is `false`, it tells clients and users that a retry without modific [%hardbreaks] {blank} + a¦ Boolean @@ -887,6 +892,7 @@ The value of the query setting Scan Consistency used for the query. [%hardbreaks] {blank} + a¦ String @@ -902,6 +908,7 @@ Whether the cost-based optimizer was enabled for the query. [%hardbreaks] {blank} + a¦ Boolean @@ -918,6 +925,7 @@ This property is only returned if a memory quota was set for the query. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -934,6 +942,7 @@ The type of query statement. [%hardbreaks] *Example:* `+++"SELECT"+++` {blank} + a¦ String @@ -992,6 +1001,7 @@ Note that bucket names may be prefixed with `local:`, and admin names may be pre [%hardbreaks] *Example:* `+++"local:bucket-name"+++` {blank} + a¦ String @@ -1008,6 +1018,7 @@ A password for authentication. [%hardbreaks] *Example:* `+++"password"+++` {blank} + a¦ String @@ -1072,6 +1083,7 @@ Name of the operator. [%hardbreaks] *Example:* `+++"Fetch"+++` {blank} + a¦ String @@ -1087,6 +1099,7 @@ include::index.adoc[tag=desc-Statistics, opts=optional] [%hardbreaks] {blank} + a¦ xref:Statistics[] @@ -1102,6 +1115,7 @@ Further nested operators, each with their own execution timings. [%hardbreaks] {blank} + a¦ Object @@ -1163,6 +1177,7 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} + a¦ String @@ -1178,6 +1193,7 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} + a¦ String @@ -1193,6 +1209,7 @@ The total number of objects in the results. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1208,6 +1225,7 @@ The total number of bytes in the results. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1223,6 +1241,7 @@ The number of mutations that were made during the request. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1241,6 +1260,7 @@ If a query includes ORDER BY, LIMIT, or OFFSET clauses, an application can use t [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1257,6 +1277,7 @@ This property is only returned if a memory quota was set for the query. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1272,6 +1293,7 @@ The number of errors that occurred during the request. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1287,6 +1309,7 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} + a¦ Integer (unsigned) @@ -1349,6 +1372,7 @@ Timestamp when the query was received. [%hardbreaks] {blank} + a¦ Date (date-time) @@ -1364,6 +1388,7 @@ IP address and port number of the node where the query was executed. [%hardbreaks] {blank} + a¦ String @@ -1380,6 +1405,7 @@ Count of documents processed at selective phases involved in the query execution [%hardbreaks] *Example:* `{"fetch":16,"indexScan":187}` {blank} + a¦ Object @@ -1402,6 +1428,7 @@ This is in essence the count of all the operators in the `executionTimings` obje [%hardbreaks] *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} + a¦ Object @@ -1418,6 +1445,7 @@ Cumulative execution times for various phases involved in the query execution, s [%hardbreaks] *Example:* `{"authorize":"823.631µs","fetch":"656.873µs","indexScan":"29.146543ms","instantiate":"236.221µs","parse":"826.382µs","plan":"11.831101ms","run":"16.892181ms"}` {blank} + a¦ Object @@ -1433,6 +1461,7 @@ include::index.adoc[tag=desc-Execution_Timings, opts=optional] [%hardbreaks] {blank} + a¦ xref:Execution_Timings[] @@ -1497,6 +1526,7 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d [%hardbreaks] *Example:* `["LAX",6]` {blank} + a¦ Any Type array @@ -1529,6 +1559,7 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Example:* `+++"default:`travel-sample`.transaction.test"+++` {blank} + a¦ String @@ -1551,6 +1582,7 @@ Refer to [Auto-Execute][auto-execute] for more information. *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -1570,6 +1602,7 @@ SQL++ is agnostic about the content of this parameter; it is just echoed in the [%hardbreaks] {blank} + a¦ String @@ -1590,6 +1623,7 @@ Values are case-insensitive. *Default:* `+++"NONE"+++` *Example:* `+++"zip"+++` {blank} + a¦ String @@ -1619,6 +1653,7 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Example:* `true` {blank} + a¦ Boolean @@ -1641,6 +1676,7 @@ If credentials are supplied in the request header, then HTTP Basic Authenticatio [%hardbreaks] *Example:* `[{"user":"local:bucket-name","pass":"password"},{"user":"admin:admin-name","pass":"password"}]` {blank} + a¦ xref:Credentials[] array @@ -1669,6 +1705,7 @@ Set the durability level to `"none"` or `""` to specify no durability. *Default:* `+++"majority"+++` *Example:* `+++"none"+++` {blank} + a¦ String @@ -1685,6 +1722,7 @@ It is included for compatibility with previous versions of Couchbase Server. [%hardbreaks] {blank} + a¦ String @@ -1703,6 +1741,7 @@ Only possible value is `UTF-8` and is case-insensitive. [%hardbreaks] *Default:* `+++"UTF-8"+++` {blank} + a¦ String @@ -1723,6 +1762,7 @@ Values are case-insensitive. *Default:* `+++"JSON"+++` *Example:* `+++"XML"+++` {blank} + a¦ String @@ -1757,6 +1797,7 @@ When disabled, no timeout is applied and the KV operation runs for however long *Default:* `+++"2.5s"+++` *Example:* `+++"10ms"+++` {blank} + a¦ String @@ -1793,6 +1834,7 @@ To enable queries to run in parallel, you must specify the cluster-level `queryM [%hardbreaks] *Example:* `3` {blank} + a¦ Integer (int32) @@ -1834,6 +1876,7 @@ When you change the cluster-level setting, the node-level setting is overwritten *Default:* `0` *Example:* `4` {blank} + a¦ Integer (int32) @@ -1851,6 +1894,7 @@ Specifies that metrics should be returned with query results. *Default:* `true` *Example:* `false` {blank} + a¦ Boolean @@ -1868,6 +1912,7 @@ Currently, only the `default` namespace is available. [%hardbreaks] *Example:* `+++"default"+++` {blank} + a¦ String @@ -1902,6 +1947,7 @@ When you change the cluster-level setting, the node-level setting is overwritten *Default:* `1024` *Example:* `512` {blank} + a¦ Integer (int32) @@ -1932,6 +1978,7 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `64` {blank} + a¦ Integer (int32) @@ -1962,6 +2009,7 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `1024` {blank} + a¦ Integer (int32) @@ -1985,6 +2033,7 @@ If both `prepared` and `statement` are present and non-empty, an error is return [%hardbreaks] *Example:* `+++"[127.0.0.1:8091]pricy_hotel"+++` {blank} + a¦ String @@ -2009,6 +2058,7 @@ Not supported for statements in a transaction. *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -2034,6 +2084,7 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Example:* `false` {blank} + a¦ Boolean @@ -2073,6 +2124,7 @@ The request-level parameter overrides the node-level setting. *Values:* `"off"`, `"phases"`, `"timings"` *Example:* `+++"phases"+++` {blank} + a¦ String @@ -2094,6 +2146,7 @@ If the namespace name is omitted, the default namespace in the current session i *Default:* `+++"default:"+++` *Example:* `+++"default:travel-sample.inventory"+++` {blank} + a¦ String @@ -2122,6 +2175,7 @@ When using GET requests, it's best to set `readonly` to `true`. *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -2156,6 +2210,7 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `1024` {blank} + a¦ Integer (int32) @@ -2205,6 +2260,7 @@ Refer to [Transactional Scan Consistency][transactional-scan-consistency] for de *Default:* `+++"not_bounded"+++` *Example:* `+++"at_plus"+++` {blank} + a¦ String @@ -2237,6 +2293,7 @@ For queries referencing multiple keyspaces, use `scan_vectors`. [%hardbreaks] *Example:* `{"5":[5409393,"VB5ID"],"19":[47574574,"VB19ID"]}` {blank} + a¦ Object @@ -2257,6 +2314,7 @@ The scan vectors can be Full or Sparse. [%hardbreaks] {blank} + a¦ Object @@ -2291,6 +2349,7 @@ Specify `0` or a negative integer to disable. *Default:* `+++""+++` *Example:* `+++"30m"+++` {blank} + a¦ String (duration) @@ -2308,6 +2367,7 @@ Include a header for the results schema in the response. *Default:* `true` *Example:* `false` {blank} + a¦ Boolean @@ -2327,6 +2387,7 @@ If `false` (the default), statement projection terms are returned in the order s *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -2355,6 +2416,7 @@ This restriction does not apply when specifying the request parameters in JSON f [%hardbreaks] *Example:* `+++"SELECT * FROM `travel-sample`.inventory.hotel LIMIT 1"+++` {blank} + a¦ String @@ -2403,6 +2465,7 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `+++"30m"+++` {blank} + a¦ String (duration) @@ -2419,6 +2482,7 @@ For internal use only. [%hardbreaks] {blank} + a¦ Object @@ -2442,6 +2506,7 @@ The transaction must be active and non-expired. [%hardbreaks] *Example:* `+++"d81d9b4a-b758-4f98-b007-87ba262d3a51"+++` {blank} + a¦ UUID (UUID) @@ -2465,6 +2530,7 @@ If the `txid` request-level parameter is set, the `tximplicit` parameter is igno *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -2483,6 +2549,7 @@ If the transaction statement number is lower than the transaction statement numb [%hardbreaks] *Example:* `10` {blank} + a¦ Integer (int32) @@ -2536,6 +2603,7 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `+++"30m"+++` {blank} + a¦ String (duration) @@ -2566,6 +2634,7 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `true` {blank} + a¦ Boolean @@ -2593,6 +2662,7 @@ Refer to [Flex Indexes][flex-indexes] for more information. *Default:* `false` *Example:* `true` {blank} + a¦ Boolean @@ -2642,6 +2712,7 @@ When you change the cluster-level setting, the node-level setting is overwritten *Default:* `+++"unset"+++` *Example:* `+++"true"+++` {blank} + a¦ String @@ -2671,6 +2742,7 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d [%hardbreaks] {blank} + a¦ Any Type @@ -2732,6 +2804,7 @@ A unique identifier for the response. [%hardbreaks] {blank} + a¦ UUID (UUID) @@ -2747,6 +2820,7 @@ The client context ID of the request, if one was supplied — see `client_co [%hardbreaks] {blank} + a¦ String @@ -2764,6 +2838,7 @@ Present only when the query completes successfully. [%hardbreaks] *Example:* `{"id":"json"}` {blank} + a¦ Object @@ -2780,6 +2855,7 @@ An object can be any JSON value. [%hardbreaks] {blank} + a¦ Any Type array @@ -2796,6 +2872,7 @@ The status of the request. [%hardbreaks] *Values:* `"success"`, `"running"`, `"errors"`, `"completed"`, `"stopped"`, `"timeout"`, `"fatal"` {blank} + a¦ String @@ -2812,6 +2889,7 @@ If an error occurred during processing of the request, it will be represented by [%hardbreaks] {blank} + a¦ xref:Conditions[] array @@ -2828,6 +2906,7 @@ If a warning occurred during processing of the request, it is represented by a w [%hardbreaks] {blank} + a¦ xref:Conditions[] array @@ -2843,6 +2922,7 @@ include::index.adoc[tag=desc-Metrics, opts=optional] [%hardbreaks] {blank} + a¦ xref:Metrics[] @@ -2858,6 +2938,7 @@ include::index.adoc[tag=desc-Controls, opts=optional] [%hardbreaks] {blank} + a¦ xref:Controls[] @@ -2873,6 +2954,7 @@ include::index.adoc[tag=desc-Profile, opts=optional] [%hardbreaks] {blank} + a¦ xref:Profile[] @@ -2935,6 +3017,7 @@ Number of input documents to the operator. [%hardbreaks] *Example:* `187` {blank} + a¦ Integer (int32) @@ -2951,6 +3034,7 @@ Number of output documents after the operator processing. [%hardbreaks] *Example:* `16` {blank} + a¦ Integer (int32) @@ -2967,6 +3051,7 @@ Number of switches between executing, waiting for services, or waiting for the g [%hardbreaks] *Example:* `413` {blank} + a¦ Integer (int32) @@ -2983,6 +3068,7 @@ Time spent executing the operator code inside SQL++ query engine. [%hardbreaks] *Example:* `+++"128.434µs"+++` {blank} + a¦ String (duration) @@ -2999,6 +3085,7 @@ Time spent waiting to be scheduled for CPU time. [%hardbreaks] *Example:* `+++"15.027879ms"+++` {blank} + a¦ String (duration) @@ -3019,6 +3106,7 @@ For fetch, it is time spent waiting on the KV store. [%hardbreaks] *Example:* `+++"1.590934ms"+++` {blank} + a¦ String (duration) diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index 70574ce2..837357ef 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -925,6 +925,7 @@ Setting this field to `true` enables access to all endpoints. [%hardbreaks] {blank} + a¦ Boolean @@ -947,6 +948,7 @@ Note that each URL must include the port, protocol, and all other components of [%hardbreaks] {blank} + a¦ String array @@ -968,6 +970,7 @@ Note that each URL must include the port, protocol, and all other components of [%hardbreaks] {blank} + a¦ String array @@ -1035,6 +1038,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} + a¦ Boolean @@ -1061,6 +1065,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} + a¦ Boolean @@ -1101,6 +1106,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `+++"60s"+++` *Example:* `+++"30s"+++` {blank} + a¦ String (duration) @@ -1134,6 +1140,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `4000` *Example:* `7000` {blank} + a¦ Integer (int32) @@ -1169,6 +1176,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `20840448` {blank} + a¦ Integer (int32) @@ -1203,6 +1211,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `1000` *Example:* `7000` {blank} + a¦ Integer (int32) @@ -1252,6 +1261,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `+++"INFO"+++` *Example:* `+++"DEBUG"+++` {blank} + a¦ String @@ -1296,6 +1306,7 @@ NOTE: To enable queries to run in parallel, you must specify the cluster-level ` *Default:* `1` *Example:* `0` {blank} + a¦ Integer (int32) @@ -1333,6 +1344,7 @@ If a request includes this parameter, it will be capped by the node-level `memor *Default:* `0` *Example:* `4` {blank} + a¦ Integer (int32) @@ -1358,6 +1370,7 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] {blank} + a¦ Integer (int32) @@ -1394,6 +1407,7 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} + a¦ Integer (int32) @@ -1422,6 +1436,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `100` {blank} + a¦ Integer (int32) @@ -1457,6 +1472,7 @@ If a request includes this parameter, it will be capped by the node-level `numat *Exclusive minimum:* `true` *Example:* `512` {blank} + a¦ Integer (int32) @@ -1489,6 +1505,7 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} + a¦ Integer (int32) @@ -1520,6 +1537,7 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. *Default:* `16` *Example:* `64` {blank} + a¦ Integer (int32) @@ -1551,6 +1569,7 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} + a¦ Integer (int32) @@ -1578,6 +1597,7 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `16384` *Example:* `65536` {blank} + a¦ Integer (int32) @@ -1613,6 +1633,7 @@ The minimum of that and the node-level `scan-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} + a¦ Integer (int32) @@ -1650,6 +1671,7 @@ The minimum of that and the node-level `timeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} + a¦ Long (int64) @@ -1700,6 +1722,7 @@ If a request includes this parameter, it will be capped by the node-level `txtim *Default:* `+++"0ms"+++` *Example:* `+++"0.5s"+++` {blank} + a¦ String (duration) @@ -1721,6 +1744,7 @@ The default path is `var/lib/couchbase/tmp` within the Couchbase Server installa [%hardbreaks] *Example:* `+++"/opt/couchbase/var/lib/couchbase/tmp"+++` {blank} + a¦ String @@ -1743,6 +1767,7 @@ The maximum size is limited only by the available disk space. *Default:* `5120` *Example:* `2048` {blank} + a¦ Integer (int32) @@ -1774,6 +1799,7 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `true` *Example:* `false` {blank} + a¦ Boolean @@ -1822,6 +1848,7 @@ If the request-level parameter and the node-level setting are both `unset`, read *Default:* `+++"unset"+++` *Example:* `+++"on"+++` {blank} + a¦ String @@ -1837,6 +1864,7 @@ include::index.adoc[tag=desc-Access, opts=optional] [%hardbreaks] {blank} + a¦ xref:Access[] From 61374139b7fa1c2227f9b6d32bb690462a85fb22 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 10 Jul 2025 18:54:09 +0100 Subject: [PATCH 7/9] Another minor tweak --- templates/property.mustache | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/templates/property.mustache b/templates/property.mustache index ff0b7e4f..19eccde5 100644 --- a/templates/property.mustache +++ b/templates/property.mustache @@ -95,5 +95,5 @@ include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{#vendorExtensions.x-has-example}} *Example:* `{{#isString}}+++"{{/isString}}{{{example}}}{{#isString}}"+++{{/isString}}` {{/vendorExtensions.x-has-example}} -{blank} -{{! OpenAPI generator doesn't support externalDocs in schemas, so don't try }} \ No newline at end of file +{{! OpenAPI generator doesn't support externalDocs in schemas, so don't try }} +{blank} \ No newline at end of file From b3d20df326cbedaa3f3123a5529883813820796c Mon Sep 17 00:00:00 2001 From: tech-comm-team-couchbase Date: Thu, 10 Jul 2025 17:55:28 +0000 Subject: [PATCH 8/9] Build output documentation --- .../analytics-rest-admin/pages/index.adoc | 75 ------- .../analytics-rest-config/pages/index.adoc | 50 ----- .../analytics-rest-library/pages/index.adoc | 4 - .../analytics-rest-links/pages/index.adoc | 43 ---- .../analytics-rest-service/pages/index.adoc | 44 ---- .../analytics-rest-settings/pages/index.adoc | 1 - .../eventing-rest-api/pages/index.adoc | 77 ------- .../fts-rest-advanced/pages/index.adoc | 33 --- .../fts-rest-indexing/pages/index.adoc | 114 ---------- docs/modules/fts-rest-manage/pages/index.adoc | 3 - docs/modules/fts-rest-nodes/pages/index.adoc | 81 ------- docs/modules/fts-rest-query/pages/index.adoc | 21 -- docs/modules/fts-rest-stats/pages/index.adoc | 111 ---------- .../modules/index-rest-stats/pages/index.adoc | 36 ---- docs/modules/n1ql-rest-admin/pages/index.adoc | 203 ------------------ .../n1ql-rest-functions/pages/index.adoc | 5 - docs/modules/n1ql-rest-query/pages/index.adoc | 88 -------- .../n1ql-rest-settings/pages/index.adoc | 28 --- 18 files changed, 1017 deletions(-) diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index 1755f7d7..c5bfb933 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -1586,7 +1586,6 @@ An array of objects, each giving information about a single linked Analytics sco [%hardbreaks] {blank} - a¦ xref:IngestionLink[] array @@ -1644,7 +1643,6 @@ The name of the link. [%hardbreaks] *Example:* `+++"Local"+++` {blank} - a¦ String @@ -1661,7 +1659,6 @@ The name of the Analytics scope. [%hardbreaks] *Example:* `+++"travel-sample/inventory"+++` {blank} - a¦ String @@ -1679,7 +1676,6 @@ The status of the Analytics scope. *Values:* `"healthy"`, `"stopped"`, `"unhealthy"`, `"suspended"` *Example:* `+++"healthy"+++` {blank} - a¦ String @@ -1698,7 +1694,6 @@ Analytics collections which have the same ingestion state within this Analytics [%hardbreaks] {blank} - a¦ xref:IngestionLinkState[] array @@ -1756,7 +1751,6 @@ The time since epoch that this sample was calculated, in milliseconds. [%hardbreaks] *Example:* `1631273689161` {blank} - a¦ Integer @@ -1775,7 +1769,6 @@ The percentage (fraction from 0 to 1) of ingestion progress at the current time. *Maximum:* `1` *Example:* `0` {blank} - a¦ Double (double) @@ -1793,7 +1786,6 @@ The estimated time that the ingestion lags behind the Data service, in milliseco [%hardbreaks] *Example:* `9744` {blank} - a¦ Integer @@ -1813,7 +1805,6 @@ Note that this value is reset on connect, so it may appear to get smaller. [%hardbreaks] *Example:* `12301` {blank} - a¦ Integer @@ -1831,7 +1822,6 @@ The change in sequence number (seqno) since last connect. Only displayed for Ana [%hardbreaks] *Example:* `61` {blank} - a¦ Integer @@ -1847,7 +1837,6 @@ An array of objects, each one giving information about a single Analytics scope. [%hardbreaks] {blank} - a¦ xref:IngestionLinkStateScope[] array @@ -1905,7 +1894,6 @@ The name of the Analytics scope. [%hardbreaks] *Example:* `+++"travel-sample/inventory"+++` {blank} - a¦ String @@ -1921,7 +1909,6 @@ An array of objects, each one giving information about a single Analytics collec [%hardbreaks] {blank} - a¦ xref:IngestionLinkStateScopeColl[] array @@ -1979,7 +1966,6 @@ The name of the Analytics collection. [%hardbreaks] *Example:* `+++"route"+++` {blank} - a¦ String @@ -2042,7 +2028,6 @@ include::index.adoc[tag=desc-MutationsColl, opts=optional] [%hardbreaks] {blank} - a¦ xref:MutationsColl[] @@ -2109,7 +2094,6 @@ The number of mutations in the DCP queue that have not yet been ingested. The na [%hardbreaks] {blank} - a¦ Integer @@ -2171,7 +2155,6 @@ Whether this request can be cancelled. [%hardbreaks] {blank} - a¦ Boolean @@ -2188,7 +2171,6 @@ A context ID for debugging purposes. [%hardbreaks] *Example:* `+++"28379d60-7139-44d6-b57a-95935540b586"+++` {blank} - a¦ String @@ -2205,7 +2187,6 @@ How long the request has been running in seconds. [%hardbreaks] *Example:* `0.126` {blank} - a¦ Big Decimal @@ -2222,7 +2203,6 @@ The date and time when the request's job was created. [%hardbreaks] *Example:* `+++"2024-05-28T19:47:02.512"+++` {blank} - a¦ String @@ -2240,7 +2220,6 @@ The request's job ID. This value can be null if request did not run (for example [%hardbreaks] *Example:* `+++"JID:0.14"+++` {blank} - a¦ String @@ -2257,7 +2236,6 @@ How long the request's job has been in the queue waiting to run in seconds. [%hardbreaks] *Example:* `0` {blank} - a¦ Big Decimal @@ -2274,7 +2252,6 @@ The number of CPU cores required to run this request. [%hardbreaks] *Example:* `1` {blank} - a¦ Integer @@ -2292,7 +2269,6 @@ The bytes of RAM being used to process this request. [%hardbreaks] *Example:* `34013184` {blank} - a¦ Integer @@ -2309,7 +2285,6 @@ The date and time the request's job began running. [%hardbreaks] *Example:* `+++"2024-05-28T19:47:02.514"+++` {blank} - a¦ String @@ -2327,7 +2302,6 @@ The state of the request's job. *Values:* `"PENDING"`, `"RUNNING"`, `"TERMINATED"`, `"FAILURE"`, `"FAILURE_BEFORE_EXECUTION"`, `"null"` *Example:* `+++"RUNNING"+++` {blank} - a¦ String @@ -2343,7 +2317,6 @@ The query plan for this request. [%hardbreaks] {blank} - a¦ String @@ -2360,7 +2333,6 @@ The Analytics node that received the request. [%hardbreaks] *Example:* `+++"172.20.0.2:8095"+++` {blank} - a¦ String @@ -2377,7 +2349,6 @@ The network address and port of the client that made the request. [%hardbreaks] *Example:* `+++"172.20.0.123:53612"+++` {blank} - a¦ String @@ -2394,7 +2365,6 @@ The date and time the request was received. [%hardbreaks] *Example:* `+++"2024-05-28T19:44:07.730"+++` {blank} - a¦ String @@ -2411,7 +2381,6 @@ The Scan Consistency setting used for the request's query. [%hardbreaks] *Example:* `+++"not_bounded"+++` {blank} - a¦ String @@ -2429,7 +2398,6 @@ The state of the request. *Values:* `"received"`, `"running"`, `"cancelled"`, `"completed"` *Example:* `+++"running"+++` {blank} - a¦ String @@ -2446,7 +2414,6 @@ The SQL++ query statement being run by the request. [%hardbreaks] *Example:* `+++"select count(*) from hotel_endorsement_view;"+++` {blank} - a¦ String @@ -2463,7 +2430,6 @@ The user agent string of the browser that made the request. [%hardbreaks] *Example:* `+++"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:126.0) Gecko/20100101 Firefox/126.0"+++` {blank} - a¦ String @@ -2480,7 +2446,6 @@ The user who made the request. [%hardbreaks] *Example:* `+++"Administrator"+++` {blank} - a¦ String @@ -2497,7 +2462,6 @@ The unique identifier for this request. [%hardbreaks] *Example:* `+++"91f60338-a3e0-4163-9287-5e723fda29ef"+++` {blank} - a¦ String @@ -2560,7 +2524,6 @@ An array of strings, each of which is the ID of an authorized Analytics node. [%hardbreaks] *Example:* `["86586a966202b5aa4aed31633f330aba","948fb3af810a9b7bc6c76e2a69ba35d9"]` {blank} - a¦ String array @@ -2577,7 +2540,6 @@ The ID of the cluster controller node. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} - a¦ String @@ -2594,7 +2556,6 @@ The path of the Analytics Node Configuration REST API. [%hardbreaks] *Example:* `+++"/analytics/config/node"+++` {blank} - a¦ String @@ -2612,7 +2573,6 @@ The path of the Analytics Node Diagnostics REST API. For internal use only. [%hardbreaks] *Example:* `+++"/analytics/node/diagnostics"+++` {blank} - a¦ String @@ -2629,7 +2589,6 @@ The path of the Analytics Node Restart REST API. [%hardbreaks] *Example:* `+++"/analytics/node/restart"+++` {blank} - a¦ String @@ -2646,7 +2605,6 @@ The path of the Analytics Query Service REST API. [%hardbreaks] *Example:* `+++"/analytics/service"+++` {blank} - a¦ String @@ -2663,7 +2621,6 @@ The path of the Analytics Service Configuration REST API. [%hardbreaks] *Example:* `+++"/analytics/config/service"+++` {blank} - a¦ String @@ -2681,7 +2638,6 @@ The full URI of the Analytics Service Diagnostics REST API. For internal use onl [%hardbreaks] *Example:* `+++"http://localhost:8095/analytics/cluster/diagnostics"+++` {blank} - a¦ String @@ -2698,7 +2654,6 @@ The full URI of the Analytics Cluster Restart REST API. [%hardbreaks] *Example:* `+++"http://localhost:8095/analytics/cluster/restart"+++` {blank} - a¦ String @@ -2716,7 +2671,6 @@ The state of the Analytics Service. *Values:* `"ACTIVE"`, `"REBALANCE_REQUIRED"`, `"UNUSABLE"`, `"SHUTTING_DOWN"` *Example:* `+++"ACTIVE"+++` {blank} - a¦ String @@ -2732,7 +2686,6 @@ An array of objects, each giving information about one Analytics node. [%hardbreaks] {blank} - a¦ xref:StatusNodes[] array @@ -2748,7 +2701,6 @@ An array of objects, each giving information about one Analytics partition. [%hardbreaks] {blank} - a¦ xref:StatusPartitions[] array @@ -2764,7 +2716,6 @@ include::index.adoc[tag=desc-StatusTopology, opts=optional] [%hardbreaks] {blank} - a¦ xref:StatusTopology[] @@ -2822,7 +2773,6 @@ The URI scheme, host, and port for HTTP access to Analytics REST APIs on this no [%hardbreaks] *Example:* `+++"http://192.168.8.101:8095"+++` {blank} - a¦ String @@ -2839,7 +2789,6 @@ The URI scheme, host, and port for secure HTTPS access to Analytics REST APIs on [%hardbreaks] *Example:* `+++"https://192.168.8.101:18095"+++` {blank} - a¦ String @@ -2856,7 +2805,6 @@ The ID of the node. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} - a¦ String @@ -2873,7 +2821,6 @@ The name or IP address of the node, including the cluster administration port. [%hardbreaks] *Example:* `+++"192.168.8.101:8091"+++` {blank} - a¦ String @@ -2931,7 +2878,6 @@ Indicates whether this partition is active. [%hardbreaks] *Example:* `true` {blank} - a¦ Boolean @@ -2948,7 +2894,6 @@ The ID of the node where this partition is currently active. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} - a¦ String @@ -2965,7 +2910,6 @@ The number of the IO Device where this partition is located. [%hardbreaks] *Example:* `0` {blank} - a¦ Integer @@ -2982,7 +2926,6 @@ The ID of the node where this partition originated. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} - a¦ String @@ -2999,7 +2942,6 @@ The ID of this partition. [%hardbreaks] *Example:* `0` {blank} - a¦ Integer @@ -3016,7 +2958,6 @@ The path of the IO Device where this partition is located. [%hardbreaks] *Example:* `+++"/data/@analytics/v_iodevice_0"+++` {blank} - a¦ String @@ -3033,7 +2974,6 @@ Indicates whether this partition is waiting to become active. [%hardbreaks] *Example:* `false` {blank} - a¦ Boolean @@ -3096,7 +3036,6 @@ Indicates whether the Analytics nodes are balanced. [%hardbreaks] *Example:* `true` {blank} - a¦ Boolean @@ -3113,7 +3052,6 @@ The ID of the cluster controller node. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} - a¦ String @@ -3130,7 +3068,6 @@ The ID of the metadata partition. [%hardbreaks] *Example:* `-1` {blank} - a¦ Integer @@ -3147,7 +3084,6 @@ The number of Analytics replicas. [%hardbreaks] *Example:* `1` {blank} - a¦ Integer @@ -3164,7 +3100,6 @@ The revision number of the partition topology. [%hardbreaks] *Example:* `1` {blank} - a¦ Integer @@ -3181,7 +3116,6 @@ The version number of the partition topology. [%hardbreaks] *Example:* `1` {blank} - a¦ Integer @@ -3197,7 +3131,6 @@ An array of objects, each giving information about the state of one Analytics pa [%hardbreaks] {blank} - a¦ xref:StatusTopologyState[] array @@ -3255,7 +3188,6 @@ The partition ID. [%hardbreaks] *Example:* `0` {blank} - a¦ Integer @@ -3272,7 +3204,6 @@ The ID of the node where the partition is currently active. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} - a¦ String @@ -3289,7 +3220,6 @@ The ID of the node where the partition originated. [%hardbreaks] *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} - a¦ String @@ -3305,7 +3235,6 @@ An array of objects, each giving information about the state of one Analytics re [%hardbreaks] {blank} - a¦ xref:StatusTopologyStateReplicas[] array @@ -3363,7 +3292,6 @@ The name or IP address of the node where this replica is located, including the [%hardbreaks] *Example:* `+++"192.168.8.102:9120"+++` {blank} - a¦ String @@ -3380,7 +3308,6 @@ The ID of the node where this replica is located. [%hardbreaks] *Example:* `+++"948fb3af810a9b7bc6c76e2a69ba35d9"+++` {blank} - a¦ String @@ -3398,7 +3325,6 @@ The synchronization status of the replica. *Values:* `"IN_SYNC"`, `"CATCHING_UP"`, `"DISCONNECTED"` *Example:* `+++"IN_SYNC"+++` {blank} - a¦ String @@ -3417,7 +3343,6 @@ The percentage (fraction from 0 to 1) of synchronization progress for this repli *Maximum:* `1` *Example:* `1` {blank} - a¦ Double (double) diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc index 69fd8f4c..3adc1689 100644 --- a/docs/modules/analytics-rest-config/pages/index.adoc +++ b/docs/modules/analytics-rest-config/pages/index.adoc @@ -958,7 +958,6 @@ An error message. [%hardbreaks] {blank} - a¦ String @@ -1026,7 +1025,6 @@ To pass arguments opaquely, you may use [Java command-line argument files][3]. [%hardbreaks] {blank} - a¦ String @@ -1045,7 +1043,6 @@ The default is 1/4 of the allocated Analytics Service memory. [%hardbreaks] {blank} - a¦ Integer @@ -1064,7 +1061,6 @@ The default is 1/4 of the allocated Analytics Service memory. [%hardbreaks] {blank} - a¦ Integer @@ -1122,7 +1118,6 @@ The memory budget (in bytes) for the active runtime. [%hardbreaks] *Default:* `67108864` {blank} - a¦ Integer (int32) @@ -1139,7 +1134,6 @@ The maximum time (in seconds) to wait for a graceful stop of an active runtime. [%hardbreaks] *Default:* `3600` {blank} - a¦ Integer (int32) @@ -1156,7 +1150,6 @@ The maximum time (in seconds) to wait for a graceful suspend of an active runtim [%hardbreaks] *Default:* `3600` {blank} - a¦ Integer (int32) @@ -1173,7 +1166,6 @@ The number of processed mutations after which the DCP state is broadcast to stor [%hardbreaks] *Default:* `10000` {blank} - a¦ Integer (int32) @@ -1190,7 +1182,6 @@ The maximum number of HTTP requests to queue pending ability to execute. [%hardbreaks] *Default:* `256` {blank} - a¦ Integer (int32) @@ -1207,7 +1198,6 @@ The number of threads to service HTTP requests. [%hardbreaks] *Default:* `16` {blank} - a¦ Integer (int32) @@ -1223,7 +1213,6 @@ The bind address to use. [%hardbreaks] {blank} - a¦ String @@ -1240,7 +1229,6 @@ Bind to configured hostname instead of wildcard address. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -1257,7 +1245,6 @@ Number of attempts to contact CC before giving up. [%hardbreaks] *Default:* `5` {blank} - a¦ Integer (int32) @@ -1274,7 +1261,6 @@ The maximum time to wait to collect DCP state from all nodes in seconds. [%hardbreaks] *Default:* `600` {blank} - a¦ Integer (int32) @@ -1291,7 +1277,6 @@ The page size (in bytes) for computation. [%hardbreaks] *Default:* `32768` {blank} - a¦ Integer (int32) @@ -1308,7 +1293,6 @@ The memory budget (in bytes) for a group by operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} - a¦ Integer (int32) @@ -1325,7 +1309,6 @@ The memory budget (in bytes) for a join operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} - a¦ Integer (int32) @@ -1343,7 +1326,6 @@ The degree of parallelism for query execution. Zero means to use the storage par [%hardbreaks] *Default:* `0` {blank} - a¦ Integer (int32) @@ -1360,7 +1342,6 @@ Enables or disables full parallel sort. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -1377,7 +1358,6 @@ The memory budget (in bytes) for a sort operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} - a¦ Integer (int32) @@ -1394,7 +1374,6 @@ The memory budget (in bytes) for a window operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} - a¦ Integer (int32) @@ -1411,7 +1390,6 @@ The factor to multiply by the number of cores to determine maximum query concurr [%hardbreaks] *Default:* `3` {blank} - a¦ Integer (int32) @@ -1431,7 +1409,6 @@ The percentage of DCP connection buffer size at which to acknowledge bytes consu *Minimum:* `1` *Maximum:* `100` {blank} - a¦ Integer (int32) @@ -1449,7 +1426,6 @@ Reconnect remote DCP channels that are idle for the specified number of seconds [%hardbreaks] *Default:* `120` {blank} - a¦ Integer (int32) @@ -1468,7 +1444,6 @@ Otherwise, the default is 1% of the JVM maximum heap size divided by the number [%hardbreaks] {blank} - a¦ Integer (int32) @@ -1485,7 +1460,6 @@ The delay (in seconds) to wait for graceful shutdown due to deadlocked threads, [%hardbreaks] *Default:* `120` {blank} - a¦ Integer (int32) @@ -1502,7 +1476,6 @@ The frequency (in seconds) to scan for deadlocked threads. [%hardbreaks] *Default:* `300` {blank} - a¦ Integer (int32) @@ -1519,7 +1492,6 @@ Limits the number of historical jobs remembered by the system to the specified v [%hardbreaks] *Default:* `10` {blank} - a¦ Integer (int32) @@ -1536,7 +1508,6 @@ The maximum number of jobs to queue before rejecting new jobs. [%hardbreaks] *Default:* `4096` {blank} - a¦ Integer (int32) @@ -1560,7 +1531,6 @@ To pass arguments opaquely, you may use [Java command-line argument files][3]. [%hardbreaks] {blank} - a¦ String @@ -1577,7 +1547,6 @@ The logging level. [%hardbreaks] *Default:* `+++"DEBUG"+++` {blank} - a¦ String @@ -1594,7 +1563,6 @@ The maximum accepted web request size in bytes. [%hardbreaks] *Default:* `52428800` {blank} - a¦ Integer (int32) @@ -1611,7 +1579,6 @@ Number of network buffers per input/output channel. [%hardbreaks] *Default:* `1` {blank} - a¦ Integer (int32) @@ -1628,7 +1595,6 @@ Number of threads to use for Network I/O. [%hardbreaks] *Default:* `1` {blank} - a¦ Integer (int32) @@ -1645,7 +1611,6 @@ The frequency at which the Analytics collection size is pulled from nodes during [%hardbreaks] *Default:* `5` {blank} - a¦ Integer (int32) @@ -1663,7 +1628,6 @@ The maximum time (in seconds) to wait for a remote link connection to establish. [%hardbreaks] *Default:* `60` {blank} - a¦ Integer (int32) @@ -1681,7 +1645,6 @@ The maximum time (in seconds) to wait after establishing the connection for remo [%hardbreaks] *Default:* `60` {blank} - a¦ Integer (int32) @@ -1698,7 +1661,6 @@ The maximum number of archived requests to maintain. [%hardbreaks] *Default:* `50` {blank} - a¦ Integer (int32) @@ -1715,7 +1677,6 @@ The duration within which an instance of the result cleanup should be invoked in [%hardbreaks] *Default:* `60000` {blank} - a¦ Integer (int32) @@ -1732,7 +1693,6 @@ Limits the amount of time results for asynchronous jobs should be retained by th [%hardbreaks] *Default:* `86400000` {blank} - a¦ Integer (int32) @@ -1749,7 +1709,6 @@ The maximum number of open files in the buffer cache. [%hardbreaks] *Default:* `2147483647` {blank} - a¦ Integer (int32) @@ -1766,7 +1725,6 @@ The page size in bytes for pages in the buffer cache. [%hardbreaks] *Default:* `131072` {blank} - a¦ Integer (int32) @@ -1783,7 +1741,6 @@ The default compression scheme for the storage. [%hardbreaks] *Default:* `+++"snappy"+++` {blank} - a¦ String @@ -1800,7 +1757,6 @@ The number of memory components to be used per LSM index. [%hardbreaks] *Default:* `2` {blank} - a¦ Integer (int32) @@ -1817,7 +1773,6 @@ The page size in bytes for pages allocated to memory components. [%hardbreaks] *Default:* `131072` {blank} - a¦ Integer (int32) @@ -1835,7 +1790,6 @@ The maximum disk write rate for each storage partition in bytes per second. Disa [%hardbreaks] *Default:* `0` {blank} - a¦ Long (int64) @@ -1852,7 +1806,6 @@ The frequency (in seconds) at which to log diagnostic thread dumps. [%hardbreaks] *Default:* `300` {blank} - a¦ Integer (int32) @@ -1869,7 +1822,6 @@ The log level at which to emit diagnostic thread dumps. [%hardbreaks] *Default:* `+++"DEBUG"+++` {blank} - a¦ String @@ -1887,7 +1839,6 @@ Categories for tracing. The default is the empty array — no categories. [%hardbreaks] *Default:* `[]` {blank} - a¦ String array @@ -1904,7 +1855,6 @@ The interval (in seconds) after which an Analytics collection is considered idle [%hardbreaks] *Default:* `3600` {blank} - a¦ Integer (int32) diff --git a/docs/modules/analytics-rest-library/pages/index.adoc b/docs/modules/analytics-rest-library/pages/index.adoc index 7e286ad4..d6dac74d 100644 --- a/docs/modules/analytics-rest-library/pages/index.adoc +++ b/docs/modules/analytics-rest-library/pages/index.adoc @@ -876,7 +876,6 @@ An error message. [%hardbreaks] {blank} - a¦ String @@ -937,7 +936,6 @@ The scope name may contain one or two identifiers, separated by a slash (/). [%hardbreaks] *Example:* `+++"travel-sample/inventory"+++` {blank} - a¦ String @@ -953,7 +951,6 @@ A MD5 hash of the library residing on the server. [%hardbreaks] {blank} - a¦ String @@ -970,7 +967,6 @@ The name of the library. [%hardbreaks] *Example:* `+++"mylib"+++` {blank} - a¦ String diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc index ad3a9b35..379d5527 100644 --- a/docs/modules/analytics-rest-links/pages/index.adoc +++ b/docs/modules/analytics-rest-links/pages/index.adoc @@ -4103,7 +4103,6 @@ The scope name may contain one or two identifiers, separated by a slash (/). [%hardbreaks] *Example:* `+++"travel-sample/inventory"+++` {blank} - a¦ String @@ -4120,7 +4119,6 @@ The name of the link. [%hardbreaks] *Example:* `+++"myLink"+++` {blank} - a¦ String @@ -4142,7 +4140,6 @@ The type of the link. [%hardbreaks] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} - a¦ String @@ -4260,7 +4257,6 @@ The account key. Used for shared key authentication. This is redacted for the sa [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -4278,7 +4274,6 @@ The account name. Used for shared key authentication. If not set, this property [%hardbreaks] *Example:* `+++"myAccountName"+++` {blank} - a¦ String @@ -4296,7 +4291,6 @@ The client certificate for the registered application. Used for Azure Active Dir [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -4314,7 +4308,6 @@ The client certificate password for the registered application. Used for Azure A [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -4332,7 +4325,6 @@ The client ID for the registered application. Used for Azure Active Directory cl [%hardbreaks] *Example:* `+++"myClientID"+++` {blank} - a¦ String @@ -4350,7 +4342,6 @@ The client secret for the registered application. Used for Azure Active Director [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -4367,7 +4358,6 @@ The endpoint URI. [%hardbreaks] *Example:* `+++"my.endpoint.uri"+++` {blank} - a¦ String @@ -4385,7 +4375,6 @@ The managed identity ID. Used for managed identity authentication. If not set, t [%hardbreaks] *Example:* `+++"myManagedIdentityID"+++` {blank} - a¦ String @@ -4403,7 +4392,6 @@ A token that can be used for authentication. Used for shared access signature au [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -4421,7 +4409,6 @@ The tenant ID where the registered application is created. Used for Azure Active [%hardbreaks] *Example:* `+++"myTenantID"+++` {blank} - a¦ String @@ -4516,7 +4503,6 @@ The remote hostname. [%hardbreaks] *Example:* `+++"remoteHostName:8091"+++` {blank} - a¦ String @@ -4533,7 +4519,6 @@ Specifies whether the provided (bootstrap) hostname is an alternative address. [%hardbreaks] *Example:* `false` {blank} - a¦ Boolean @@ -4550,7 +4535,6 @@ The provided (bootstrap) hostname. [%hardbreaks] *Example:* `+++"remoteHostName:8091"+++` {blank} - a¦ String @@ -4567,7 +4551,6 @@ The content of the target cluster root certificate. Only set for links with full [%hardbreaks] {blank} - a¦ String @@ -4584,7 +4567,6 @@ The content of the client certificate. Only set for links with full encryption u [%hardbreaks] {blank} - a¦ String @@ -4601,7 +4583,6 @@ The content of the client key. Only set for links with full encryption using cli [%hardbreaks] {blank} - a¦ String @@ -4618,7 +4599,6 @@ For internal use only. [%hardbreaks] *Example:* `393221` {blank} - a¦ Integer @@ -4640,7 +4620,6 @@ The type of encryption used by the link. [%hardbreaks] *Values:* `"none"`, `"half"`, `"full"` {blank} - a¦ String @@ -4656,7 +4635,6 @@ An array of objects, each of which contains information about a node in the targ [%hardbreaks] {blank} - a¦ xref:ResponseCouchbaseSpecificNode[] array @@ -4674,7 +4652,6 @@ The password used to connect to the link. This is redacted for the sake of secur [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -4692,7 +4669,6 @@ The remote username. Not set for links with full encryption using client certifi [%hardbreaks] *Example:* `+++"remote.user"+++` {blank} - a¦ String @@ -4709,7 +4685,6 @@ A UUID uniquely identifying the link. [%hardbreaks] *Example:* `+++"6331e2a390125b662f7bcfd63ecb3a73"+++` {blank} - a¦ UUID (UUID) @@ -4767,7 +4742,6 @@ The alternate address defined on the node, if any. If not defined, this property [%hardbreaks] {blank} - a¦ String @@ -4784,7 +4758,6 @@ The hostname of the node. If not defined, this property returns `null`. [%hardbreaks] {blank} - a¦ String @@ -4800,7 +4773,6 @@ include::index.adoc[tag=desc-ResponseCouchbaseSpecificNodeServices, opts=optiona [%hardbreaks] {blank} - a¦ xref:ResponseCouchbaseSpecificNodeServices[] @@ -4863,7 +4835,6 @@ The port number for a connection to the Analytics service. [%hardbreaks] *Example:* `8095` {blank} - a¦ Integer @@ -4880,7 +4851,6 @@ The port number for an encrypted connection to the Analytics service. [%hardbreaks] *Example:* `18095` {blank} - a¦ Integer @@ -4897,7 +4867,6 @@ The port number for a connection to the Data service. [%hardbreaks] *Example:* `11210` {blank} - a¦ Integer @@ -4914,7 +4883,6 @@ The port number for an encrypted connection to the Data service. [%hardbreaks] *Example:* `11207` {blank} - a¦ Integer @@ -4931,7 +4899,6 @@ The port number for a connection to the Cluster Manager service. [%hardbreaks] *Example:* `8091` {blank} - a¦ Integer @@ -4948,7 +4915,6 @@ The port number for an encrypted connection to the Cluster Manager service. [%hardbreaks] *Example:* `18091` {blank} - a¦ Integer @@ -5045,7 +5011,6 @@ If present, indicates that the link should use the Google Application Default Cr *Values:* `"true"` *Example:* `+++"true"+++` {blank} - a¦ String @@ -5063,7 +5028,6 @@ The endpoint URI. If not set, this property returns `null`. [%hardbreaks] *Example:* `+++"https://storage.googleapis.com"+++` {blank} - a¦ String @@ -5081,7 +5045,6 @@ The JSON credentials of the link. If not set, this property returns `null`. [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -5176,7 +5139,6 @@ The Amazon S3 access key ID. [%hardbreaks] *Example:* `+++"myAccessKey"+++` {blank} - a¦ String @@ -5193,7 +5155,6 @@ The Amazon S3 region. [%hardbreaks] *Example:* `+++"us-east-1"+++` {blank} - a¦ String @@ -5211,7 +5172,6 @@ The Amazon S3 secret access key. This is redacted for the sake of security. [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -5229,7 +5189,6 @@ The Amazon S3 session token. Indicates that the link has temporary access, and t [%hardbreaks] *Example:* `+++""+++` {blank} - a¦ String @@ -5247,7 +5206,6 @@ Amazon S3 service endpoint. If not set, this property returns `null`. [%hardbreaks] *Example:* `+++"my.endpoint.uri"+++` {blank} - a¦ String @@ -5304,7 +5262,6 @@ An error message. [%hardbreaks] {blank} - a¦ String diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index bffeda95..61345e26 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -1082,7 +1082,6 @@ Specifies at least one valid SQL\+\+ for Analytics statement to run. [%hardbreaks] {blank} - a¦ String @@ -1099,7 +1098,6 @@ An identifier passed by the client that is returned verbatim in the query respon [%hardbreaks] {blank} - a¦ String @@ -1120,7 +1118,6 @@ Note that the only possible format is `JSON`. *Values:* `"JSON"` *Default:* `+++"JSON"+++` {blank} - a¦ String @@ -1137,7 +1134,6 @@ If `true`, the result is indented. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -1155,7 +1151,6 @@ A scope for the statement. The value of this parameter must start with `default: [%hardbreaks] *Default:* `+++"default:Default"+++` {blank} - a¦ String @@ -1172,7 +1167,6 @@ If `true`, then DDL statements are not allowed. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -1191,7 +1185,6 @@ The consistency guarantee constraint for index scanning. If `not_bounded`, the q *Values:* `"not_bounded"`, `"request_plus"` *Default:* `+++"not_bounded"+++` {blank} - a¦ String @@ -1209,7 +1202,6 @@ The maximum time to wait for datasets to be updated before the query is executed [%hardbreaks] *Default:* `+++""+++` {blank} - a¦ String @@ -1227,7 +1219,6 @@ Maximum time to spend on the request before timing out. The format includes an a [%hardbreaks] *Default:* `+++""+++` {blank} - a¦ String @@ -1243,7 +1234,6 @@ An array of positional parameter values. [%hardbreaks] {blank} - a¦ Any Type array @@ -1260,7 +1250,6 @@ A named parameter value. [%hardbreaks] {blank} - a¦ Any Type @@ -1319,7 +1308,6 @@ The plan format. *Values:* `"JSON"`, `"STRING"` *Default:* `+++"JSON"+++` {blank} - a¦ String @@ -1336,7 +1324,6 @@ If `true`, the logical plan is included in the query response. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -1353,7 +1340,6 @@ If `true`, the optimized logical plan is included in the query response. [%hardbreaks] *Default:* `true` {blank} - a¦ Boolean @@ -1370,7 +1356,6 @@ If `true`, the expression tree is included in the query response. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -1387,7 +1372,6 @@ If `true`, the rewritten expression tree is included in the query response. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -1404,7 +1388,6 @@ If `true`, the job details are included in the query response. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -1421,7 +1404,6 @@ An integer specifying the maximum number of warning messages to be included in t [%hardbreaks] *Default:* `0` {blank} - a¦ Integer (int32) @@ -1515,7 +1497,6 @@ A unique identifier for the response. [%hardbreaks] {blank} - a¦ UUID (UUID) @@ -1538,7 +1519,6 @@ refer to `client_context_id` in [Query Parameters][1]. [%hardbreaks] {blank} - a¦ String @@ -1555,7 +1535,6 @@ The schema of the results. Present only when the query completes successfully. [%hardbreaks] {blank} - a¦ Object @@ -1572,7 +1551,6 @@ An array of all the objects returned by the query. An object can be any JSON val [%hardbreaks] {blank} - a¦ Any Type array @@ -1589,7 +1567,6 @@ The status of the request. [%hardbreaks] *Values:* `"success"`, `"running"`, `"failed"`, `"timeout"`, `"fatal"` {blank} - a¦ String @@ -1606,7 +1583,6 @@ An array of error objects. Present only if 1 or more errors are returned during [%hardbreaks] {blank} - a¦ xref:ResponsesCommonErrors[] array @@ -1634,7 +1610,6 @@ By default, no warnings are returned, even if warnings have occurred during proc [%hardbreaks] {blank} - a¦ xref:ResponsesCommonWarnings[] array @@ -1650,7 +1625,6 @@ include::index.adoc[tag=desc-ResponsesCommonYardsticks, opts=optional] [%hardbreaks] {blank} - a¦ xref:ResponsesCommonYardsticks[] @@ -1707,7 +1681,6 @@ A number that identifies the error. [%hardbreaks] {blank} - a¦ Integer @@ -1724,7 +1697,6 @@ A message describing the error in detail. Refer to [Error Codes](/server/7.6/ana [%hardbreaks] {blank} - a¦ String @@ -1781,7 +1753,6 @@ A number that identifies the warning. [%hardbreaks] {blank} - a¦ Integer @@ -1797,7 +1768,6 @@ A message describing the warning in detail. [%hardbreaks] {blank} - a¦ String @@ -1860,7 +1830,6 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} - a¦ String @@ -1877,7 +1846,6 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} - a¦ String @@ -1893,7 +1861,6 @@ The total number of objects in the results. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1909,7 +1876,6 @@ The total number of bytes in the results. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1925,7 +1891,6 @@ The number of errors that occurred during the request. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1941,7 +1906,6 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1998,7 +1962,6 @@ include::index.adoc[tag=desc-ResponsesLocalPlans, opts=optional] [%hardbreaks] {blank} - a¦ xref:ResponsesLocalPlans[] @@ -2014,7 +1977,6 @@ include::index.adoc[tag=desc-ResponsesLocalYardsticks, opts=optional] [%hardbreaks] {blank} - a¦ xref:ResponsesLocalYardsticks[] @@ -2076,7 +2038,6 @@ The logical plan. [%hardbreaks] {blank} - a¦ Object @@ -2092,7 +2053,6 @@ The optimized logical plan. [%hardbreaks] {blank} - a¦ Object @@ -2108,7 +2068,6 @@ The rewritten expression tree. [%hardbreaks] {blank} - a¦ String @@ -2124,7 +2083,6 @@ The expression tree. [%hardbreaks] {blank} - a¦ String @@ -2140,7 +2098,6 @@ The job details. [%hardbreaks] {blank} - a¦ Object @@ -2202,7 +2159,6 @@ Number of processed tuples during query execution. [%hardbreaks] {blank} - a¦ Long (int64) diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc index 3356326a..a3baf6f4 100644 --- a/docs/modules/analytics-rest-settings/pages/index.adoc +++ b/docs/modules/analytics-rest-settings/pages/index.adoc @@ -585,7 +585,6 @@ Specifies the number of replicas for Analytics. *Maximum:* `3` *Example:* `3` {blank} - a¦ Integer diff --git a/docs/modules/eventing-rest-api/pages/index.adoc b/docs/modules/eventing-rest-api/pages/index.adoc index 2f8b7d35..530f8516 100644 --- a/docs/modules/eventing-rest-api/pages/index.adoc +++ b/docs/modules/eventing-rest-api/pages/index.adoc @@ -7100,7 +7100,6 @@ a¦ [%hardbreaks] {blank} - a¦ xref:depcfg_schema_buckets_inner[] array @@ -7115,7 +7114,6 @@ a¦ [%hardbreaks] {blank} - a¦ xref:depcfg_schema_curl_inner[] array @@ -7132,7 +7130,6 @@ bucket to store eventing checkpoints and timers [%hardbreaks] *Minimum length:* `1` {blank} - a¦ String @@ -7148,7 +7145,6 @@ scope to store eventing checkpoints and timers [%hardbreaks] {blank} - a¦ String @@ -7164,7 +7160,6 @@ collection to store eventing checkpoints and timers [%hardbreaks] {blank} - a¦ String @@ -7181,7 +7176,6 @@ bucket to listen to for document mutations [%hardbreaks] *Minimum length:* `1` {blank} - a¦ String @@ -7197,7 +7191,6 @@ scope to listen to for document mutations [%hardbreaks] {blank} - a¦ String @@ -7213,7 +7206,6 @@ collection to listen to for document mutations [%hardbreaks] {blank} - a¦ String @@ -7228,7 +7220,6 @@ a¦ [%hardbreaks] {blank} - a¦ xref:depcfg_schema_constants_inner[] array @@ -7288,7 +7279,6 @@ alias name of the constant binding *Minimum length:* `1` *Maximum length:* `64` {blank} - a¦ String @@ -7305,7 +7295,6 @@ literal value bound to the alias name [%hardbreaks] *Minimum length:* `1` {blank} - a¦ String @@ -7365,7 +7354,6 @@ symbolic name used in code to refer to this binding *Minimum length:* `1` *Maximum length:* `64` {blank} - a¦ String @@ -7382,7 +7370,6 @@ name of the bucket this binding maps to [%hardbreaks] *Minimum length:* `1` {blank} - a¦ String @@ -7398,7 +7385,6 @@ name of the scope this binding maps to [%hardbreaks] {blank} - a¦ String @@ -7414,7 +7400,6 @@ name of the collection this binding maps to [%hardbreaks] {blank} - a¦ String @@ -7431,7 +7416,6 @@ bucket access level (read or read+write) [%hardbreaks] *Values:* `"r"`, `"rw"` {blank} - a¦ String @@ -7490,7 +7474,6 @@ full URL (including any path) that this binding connects *Pattern:* `+++/^https?:\/\//+++` *Minimum length:* `1` {blank} - a¦ URI (uri) @@ -7509,7 +7492,6 @@ symbolic name used in code to refer to this binding *Minimum length:* `1` *Maximum length:* `64` {blank} - a¦ String @@ -7526,7 +7508,6 @@ http authentication method to use with this endpoint [%hardbreaks] *Values:* `"no-auth"`, `"basic"`, `"bearer"`, `"digest"` {blank} - a¦ String @@ -7542,7 +7523,6 @@ username for http auth methods that use it [%hardbreaks] {blank} - a¦ String @@ -7558,7 +7538,6 @@ password for http auth methods that use it [%hardbreaks] {blank} - a¦ String @@ -7574,7 +7553,6 @@ bearer key for bearer auth [%hardbreaks] {blank} - a¦ String @@ -7590,7 +7568,6 @@ allow cookies on the session [%hardbreaks] {blank} - a¦ Boolean @@ -7606,7 +7583,6 @@ validate remote server certificate using OS mechanisms [%hardbreaks] {blank} - a¦ Boolean @@ -7664,7 +7640,6 @@ handler code [%hardbreaks] *Minimum length:* `1` {blank} - a¦ String @@ -7680,7 +7655,6 @@ include::index.adoc[tag=desc-depcfg_schema, opts=optional] [%hardbreaks] {blank} - a¦ xref:depcfg_schema[] @@ -7697,7 +7671,6 @@ authoring tool. use 'external' if authored or edited outside eventing ui [%hardbreaks] *Pattern:* `+++/^evt-[5-7].[0-9]+.[0-9]+-[0-9]{4}-(ee|ce)$/+++` {blank} - a¦ String @@ -7713,7 +7686,6 @@ enforces stricter validation for all settings and configuration fields. [%hardbreaks] {blank} - a¦ Boolean @@ -7730,7 +7702,6 @@ unique id of the the handler. generated by server [%hardbreaks] *Minimum:* `0` {blank} - a¦ Integer @@ -7747,7 +7718,6 @@ unique id of the deployment of the handler. generated by server [%hardbreaks] *Minimum length:* `0` {blank} - a¦ String @@ -7765,7 +7735,6 @@ a¦ *Minimum length:* `1` *Maximum length:* `100` {blank} - a¦ String @@ -7781,7 +7750,6 @@ include::index.adoc[tag=desc-settings_schema, opts=optional] [%hardbreaks] {blank} - a¦ xref:settings_schema[] @@ -7797,7 +7765,6 @@ include::index.adoc[tag=desc-function_scope_schema, opts=optional] [%hardbreaks] {blank} - a¦ xref:function_scope_schema[] @@ -7860,7 +7827,6 @@ bucket to which function belongs [%hardbreaks] *Minimum length:* `1` {blank} - a¦ String @@ -7877,7 +7843,6 @@ scope to which function belongs [%hardbreaks] *Minimum length:* `1` {blank} - a¦ String @@ -7935,7 +7900,6 @@ number of threads each worker utilizes [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -7952,7 +7916,6 @@ indicates where to start dcp stream from (beginning of time, present point) 'fro [%hardbreaks] *Values:* `"everything"`, `"from_now"` {blank} - a¦ String @@ -7968,7 +7931,6 @@ indicates if the function is deployed. true=deployed, false=undeployed [%hardbreaks] {blank} - a¦ Boolean @@ -7984,7 +7946,6 @@ free form text for user to describe the handler. no functional role [%hardbreaks] {blank} - a¦ String @@ -8001,7 +7962,6 @@ maximum time the handler can run before it is forcefully terminated (in seconds) [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8018,7 +7978,6 @@ The maximum time the checkpoint writer can run before it is forcefully terminate [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8035,7 +7994,6 @@ maximum time the OnDeploy handler can run before it is terminated (in seconds) [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8052,7 +8010,6 @@ eventing language version this handler assumes in terms of syntax and behavior [%hardbreaks] *Values:* `"6.6.2"`, `"6.0.0"`, `"6.5.0"`, `"7.2.0"` {blank} - a¦ String @@ -8069,7 +8026,6 @@ maximum number of libcouchbase connections that may be opened and pooled [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8086,7 +8042,6 @@ number of retries of retriable libcouchbase failures. 0 keeps trying till execut [%hardbreaks] *Minimum:* `0` {blank} - a¦ Integer @@ -8103,7 +8058,6 @@ maximum time the lcb command is waited until completion before we terminate the [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8120,7 +8074,6 @@ level of detail in system logging [%hardbreaks] *Values:* `"INFO"`, `"ERROR"`, `"WARNING"`, `"DEBUG"`, `"TRACE"` {blank} - a¦ String @@ -8137,7 +8090,6 @@ consistency level used by n1ql statements in the handler [%hardbreaks] *Values:* `"none"`, `"request"` {blank} - a¦ String @@ -8154,7 +8106,6 @@ number of timer shards. defaults to number of vbuckets [%hardbreaks] *Values:* `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, `256`, `512`, `1024` {blank} - a¦ Integer @@ -8170,7 +8121,6 @@ indicates if the function is running (i.e., not paused). true=running, false=pau [%hardbreaks] {blank} - a¦ Boolean @@ -8187,7 +8137,6 @@ batch size for messages from producer to consumer. normally, this must not be sp [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8203,7 +8152,6 @@ duration to log stats from this handler, in milliseconds [%hardbreaks] {blank} - a¦ Integer @@ -8221,7 +8169,6 @@ size limit of timer context object *Minimum:* `20` *Maximum:* `20971520` {blank} - a¦ Integer @@ -8238,7 +8185,6 @@ key prefix for all data stored in metadata by this handler [%hardbreaks] *Minimum length:* `1` {blank} - a¦ String @@ -8255,7 +8201,6 @@ number of worker processes handler utilizes on each eventing node [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8271,7 +8216,6 @@ automatically prepare all n1ql statements in the handler [%hardbreaks] {blank} - a¦ Boolean @@ -8287,7 +8231,6 @@ code to automatically prepend to top of handler code [%hardbreaks] {blank} - a¦ String array @@ -8303,7 +8246,6 @@ code to automatically append to bottom of handler code [%hardbreaks] {blank} - a¦ String array @@ -8319,7 +8261,6 @@ enable rotating this handlers log() message files [%hardbreaks] {blank} - a¦ Boolean @@ -8335,7 +8276,6 @@ directory to write content of log() message files [%hardbreaks] {blank} - a¦ String @@ -8352,7 +8292,6 @@ rotate logs when file grows to this size in bytes approximately [%hardbreaks] *Minimum:* `1024` {blank} - a¦ Integer @@ -8369,7 +8308,6 @@ number of log() message files to retain when rotating [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8386,7 +8324,6 @@ number of seconds before writing a progress checkpoint [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8403,7 +8340,6 @@ maximum size in bytes the bucket cache can grow to [%hardbreaks] *Minimum:* `20971520` {blank} - a¦ Integer @@ -8420,7 +8356,6 @@ time in milliseconds after which a cached bucket object is considered stale [%hardbreaks] *Minimum:* `1` {blank} - a¦ Integer @@ -8436,7 +8371,6 @@ maximum allowable curl call response in 'MegaBytes'. Setting the value to 0 lift [%hardbreaks] {blank} - a¦ Integer @@ -8452,7 +8386,6 @@ allow staged transaction mutations [%hardbreaks] {blank} - a¦ Boolean @@ -8476,7 +8409,6 @@ You must ensure that none of the documents which contain your own working data h [%hardbreaks] {blank} - a¦ Boolean @@ -8496,7 +8428,6 @@ Note that enabling this setting may have a noticeable impact on the performance [%hardbreaks] {blank} - a¦ Boolean @@ -8512,7 +8443,6 @@ number of milliseconds before checking for high seq number [%hardbreaks] {blank} - a¦ Integer @@ -8528,7 +8458,6 @@ max MBs to wait to send more bytes to c++ side [%hardbreaks] {blank} - a¦ Integer @@ -8544,7 +8473,6 @@ max number of messages on c++ side [%hardbreaks] {blank} - a¦ Integer @@ -8560,7 +8488,6 @@ number of milliseconds before sending message to c++ side [%hardbreaks] {blank} - a¦ Integer @@ -8576,7 +8503,6 @@ number of parallel vb request per cpp thread [%hardbreaks] {blank} - a¦ Integer @@ -8635,7 +8561,6 @@ The memory allocation for the Eventing Service, per node. *Default:* `256` *Example:* `512` {blank} - a¦ Integer @@ -8653,7 +8578,6 @@ For details, see [Debugging and Diagnosability](/server/7.6/eventing/eventing-de [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -8676,7 +8600,6 @@ Decreasing this setting prevents further cursor-aware Eventing functions from be *Minimum:* `1` *Maximum:* `20` {blank} - a¦ Integer diff --git a/docs/modules/fts-rest-advanced/pages/index.adoc b/docs/modules/fts-rest-advanced/pages/index.adoc index df083982..8d0a64f8 100644 --- a/docs/modules/fts-rest-advanced/pages/index.adoc +++ b/docs/modules/fts-rest-advanced/pages/index.adoc @@ -1197,7 +1197,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -1213,7 +1212,6 @@ The document count for the specified index. [%hardbreaks] {blank} - a¦ Integer @@ -1270,7 +1268,6 @@ include::index.adoc[tag=desc-indexPartitionPIndex, opts=optional] [%hardbreaks] {blank} - a¦ xref:indexPartitionPIndex[] @@ -1286,7 +1283,6 @@ The status of the request. [%hardbreaks] {blank} - a¦ String @@ -1349,7 +1345,6 @@ include::index.adoc[tag=desc-indexPartitionPIndexInner, opts=optional] [%hardbreaks] {blank} - a¦ xref:indexPartitionPIndexInner[] @@ -1413,7 +1408,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -1430,7 +1424,6 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} - a¦ Object @@ -1447,7 +1440,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -1464,7 +1456,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -1480,7 +1471,6 @@ The name of the Search index partition. [%hardbreaks] {blank} - a¦ String @@ -1497,7 +1487,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -1514,7 +1503,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ Object @@ -1529,7 +1517,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -1546,7 +1533,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -1563,7 +1549,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -1579,7 +1564,6 @@ The UUID of the Search index partition. [%hardbreaks] {blank} - a¦ String @@ -1637,7 +1621,6 @@ For more information, see [Query Object](../search/search-request-params.html#qu [%hardbreaks] {blank} - a¦ Object @@ -1654,7 +1637,6 @@ For more information, see [Knn Objects](../search/search-request-params.html#knn [%hardbreaks] {blank} - a¦ Object array @@ -1671,7 +1653,6 @@ For more information, see [Ctl Object](../search/search-request-params.html#ctl) [%hardbreaks] {blank} - a¦ Object @@ -1687,7 +1668,6 @@ Set the total number of results to return for a single page of search results. [%hardbreaks] {blank} - a¦ Integer @@ -1703,7 +1683,6 @@ Set an offset value to change where pagination starts for search results. [%hardbreaks] {blank} - a¦ Integer @@ -1720,7 +1699,6 @@ For more information, see [Highlight Objects](../search/search-request-params.ht [%hardbreaks] {blank} - a¦ Object @@ -1736,7 +1714,6 @@ An array of strings to specify each indexed field you want to return in search r [%hardbreaks] {blank} - a¦ String array @@ -1753,7 +1730,6 @@ For more information, see [Facet Objects](../search/search-request-params.html#f [%hardbreaks] {blank} - a¦ Object @@ -1769,7 +1745,6 @@ Whether to create an explanation for a search result's score in search results. [%hardbreaks] {blank} - a¦ Boolean @@ -1786,7 +1761,6 @@ For more information, see [Sort Object](../search/search-request-params.html#sor [%hardbreaks] {blank} - a¦ Any Type array @@ -1802,7 +1776,6 @@ Whether to return the position of each occurrence of a search term inside a docu [%hardbreaks] {blank} - a¦ Boolean @@ -1818,7 +1791,6 @@ Whether to include document relevancy scoring in search results. [%hardbreaks] {blank} - a¦ String @@ -1834,7 +1806,6 @@ Use to control pagination in search results. [%hardbreaks] {blank} - a¦ String array @@ -1850,7 +1821,6 @@ Use to control pagination in search results. [%hardbreaks] {blank} - a¦ String array @@ -1866,7 +1836,6 @@ An array of strings that specify the collections where you want to run the query [%hardbreaks] {blank} - a¦ String array @@ -1923,7 +1892,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -1939,7 +1907,6 @@ The results of the Search query. [%hardbreaks] {blank} - a¦ Object array diff --git a/docs/modules/fts-rest-indexing/pages/index.adoc b/docs/modules/fts-rest-indexing/pages/index.adoc index e2e85e08..ebd68375 100644 --- a/docs/modules/fts-rest-indexing/pages/index.adoc +++ b/docs/modules/fts-rest-indexing/pages/index.adoc @@ -5187,7 +5187,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -5204,7 +5203,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -5261,7 +5259,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -5277,7 +5274,6 @@ An array of objects containing the analysis of the document. [%hardbreaks] {blank} - a¦ xref:DocumentAnalysisItem[] array @@ -5340,7 +5336,6 @@ include::index.adoc[tag=desc-DocumentAnalysisItemToken, opts=optional] [%hardbreaks] {blank} - a¦ xref:DocumentAnalysisItemToken[] @@ -5402,7 +5397,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -5418,7 +5412,6 @@ An array of objects describing the locations of the search term or token in the [%hardbreaks] {blank} - a¦ xref:DocumentAnalysisItemTokenLocation[] array @@ -5480,7 +5473,6 @@ The field in the document where the token was found. [%hardbreaks] {blank} - a¦ String @@ -5495,7 +5487,6 @@ a¦ [%hardbreaks] {blank} - a¦ Any Type array @@ -5511,7 +5502,6 @@ The starting point of the token in the field. [%hardbreaks] {blank} - a¦ Integer @@ -5527,7 +5517,6 @@ The ending point of the token in the field. [%hardbreaks] {blank} - a¦ Integer @@ -5543,7 +5532,6 @@ The position of the token in the field. [%hardbreaks] {blank} - a¦ Integer @@ -5600,7 +5588,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -5616,7 +5603,6 @@ The document count for the specified index. [%hardbreaks] {blank} - a¦ Integer @@ -5673,7 +5659,6 @@ include::index.adoc[tag=desc-IndexDefinition, opts=optional] [%hardbreaks] {blank} - a¦ xref:IndexDefinition[] @@ -5689,7 +5674,6 @@ An array of objects, each containing information about a single Search index par [%hardbreaks] {blank} - a¦ xref:GetIndexResponsePIndex[] array @@ -5705,7 +5689,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -5721,7 +5704,6 @@ An array of warnings. [%hardbreaks] {blank} - a¦ String array @@ -5784,7 +5766,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -5801,7 +5782,6 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} - a¦ Object @@ -5818,7 +5798,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -5835,7 +5814,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -5851,7 +5829,6 @@ The name of the Search index partition. [%hardbreaks] {blank} - a¦ String @@ -5867,7 +5844,6 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] [%hardbreaks] {blank} - a¦ xref:GetIndexResponsePIndexNodesWrapper[] @@ -5884,7 +5860,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -5901,7 +5876,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ Object @@ -5916,7 +5890,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -5933,7 +5906,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -5950,7 +5922,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -5966,7 +5937,6 @@ The UUID of the Search index partition. [%hardbreaks] {blank} - a¦ String @@ -6029,7 +5999,6 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapperNode, opts=option [%hardbreaks] {blank} - a¦ xref:GetIndexResponsePIndexNodesWrapperNode[] @@ -6091,7 +6060,6 @@ a¦ [%hardbreaks] {blank} - a¦ Boolean @@ -6106,7 +6074,6 @@ a¦ [%hardbreaks] {blank} - a¦ Boolean @@ -6121,7 +6088,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -6178,7 +6144,6 @@ include::index.adoc[tag=desc-GetIndexesResponseIndexes, opts=optional] [%hardbreaks] {blank} - a¦ xref:GetIndexesResponseIndexes[] @@ -6194,7 +6159,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -6255,7 +6219,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -6271,7 +6234,6 @@ include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] [%hardbreaks] {blank} - a¦ xref:GetIndexesResponseIndexesWrapper[] @@ -6286,7 +6248,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -6349,7 +6310,6 @@ include::index.adoc[tag=desc-IndexDefinition, opts=optional] [%hardbreaks] {blank} - a¦ xref:IndexDefinition[] @@ -6413,7 +6373,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -6430,7 +6389,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -6447,7 +6405,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -6464,7 +6421,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -6481,7 +6437,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ Object @@ -6498,7 +6453,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -6515,7 +6469,6 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} - a¦ Object @@ -6531,7 +6484,6 @@ include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] [%hardbreaks] {blank} - a¦ xref:IndexDefinitionPlanParams[] @@ -6548,7 +6500,6 @@ Intended for clients that want to check that they are not overwriting the Search [%hardbreaks] {blank} - a¦ String @@ -6565,7 +6516,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -6627,7 +6577,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -6644,7 +6593,6 @@ Use `indexPartitions` instead. [%hardbreaks] {blank} - a¦ Integer @@ -6660,7 +6608,6 @@ The number of partitions to split the Search index into, across the nodes you ha [%hardbreaks] {blank} - a¦ Integer @@ -6675,7 +6622,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -6691,7 +6637,6 @@ The number of replicas the Search Service creates for the Search index to ensure [%hardbreaks] {blank} - a¦ Integer @@ -6706,7 +6651,6 @@ a¦ [%hardbreaks] {blank} - a¦ Boolean @@ -6763,7 +6707,6 @@ The document ID to look up in the Search index. [%hardbreaks] {blank} - a¦ String @@ -6820,7 +6763,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -6836,7 +6778,6 @@ include::index.adoc[tag=desc-LookupResponsePartitions, opts=optional] [%hardbreaks] {blank} - a¦ xref:LookupResponsePartitions[] @@ -6899,7 +6840,6 @@ include::index.adoc[tag=desc-LookupResponsePartitionsID, opts=optional] [%hardbreaks] {blank} - a¦ xref:LookupResponsePartitionsID[] @@ -6962,7 +6902,6 @@ The Search index partition ID. [%hardbreaks] {blank} - a¦ String @@ -7019,7 +6958,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -7076,7 +7014,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -7093,7 +7030,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -7110,7 +7046,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -7168,7 +7103,6 @@ For more information, see [Query Object](../search/search-request-params.html#qu [%hardbreaks] {blank} - a¦ Object @@ -7185,7 +7119,6 @@ For more information, see [Knn Objects](../search/search-request-params.html#knn [%hardbreaks] {blank} - a¦ Object array @@ -7202,7 +7135,6 @@ For more information, see [Ctl Object](../search/search-request-params.html#ctl) [%hardbreaks] {blank} - a¦ Object @@ -7218,7 +7150,6 @@ Set the total number of results to return for a single page of search results. [%hardbreaks] {blank} - a¦ Integer @@ -7234,7 +7165,6 @@ Set an offset value to change where pagination starts for search results. [%hardbreaks] {blank} - a¦ Integer @@ -7251,7 +7181,6 @@ For more information, see [Highlight Objects](../search/search-request-params.ht [%hardbreaks] {blank} - a¦ Object @@ -7267,7 +7196,6 @@ An array of strings to specify each indexed field you want to return in search r [%hardbreaks] {blank} - a¦ String array @@ -7284,7 +7212,6 @@ For more information, see [Facet Objects](../search/search-request-params.html#f [%hardbreaks] {blank} - a¦ Object @@ -7300,7 +7227,6 @@ Whether to create an explanation for a search result's score in search results. [%hardbreaks] {blank} - a¦ Boolean @@ -7317,7 +7243,6 @@ For more information, see [Sort Object](../search/search-request-params.html#sor [%hardbreaks] {blank} - a¦ Any Type array @@ -7333,7 +7258,6 @@ Whether to return the position of each occurrence of a search term inside a docu [%hardbreaks] {blank} - a¦ Boolean @@ -7349,7 +7273,6 @@ Whether to include document relevancy scoring in search results. [%hardbreaks] {blank} - a¦ String @@ -7365,7 +7288,6 @@ Use to control pagination in search results. [%hardbreaks] {blank} - a¦ String array @@ -7381,7 +7303,6 @@ Use to control pagination in search results. [%hardbreaks] {blank} - a¦ String array @@ -7397,7 +7318,6 @@ An array of strings that specify the collections where you want to run the query [%hardbreaks] {blank} - a¦ String array @@ -7454,7 +7374,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -7470,7 +7389,6 @@ The results of the Search query. [%hardbreaks] {blank} - a¦ Object array @@ -7526,7 +7444,6 @@ a¦ [%hardbreaks] {blank} - a¦ Object @@ -7541,7 +7458,6 @@ a¦ [%hardbreaks] {blank} - a¦ Object @@ -7597,7 +7513,6 @@ a¦ [%hardbreaks] {blank} - a¦ Object @@ -7613,7 +7528,6 @@ include::index.adoc[tag=desc-StatsNodeResponseMgr, opts=optional] [%hardbreaks] {blank} - a¦ xref:StatsNodeResponseMgr[] @@ -7628,7 +7542,6 @@ a¦ [%hardbreaks] {blank} - a¦ Object @@ -7684,7 +7597,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7699,7 +7611,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7714,7 +7625,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7729,7 +7639,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7744,7 +7653,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7759,7 +7667,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7774,7 +7681,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7789,7 +7695,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7804,7 +7709,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7819,7 +7723,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7834,7 +7737,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7849,7 +7751,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7864,7 +7765,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7879,7 +7779,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7894,7 +7793,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7909,7 +7807,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7924,7 +7821,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7939,7 +7835,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7954,7 +7849,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7969,7 +7863,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7984,7 +7877,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -7999,7 +7891,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -8014,7 +7905,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -8029,7 +7919,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -8044,7 +7933,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -8101,7 +7989,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -8117,7 +8004,6 @@ The status of the Search index. [%hardbreaks] {blank} - a¦ String diff --git a/docs/modules/fts-rest-manage/pages/index.adoc b/docs/modules/fts-rest-manage/pages/index.adoc index 57cc72ce..a240073e 100644 --- a/docs/modules/fts-rest-manage/pages/index.adoc +++ b/docs/modules/fts-rest-manage/pages/index.adoc @@ -433,7 +433,6 @@ If the value is `true`, partitions are created by means of partition build, from [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -491,7 +490,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -508,7 +506,6 @@ The error message, if the operation was not successful. [%hardbreaks] {blank} - a¦ String diff --git a/docs/modules/fts-rest-nodes/pages/index.adoc b/docs/modules/fts-rest-nodes/pages/index.adoc index 46dad428..69705b61 100644 --- a/docs/modules/fts-rest-nodes/pages/index.adoc +++ b/docs/modules/fts-rest-nodes/pages/index.adoc @@ -2219,7 +2219,6 @@ include::index.adoc[tag=desc-clusterConfigIndexes, opts=optional] [%hardbreaks] {blank} - a¦ xref:clusterConfigIndexes[] @@ -2235,7 +2234,6 @@ Search index definition concurrency (compare and swap) value. [%hardbreaks] {blank} - a¦ Integer @@ -2251,7 +2249,6 @@ Search index definition error. [%hardbreaks] {blank} - a¦ String @@ -2267,7 +2264,6 @@ include::index.adoc[tag=desc-clusterConfigNodesKnown, opts=optional] [%hardbreaks] {blank} - a¦ xref:clusterConfigNodesKnown[] @@ -2283,7 +2279,6 @@ Known node definition concurrency (compare and swap) value. [%hardbreaks] {blank} - a¦ Integer @@ -2299,7 +2294,6 @@ Known node definition error. [%hardbreaks] {blank} - a¦ String @@ -2315,7 +2309,6 @@ include::index.adoc[tag=desc-clusterConfigNodesWanted, opts=optional] [%hardbreaks] {blank} - a¦ xref:clusterConfigNodesWanted[] @@ -2331,7 +2324,6 @@ Wanted node definition concurrency (compare and swap) value. [%hardbreaks] {blank} - a¦ Integer @@ -2347,7 +2339,6 @@ Wanted node definition error. [%hardbreaks] {blank} - a¦ String @@ -2363,7 +2354,6 @@ include::index.adoc[tag=desc-clusterConfigPlan, opts=optional] [%hardbreaks] {blank} - a¦ xref:clusterConfigPlan[] @@ -2379,7 +2369,6 @@ Search index partition concurrency (compare and swap) value. [%hardbreaks] {blank} - a¦ Integer @@ -2395,7 +2384,6 @@ Search index partition error. [%hardbreaks] {blank} - a¦ String @@ -2411,7 +2399,6 @@ The status of the operation. [%hardbreaks] {blank} - a¦ String @@ -2472,7 +2459,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2488,7 +2474,6 @@ include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] [%hardbreaks] {blank} - a¦ xref:GetIndexesResponseIndexesWrapper[] @@ -2549,7 +2534,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2565,7 +2549,6 @@ include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] [%hardbreaks] {blank} - a¦ xref:clusterConfigNodesWrapper[] @@ -2580,7 +2563,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2641,7 +2623,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2657,7 +2638,6 @@ include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] [%hardbreaks] {blank} - a¦ xref:clusterConfigNodesWrapper[] @@ -2672,7 +2652,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2735,7 +2714,6 @@ include::index.adoc[tag=desc-clusterConfigNodesWrapperNode, opts=optional] [%hardbreaks] {blank} - a¦ xref:clusterConfigNodesWrapperNode[] @@ -2797,7 +2775,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2812,7 +2789,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2827,7 +2803,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2842,7 +2817,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2857,7 +2831,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2872,7 +2845,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2887,7 +2859,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -2948,7 +2919,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2964,7 +2934,6 @@ include::index.adoc[tag=desc-clusterConfigPlanWrapper, opts=optional] [%hardbreaks] {blank} - a¦ xref:clusterConfigPlanWrapper[] @@ -2979,7 +2948,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -2995,7 +2963,6 @@ include::index.adoc[tag=desc-GetIndexResponsePlanWrng, opts=optional] [%hardbreaks] {blank} - a¦ xref:GetIndexResponsePlanWrng[] @@ -3058,7 +3025,6 @@ include::index.adoc[tag=desc-GetIndexResponsePIndex, opts=optional] [%hardbreaks] {blank} - a¦ xref:GetIndexResponsePIndex[] @@ -3121,7 +3087,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3138,7 +3103,6 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} - a¦ Object @@ -3155,7 +3119,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3172,7 +3135,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3188,7 +3150,6 @@ The name of the Search index partition. [%hardbreaks] {blank} - a¦ String @@ -3204,7 +3165,6 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] [%hardbreaks] {blank} - a¦ xref:GetIndexResponsePIndexNodesWrapper[] @@ -3221,7 +3181,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3238,7 +3197,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ Object @@ -3253,7 +3211,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -3270,7 +3227,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3287,7 +3243,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3303,7 +3258,6 @@ The UUID of the Search index partition. [%hardbreaks] {blank} - a¦ String @@ -3366,7 +3320,6 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapperNode, opts=option [%hardbreaks] {blank} - a¦ xref:GetIndexResponsePIndexNodesWrapperNode[] @@ -3428,7 +3381,6 @@ a¦ [%hardbreaks] {blank} - a¦ Boolean @@ -3443,7 +3395,6 @@ a¦ [%hardbreaks] {blank} - a¦ Boolean @@ -3458,7 +3409,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -3521,7 +3471,6 @@ include::index.adoc[tag=desc-GetIndexResponsePlanWrngIndex, opts=optional] [%hardbreaks] {blank} - a¦ xref:GetIndexResponsePlanWrngIndex[] @@ -3570,7 +3519,6 @@ The name of the property is the name of the Search index. [%hardbreaks] {blank} - .Schema String @@ -3629,7 +3577,6 @@ include::index.adoc[tag=desc-IndexDefinition, opts=optional] [%hardbreaks] {blank} - a¦ xref:IndexDefinition[] @@ -3693,7 +3640,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3710,7 +3656,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3727,7 +3672,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3744,7 +3688,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3761,7 +3704,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ Object @@ -3778,7 +3720,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3795,7 +3736,6 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} - a¦ Object @@ -3811,7 +3751,6 @@ include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] [%hardbreaks] {blank} - a¦ xref:IndexDefinitionPlanParams[] @@ -3828,7 +3767,6 @@ Intended for clients that want to check that they are not overwriting the Search [%hardbreaks] {blank} - a¦ String @@ -3845,7 +3783,6 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} - a¦ String @@ -3907,7 +3844,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -3924,7 +3860,6 @@ Use `indexPartitions` instead. [%hardbreaks] {blank} - a¦ Integer @@ -3940,7 +3875,6 @@ The number of partitions to split the Search index into, across the nodes you ha [%hardbreaks] {blank} - a¦ Integer @@ -3955,7 +3889,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -3971,7 +3904,6 @@ The number of replicas the Search Service creates for the Search index to ensure [%hardbreaks] {blank} - a¦ Integer @@ -3986,7 +3918,6 @@ a¦ [%hardbreaks] {blank} - a¦ Boolean @@ -4042,7 +3973,6 @@ a¦ [%hardbreaks] {blank} - a¦ Object array @@ -4057,7 +3987,6 @@ a¦ [%hardbreaks] {blank} - a¦ Object array @@ -4114,7 +4043,6 @@ The architecture of the node. [%hardbreaks] {blank} - a¦ String @@ -4130,7 +4058,6 @@ include::index.adoc[tag=desc-runtimeInfoGo, opts=optional] [%hardbreaks] {blank} - a¦ xref:runtimeInfoGo[] @@ -4146,7 +4073,6 @@ The number of CPUs on the node. [%hardbreaks] {blank} - a¦ Integer @@ -4162,7 +4088,6 @@ The operating system of the node. [%hardbreaks] {blank} - a¦ String @@ -4177,7 +4102,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -4192,7 +4116,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -4248,7 +4171,6 @@ a¦ [%hardbreaks] {blank} - a¦ Integer @@ -4263,7 +4185,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -4278,7 +4199,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -4293,7 +4213,6 @@ a¦ [%hardbreaks] {blank} - a¦ String diff --git a/docs/modules/fts-rest-query/pages/index.adoc b/docs/modules/fts-rest-query/pages/index.adoc index e82a7ab4..d01f7a1d 100644 --- a/docs/modules/fts-rest-query/pages/index.adoc +++ b/docs/modules/fts-rest-query/pages/index.adoc @@ -855,7 +855,6 @@ The status of the request. [%hardbreaks] {blank} - a¦ String @@ -871,7 +870,6 @@ include::index.adoc[tag=desc-ActiveResponseStats, opts=optional] [%hardbreaks] {blank} - a¦ xref:ActiveResponseStats[] @@ -887,7 +885,6 @@ The total number of active queries. [%hardbreaks] {blank} - a¦ Integer @@ -903,7 +900,6 @@ include::index.adoc[tag=desc-ActiveResponseFilter, opts=optional] [%hardbreaks] {blank} - a¦ xref:ActiveResponseFilter[] @@ -966,7 +962,6 @@ Only included if viewing active queries for a specific index. [%hardbreaks] {blank} - a¦ String @@ -983,7 +978,6 @@ Only included if the `longerThan` query parameter is used. [%hardbreaks] {blank} - a¦ String (duration) @@ -999,7 +993,6 @@ The number of filtered active queries. [%hardbreaks] {blank} - a¦ Integer @@ -1015,7 +1008,6 @@ include::index.adoc[tag=desc-ActiveResponseFilterMap, opts=optional] [%hardbreaks] {blank} - a¦ xref:ActiveResponseFilterMap[] @@ -1078,7 +1070,6 @@ include::index.adoc[tag=desc-ActiveResponseFilterMapItem, opts=optional] [%hardbreaks] {blank} - a¦ xref:ActiveResponseFilterMapItem[] @@ -1141,7 +1132,6 @@ include::index.adoc[tag=desc-ActiveResponseFilterMapItemContext, opts=optional] [%hardbreaks] {blank} - a¦ xref:ActiveResponseFilterMapItemContext[] @@ -1157,7 +1147,6 @@ The time taken to execute the query. [%hardbreaks] {blank} - a¦ String (duration) @@ -1220,7 +1209,6 @@ For more information, see [Search Request JSON Properties](../search/search-requ [%hardbreaks] {blank} - a¦ Object @@ -1236,7 +1224,6 @@ a¦ [%hardbreaks] *Example:* `10` {blank} - a¦ Integer @@ -1252,7 +1239,6 @@ a¦ [%hardbreaks] *Example:* `0` {blank} - a¦ Integer @@ -1268,7 +1254,6 @@ a¦ [%hardbreaks] *Example:* `120000` {blank} - a¦ Integer @@ -1284,7 +1269,6 @@ The name of a Search index. [%hardbreaks] {blank} - a¦ String @@ -1346,7 +1330,6 @@ a¦ [%hardbreaks] *Example:* `3` {blank} - a¦ Integer @@ -1362,7 +1345,6 @@ a¦ [%hardbreaks] *Example:* `3` {blank} - a¦ Integer @@ -1420,7 +1402,6 @@ This parameter allows the user to cancel a query anywhere in the system by speci [%hardbreaks] {blank} - a¦ String @@ -1477,7 +1458,6 @@ The status of the request. [%hardbreaks] {blank} - a¦ String @@ -1493,7 +1473,6 @@ The response message, giving details of the node UUID and query ID. [%hardbreaks] {blank} - a¦ String diff --git a/docs/modules/fts-rest-stats/pages/index.adoc b/docs/modules/fts-rest-stats/pages/index.adoc index 6e0af4c7..ca7d6e27 100644 --- a/docs/modules/fts-rest-stats/pages/index.adoc +++ b/docs/modules/fts-rest-stats/pages/index.adoc @@ -624,7 +624,6 @@ The average latency of all Search queries run on the cluster, in milliseconds. [%hardbreaks] {blank} - a¦ Big Decimal @@ -642,7 +641,6 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} - a¦ Integer @@ -662,7 +660,6 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} - a¦ Integer @@ -682,7 +679,6 @@ This statistic appears on the Server Web Console dashboard as **DCP Batches Bloc [%hardbreaks] {blank} - a¦ Integer @@ -700,7 +696,6 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} - a¦ Integer @@ -718,7 +713,6 @@ This statistic appears on the Server Web Console dashboard as **RAM Quota for Se [%hardbreaks] {blank} - a¦ Integer @@ -734,7 +728,6 @@ The total number of bytes used on disk by Search indexes in the cluster. [%hardbreaks] {blank} - a¦ Integer @@ -752,7 +745,6 @@ This statistic appears on the Server Web Console dashboard as **RAM Used by Sear [%hardbreaks] {blank} - a¦ Integer @@ -770,7 +762,6 @@ This amount is included as part of the total number of bytes used in memory, giv [%hardbreaks] {blank} - a¦ Integer @@ -786,7 +777,6 @@ The total number of files on disk for all Search indexes. [%hardbreaks] {blank} - a¦ Integer @@ -804,7 +794,6 @@ The number of Go SDK DCP agents should be less than or equal to the number of Se [%hardbreaks] {blank} - a¦ Integer @@ -822,7 +811,6 @@ Typically, the Search Service uses one agent pair for each bucket on a node. [%hardbreaks] {blank} - a¦ Integer @@ -838,7 +826,6 @@ The total number of [Vector Search](https://docs.couchbase.com/server/7.6/vector [%hardbreaks] {blank} - a¦ Integer @@ -855,7 +842,6 @@ Garbage collection involves cleanup actions like removing unnecessary index entr [%hardbreaks] {blank} - a¦ Big Decimal @@ -873,7 +859,6 @@ This statistic appears on the Server Web Console dashboard as **Pct RAM Used by [%hardbreaks] {blank} - a¦ Big Decimal @@ -892,7 +877,6 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} - a¦ Integer @@ -908,7 +892,6 @@ The total number of batches executed at regular intervals. [%hardbreaks] {blank} - a¦ Integer @@ -927,7 +910,6 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} - a¦ Integer @@ -945,7 +927,6 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} - a¦ Integer @@ -961,7 +942,6 @@ The total number of times a Search index partition closed to new Search requests [%hardbreaks] {blank} - a¦ Integer @@ -979,7 +959,6 @@ Opening a Search index partition creates a file lock for concurrent access reque [%hardbreaks] {blank} - a¦ Integer @@ -999,7 +978,6 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} - a¦ Integer @@ -1019,7 +997,6 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} - a¦ Integer @@ -1039,7 +1016,6 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} - a¦ Integer @@ -1059,7 +1035,6 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} - a¦ Integer @@ -1079,7 +1054,6 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} - a¦ Integer @@ -1097,7 +1071,6 @@ HTTP limit listeners manage limits on incoming HTTP requests to the Search Servi [%hardbreaks] {blank} - a¦ Integer @@ -1115,7 +1088,6 @@ HTTP limit listeners manage limits on incoming HTTP requests to the Search Servi [%hardbreaks] {blank} - a¦ Integer @@ -1133,7 +1105,6 @@ HTTPS limit listeners manage limits on incoming HTTPS requests to the Search Ser [%hardbreaks] {blank} - a¦ Integer @@ -1151,7 +1122,6 @@ HTTPS limit listeners manage limits on incoming HTTPS requests to the Search Ser [%hardbreaks] {blank} - a¦ Integer @@ -1169,7 +1139,6 @@ For more information about how to set the Search Service's quota, see [ftsMemory [%hardbreaks] {blank} - a¦ Integer @@ -1187,7 +1156,6 @@ A request is remote if it comes from a different node in the cluster. [%hardbreaks] {blank} - a¦ Integer @@ -1205,7 +1173,6 @@ A request is remote if it comes from a different node in the cluster. [%hardbreaks] {blank} - a¦ Integer @@ -1221,7 +1188,6 @@ This metric is deprecated. [%hardbreaks] {blank} - a¦ Integer @@ -1242,7 +1208,6 @@ Use gRPC requests, instead. [%hardbreaks] {blank} - a¦ Integer @@ -1263,7 +1228,6 @@ Use gRPC requests, instead. [%hardbreaks] {blank} - a¦ Integer @@ -1284,7 +1248,6 @@ Use gRPC requests, instead. [%hardbreaks] {blank} - a¦ Integer @@ -1305,7 +1268,6 @@ If the Search Service's index snapshots are too far ahead of the Data Service's [%hardbreaks] {blank} - a¦ Integer @@ -1326,7 +1288,6 @@ If the Search Service's index snapshots are too far ahead of the Data Service's [%hardbreaks] {blank} - a¦ Integer @@ -1343,7 +1304,6 @@ This includes the size of all JSON sent. [%hardbreaks] {blank} - a¦ Integer @@ -1359,7 +1319,6 @@ The total number of bad request errors returned for requests to create new Searc [%hardbreaks] {blank} - a¦ Integer @@ -1375,7 +1334,6 @@ The total number of internal server errors returned for requests to create new S [%hardbreaks] {blank} - a¦ Integer @@ -1391,7 +1349,6 @@ The total number of requests received by the Search Service for creating new Sea [%hardbreaks] {blank} - a¦ Integer @@ -1407,7 +1364,6 @@ The total number of requests received by the Search Service for creating new Sea [%hardbreaks] {blank} - a¦ Integer @@ -1423,7 +1379,6 @@ The total number of bad request errors returned for requests to delete Search in [%hardbreaks] {blank} - a¦ Integer @@ -1439,7 +1394,6 @@ The total number of internal server errors returned for requests to delete Searc [%hardbreaks] {blank} - a¦ Integer @@ -1455,7 +1409,6 @@ The total number of requests received by the Search Service to delete Search ind [%hardbreaks] {blank} - a¦ Integer @@ -1471,7 +1424,6 @@ The total number of requests received by the Search Service to delete Search ind [%hardbreaks] {blank} - a¦ Integer @@ -1489,7 +1441,6 @@ Garbage collection events include removing unnecessary index entries. [%hardbreaks] {blank} - a¦ Integer @@ -1509,7 +1460,6 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} - a¦ Integer @@ -1525,7 +1475,6 @@ The total number of Search queries per second across all Search indexes in the c [%hardbreaks] {blank} - a¦ Integer @@ -1541,7 +1490,6 @@ The total number of bad request errors returned for Search queries on the cluste [%hardbreaks] {blank} - a¦ Integer @@ -1559,7 +1507,6 @@ For more information about consistency in Search queries, see [Search Request JS [%hardbreaks] {blank} - a¦ Integer @@ -1575,7 +1522,6 @@ The total number of Search queries that encountered an error on the cluster. [%hardbreaks] {blank} - a¦ Integer @@ -1591,7 +1537,6 @@ The total number of Search queries that exceeded the [bleveMaxResultWindow](http [%hardbreaks] {blank} - a¦ Integer @@ -1609,7 +1554,6 @@ A Search query can return partial results if it times out before all partitions [%hardbreaks] {blank} - a¦ Integer @@ -1629,7 +1573,6 @@ This statistic appears on the Server Web Console dashboard as **Rejected Queries [%hardbreaks] {blank} - a¦ Integer @@ -1647,7 +1590,6 @@ These errors are typically internal server errors. [%hardbreaks] {blank} - a¦ Integer @@ -1663,7 +1605,6 @@ The total number of Search queries that were added to the slow query log. [%hardbreaks] {blank} - a¦ Integer @@ -1681,7 +1622,6 @@ You can set the timeout for a query with the [ctl object](https://docs.couchbase [%hardbreaks] {blank} - a¦ Integer @@ -1699,7 +1639,6 @@ For more information, see the [validate property](https://docs.couchbase.com/ser [%hardbreaks] {blank} - a¦ Integer @@ -1715,7 +1654,6 @@ The total time, in nanoseconds, spent processing Search queries across the clust [%hardbreaks] {blank} - a¦ Integer @@ -1780,7 +1718,6 @@ The coordinator is the Search node that receives the Search request and scatters [%hardbreaks] {blank} - a¦ Integer @@ -1798,7 +1735,6 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} - a¦ Integer @@ -1814,7 +1750,6 @@ The average latency, in milliseconds, for inter-node queries for the given Searc [%hardbreaks] {blank} - a¦ Integer @@ -1832,7 +1767,6 @@ This statistic appears on the Server Web Console dashboard as **Search Query Lat [%hardbreaks] {blank} - a¦ Integer @@ -1850,7 +1784,6 @@ This statistic appears on the Server Web Console dashboard as **Search Docs**. [%hardbreaks] {blank} - a¦ Integer @@ -1866,7 +1799,6 @@ The last date and time that a query ran against the given Search index. [%hardbreaks] {blank} - a¦ Date (date-time) @@ -1882,7 +1814,6 @@ The total number of bytes read by all queries against the given Search index. [%hardbreaks] {blank} - a¦ Integer @@ -1900,7 +1831,6 @@ This statistic appears on the Server Web Console dashboard as **Search Disk Size [%hardbreaks] {blank} - a¦ Integer @@ -1922,7 +1852,6 @@ The `num_bytes_used_disk_by_root` value will be less than the `num_bytes_used_di [%hardbreaks] {blank} - a¦ Integer @@ -1942,7 +1871,6 @@ Stale segments are deleted when they're not used by any new queries. [%hardbreaks] {blank} - a¦ Integer @@ -1958,7 +1886,6 @@ The total cumulative number of bytes written to disk as part of introducing segm [%hardbreaks] {blank} - a¦ Integer @@ -1980,7 +1907,6 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} - a¦ Integer @@ -1998,7 +1924,6 @@ This statistic appears on the Server Web Console dashboard as **Search Disk File [%hardbreaks] {blank} - a¦ Integer @@ -2020,7 +1945,6 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} - a¦ Integer @@ -2038,7 +1962,6 @@ This statistic appears on the Server Web Console dashboard as **Search Mutations [%hardbreaks] {blank} - a¦ Integer @@ -2060,7 +1983,6 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} - a¦ Integer @@ -2082,7 +2004,6 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} - a¦ Integer @@ -2100,7 +2021,6 @@ This statistic appears on the Server Web Console dashboard as **Search Partition [%hardbreaks] {blank} - a¦ Integer @@ -2118,7 +2038,6 @@ This statistic appears on the Server Web Console dashboard as **Search Partition [%hardbreaks] {blank} - a¦ Integer @@ -2136,7 +2055,6 @@ This statistic appears on the Server Web Console dashboard as **Search Records t [%hardbreaks] {blank} - a¦ Integer @@ -2156,7 +2074,6 @@ This statistic appears on the Server Web Console dashboard as **Search Disk Segm [%hardbreaks] {blank} - a¦ Integer @@ -2176,7 +2093,6 @@ This statistic appears on the Server Web Console dashboard as **Search Memory Se [%hardbreaks] {blank} - a¦ Integer @@ -2195,7 +2111,6 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} - a¦ Integer @@ -2211,7 +2126,6 @@ The total number of delete operations received from DCP for the given Search ind [%hardbreaks] {blank} - a¦ Integer @@ -2227,7 +2141,6 @@ The total number of create or update operations received from DCP for the given [%hardbreaks] {blank} - a¦ Integer @@ -2245,7 +2158,6 @@ If the DCP connection closes, the Search Service can use this stored metadata to [%hardbreaks] {blank} - a¦ Integer @@ -2261,7 +2173,6 @@ The total number of times the DCP consumer updated stored metadata, based on cha [%hardbreaks] {blank} - a¦ Integer @@ -2277,7 +2188,6 @@ The total number of DCP Rollback messages received for the given Search index. [%hardbreaks] {blank} - a¦ Integer @@ -2295,7 +2205,6 @@ Snapshots contain a representation of document mutations on either a write queue [%hardbreaks] {blank} - a¦ Integer @@ -2311,7 +2220,6 @@ This metric is no longer used and will soon be deprecated. [%hardbreaks] {blank} - a¦ Integer @@ -2329,7 +2237,6 @@ This statistic appears on the Server Web Console dashboard as **Search Index Rat [%hardbreaks] {blank} - a¦ Integer @@ -2348,7 +2255,6 @@ This statistic appears on the Server Web Console dashboard as **Search Result Ra [%hardbreaks] {blank} - a¦ Integer @@ -2366,7 +2272,6 @@ This statistic appears on the Server Web Console dashboard as **Search Compactio [%hardbreaks] {blank} - a¦ Integer @@ -2386,7 +2291,6 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} - a¦ Integer @@ -2402,7 +2306,6 @@ The total number of queries, using gRPC for streaming, for the given Search inde [%hardbreaks] {blank} - a¦ Integer @@ -2418,7 +2321,6 @@ The total number of queries that resulted in an error that used gRPC for streami [%hardbreaks] {blank} - a¦ Integer @@ -2434,7 +2336,6 @@ The total number of queries added to the slow query log that used gRPC for strea [%hardbreaks] {blank} - a¦ Integer @@ -2450,7 +2351,6 @@ The total number of queries that timed out that used gRPC for streaming on the g [%hardbreaks] {blank} - a¦ Integer @@ -2470,7 +2370,6 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} - a¦ Integer @@ -2490,7 +2389,6 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} - a¦ Integer @@ -2506,7 +2404,6 @@ The total number of [Vector Search](https://docs.couchbase.com/server/7.6/vector [%hardbreaks] {blank} - a¦ Integer @@ -2522,7 +2419,6 @@ The total number of Search queries per second on the given Search index. [%hardbreaks] {blank} - a¦ Integer @@ -2540,7 +2436,6 @@ This statistic appears on the Server Web Console dashboard as **Search Query Err [%hardbreaks] {blank} - a¦ Integer @@ -2560,7 +2455,6 @@ This statistic appears on the Server Web Console dashboard as **Search Slow Quer [%hardbreaks] {blank} - a¦ Integer @@ -2578,7 +2472,6 @@ This statistic appears on the Server Web Console dashboard as **Search Query Tim [%hardbreaks] {blank} - a¦ Integer @@ -2594,7 +2487,6 @@ The total time, in nanoseconds, spent processing Search query requests for the g [%hardbreaks] {blank} - a¦ Integer @@ -2617,7 +2509,6 @@ This statistic appears on the Server Web Console dashboard as **Term Searchers S [%hardbreaks] {blank} - a¦ Integer @@ -2633,7 +2524,6 @@ The total number of term searchers on the given Search index that have finished [%hardbreaks] {blank} - a¦ Integer @@ -2651,7 +2541,6 @@ If there are no vectors inside the Search index, the REST API does not return th [%hardbreaks] {blank} - a¦ Integer diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc index cca24d14..7e65e00f 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -1057,7 +1057,6 @@ include::index.adoc[tag=desc-NodeIdxNodeIndexer, opts=optional] [%hardbreaks] {blank} - a¦ xref:NodeIdxNodeIndexer[] @@ -1121,7 +1120,6 @@ Current state of the Index service on this node. *Values:* `"Active"`, `"Pause"`, `"Warmup"` *Example:* `+++"Active"+++` {blank} - a¦ String @@ -1140,7 +1138,6 @@ Memory quota assigned to the Index service on this node by user configuration (b *Maximum:* `1099511992567` *Example:* `536870912` {blank} - a¦ Long (int64) @@ -1159,7 +1156,6 @@ This also accounts for memory fragmentation. [%hardbreaks] *Example:* `71794688` {blank} - a¦ Integer @@ -1176,7 +1172,6 @@ Amount of memory used by the Index service on this node (bytes). [%hardbreaks] *Example:* `360192000` {blank} - a¦ Integer @@ -1193,7 +1188,6 @@ The total time the indexer has spent in GC pause since last startup (ns). [%hardbreaks] *Example:* `309778455` {blank} - a¦ Integer @@ -1288,7 +1282,6 @@ include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] [%hardbreaks] {blank} - a¦ xref:PartIdxPartitionsIndex[] @@ -1346,7 +1339,6 @@ include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] [%hardbreaks] {blank} - a¦ xref:PartIdxPartitionsIndex[] @@ -1410,7 +1402,6 @@ The average number of items indexed per document. [%hardbreaks] {blank} - a¦ Integer @@ -1426,7 +1417,6 @@ Average number of items flushed from memory to disk storage per second. [%hardbreaks] {blank} - a¦ Integer @@ -1442,7 +1432,6 @@ Average size of the keys. [%hardbreaks] {blank} - a¦ Integer @@ -1458,7 +1447,6 @@ Average time to serve a scan request (nanoseconds). [%hardbreaks] {blank} - a¦ Integer @@ -1474,7 +1462,6 @@ Percentage of memory accesses that were served from the managed cache. [%hardbreaks] {blank} - a¦ Integer @@ -1490,7 +1477,6 @@ Accesses to this index data from RAM. [%hardbreaks] {blank} - a¦ Integer @@ -1506,7 +1492,6 @@ Accesses to this index data from disk. [%hardbreaks] {blank} - a¦ Integer @@ -1523,7 +1508,6 @@ The size of indexable data that is maintained for the index or partition (bytes) [%hardbreaks] *Example:* `95728` {blank} - a¦ Integer @@ -1540,7 +1524,6 @@ Total disk file size consumed by the index or partition. [%hardbreaks] *Example:* `889054` {blank} - a¦ Integer @@ -1558,7 +1541,6 @@ The number of documents currently indexed. [%hardbreaks] {blank} - a¦ Integer @@ -1577,7 +1559,6 @@ TIP: At small index sizes of less than a hundred kB, the static overhead of the [%hardbreaks] {blank} - a¦ Integer @@ -1598,7 +1579,6 @@ For an index partition, the value is listed as `0`. [%hardbreaks] *Example:* `100` {blank} - a¦ Integer @@ -1615,7 +1595,6 @@ The number of items currently indexed. [%hardbreaks] *Example:* `2155` {blank} - a¦ Integer @@ -1635,7 +1614,6 @@ NOTE: This statistic is persisted to disk every 15 minutes, so it is preserved w [%hardbreaks] {blank} - a¦ Long (int64) @@ -1651,7 +1629,6 @@ Number of documents indexed by the indexer since last startup. [%hardbreaks] {blank} - a¦ Integer @@ -1667,7 +1644,6 @@ Number of documents pending to be indexed. [%hardbreaks] {blank} - a¦ Integer @@ -1683,7 +1659,6 @@ Number of documents queued to be indexed. [%hardbreaks] {blank} - a¦ Integer @@ -1699,7 +1674,6 @@ Number of items flushed from memory to disk storage. [%hardbreaks] {blank} - a¦ Integer @@ -1715,7 +1689,6 @@ Number of requests received but not yet served by the indexer. [%hardbreaks] {blank} - a¦ Integer @@ -1731,7 +1704,6 @@ Number of requests served by the indexer since last startup. [%hardbreaks] {blank} - a¦ Integer @@ -1747,7 +1719,6 @@ Total number of rows returned so far by the indexer. [%hardbreaks] {blank} - a¦ Integer @@ -1763,7 +1734,6 @@ Number of requests that failed due to errors other than timeout. [%hardbreaks] {blank} - a¦ Integer @@ -1779,7 +1749,6 @@ Number of requests that timed out, either waiting for snapshots or during scan i [%hardbreaks] {blank} - a¦ Integer @@ -1799,7 +1768,6 @@ For memory-optimized index storage, this is the same as `items_count`. [%hardbreaks] *Example:* `2155` {blank} - a¦ Integer @@ -1816,7 +1784,6 @@ For memory-optimized index storage, this is `0`. [%hardbreaks] {blank} - a¦ Integer @@ -1833,7 +1800,6 @@ Percentage of the data held in memory. [%hardbreaks] *Example:* `100` {blank} - a¦ Integer @@ -1849,7 +1815,6 @@ Number of bytes read by a scan since last startup. [%hardbreaks] {blank} - a¦ Integer @@ -1865,7 +1830,6 @@ Total time spent by the indexer in scanning rows since last startup (nanoseconds [%hardbreaks] {blank} - a¦ Integer diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index 9efcd067..9079ee3f 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -4737,7 +4737,6 @@ The name of the cluster. [%hardbreaks] {blank} - a¦ String @@ -4753,7 +4752,6 @@ The URL of the datastore. [%hardbreaks] {blank} - a¦ String @@ -4769,7 +4767,6 @@ The URL of the configstore. [%hardbreaks] {blank} - a¦ String @@ -4785,7 +4782,6 @@ The URL of the accountstore. [%hardbreaks] {blank} - a¦ String @@ -4800,7 +4796,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -4857,7 +4852,6 @@ The amount of memory freed. [%hardbreaks] {blank} - a¦ Integer @@ -4874,7 +4868,6 @@ The amount of memory released to the OS. [%hardbreaks] {blank} - a¦ Integer @@ -4890,7 +4883,6 @@ The status of the garbage collector. [%hardbreaks] {blank} - a¦ String @@ -4959,7 +4951,6 @@ If true, all requests that generate a panic are logged. *Default:* `null` *Example:* `true` {blank} - a¦ Boolean @@ -4978,7 +4969,6 @@ If specified, all completed requests from this IP address are logged. *Default:* `+++""+++` *Example:* `+++"172.1.2.3"+++` {blank} - a¦ String @@ -5003,7 +4993,6 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo [%hardbreaks] {blank} - a¦ String @@ -5022,7 +5011,6 @@ If specified, all completed queries returning this error number are logged. *Default:* `null` *Example:* `12003` {blank} - a¦ Integer (int32) @@ -5044,7 +5032,6 @@ Refer to [Configure Completed Requests][sys-completed-config] for more informati *Default:* `+++""+++` *Example:* `+++"both_user_and_error"+++` {blank} - a¦ String @@ -5065,7 +5052,6 @@ This is another way of specifying the `completed-threshold` setting. *Default:* `1000` *Example:* `7000` {blank} - a¦ Integer (int32) @@ -5084,7 +5070,6 @@ If specified, all completed queries with this user name are logged. *Default:* `+++""+++` *Example:* `+++"marco"+++` {blank} - a¦ String @@ -5103,7 +5088,6 @@ Queries with fewer errors are not logged. [%hardbreaks] *Example:* `5` {blank} - a¦ Integer (int32) @@ -5160,7 +5144,6 @@ A single value that represents the current state. [%hardbreaks] {blank} - a¦ Integer @@ -5176,7 +5159,6 @@ a¦ [%hardbreaks] {blank} - a¦ Big Decimal @@ -5192,7 +5174,6 @@ a¦ [%hardbreaks] {blank} - a¦ Big Decimal @@ -5208,7 +5189,6 @@ a¦ [%hardbreaks] {blank} - a¦ Big Decimal @@ -5224,7 +5204,6 @@ Mean rate since the query service started. [%hardbreaks] {blank} - a¦ Big Decimal @@ -5240,7 +5219,6 @@ The maximum value. [%hardbreaks] {blank} - a¦ Integer @@ -5256,7 +5234,6 @@ The mean value. [%hardbreaks] {blank} - a¦ Big Decimal @@ -5272,7 +5249,6 @@ The median value. [%hardbreaks] {blank} - a¦ Big Decimal @@ -5288,7 +5264,6 @@ The minimum value. [%hardbreaks] {blank} - a¦ Integer @@ -5304,7 +5279,6 @@ The standard deviation. [%hardbreaks] {blank} - a¦ Big Decimal @@ -5320,7 +5294,6 @@ The 75th percentile. [%hardbreaks] {blank} - a¦ Big Decimal @@ -5336,7 +5309,6 @@ The 95th percentile. [%hardbreaks] {blank} - a¦ Big Decimal @@ -5352,7 +5324,6 @@ The 99th percentile. [%hardbreaks] {blank} - a¦ Big Decimal @@ -5368,7 +5339,6 @@ The 99.9th percentile. [%hardbreaks] {blank} - a¦ Big Decimal @@ -5425,7 +5395,6 @@ The name of the cluster. [%hardbreaks] {blank} - a¦ String @@ -5441,7 +5410,6 @@ The URL of the node, including port number. [%hardbreaks] {blank} - a¦ String @@ -5457,7 +5425,6 @@ The HTTP URL of the query endpoint. [%hardbreaks] {blank} - a¦ String @@ -5473,7 +5440,6 @@ The HTTP URL of the admin endpoint. [%hardbreaks] {blank} - a¦ String @@ -5489,7 +5455,6 @@ The HTTPS URL of the query endpoint. [%hardbreaks] {blank} - a¦ String @@ -5505,7 +5470,6 @@ The HTTPS URL of the admin endpoint. [%hardbreaks] {blank} - a¦ String @@ -5520,7 +5484,6 @@ a¦ [%hardbreaks] {blank} - a¦ String @@ -5585,7 +5548,6 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo [%hardbreaks] {blank} - a¦ String @@ -5602,7 +5564,6 @@ It includes the time taken by the service to schedule the request. [%hardbreaks] {blank} - a¦ String (duration) @@ -5618,7 +5579,6 @@ Total number of errors encountered while executing the query. [%hardbreaks] {blank} - a¦ Integer @@ -5635,7 +5595,6 @@ This property is only returned if a memory quota is set for the query. [%hardbreaks] {blank} - a¦ Integer @@ -5651,7 +5610,6 @@ IP address and port number of the node where the query is executed. [%hardbreaks] {blank} - a¦ String @@ -5671,7 +5629,6 @@ Polling the active requests again may return different values. [%hardbreaks] *Example:* `{"fetch":16,"indexScan":187}` {blank} - a¦ Object @@ -5692,7 +5649,6 @@ A union select would have twice as many operator counts, one per each branch of [%hardbreaks] *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} - a¦ Object @@ -5712,7 +5668,6 @@ Polling the active requests again may return different values. [%hardbreaks] *Example:* `{"authorize":"823.631µs","fetch":"656.873µs","indexScan":"29.146543ms","instantiate":"236.221µs","parse":"826.382µs","plan":"11.831101ms","run":"16.892181ms"}` {blank} - a¦ Object @@ -5728,7 +5683,6 @@ IP address and port number of the client application, from where the query is re [%hardbreaks] {blank} - a¦ String @@ -5744,7 +5698,6 @@ Unique request ID internally generated for the query. [%hardbreaks] {blank} - a¦ UUID (uuid) @@ -5760,7 +5713,6 @@ Timestamp when the query is received. [%hardbreaks] {blank} - a¦ Date (date-time) @@ -5776,7 +5728,6 @@ Total number of documents returned in the query result. [%hardbreaks] {blank} - a¦ Integer @@ -5792,7 +5743,6 @@ Total number of bytes returned in the query result. [%hardbreaks] {blank} - a¦ Integer @@ -5808,7 +5758,6 @@ The value of the query setting Scan Consistency used for the query. [%hardbreaks] {blank} - a¦ String @@ -5824,7 +5773,6 @@ Total amount of calendar time taken to complete the query. [%hardbreaks] {blank} - a¦ String (duration) @@ -5845,7 +5793,6 @@ To find requests that were successful, use this field in conjunction with the `e [%hardbreaks] {blank} - a¦ String @@ -5861,7 +5808,6 @@ The query statement being executed. [%hardbreaks] {blank} - a¦ String @@ -5877,7 +5823,6 @@ Whether the cost-based optimizer is enabled for the query. [%hardbreaks] {blank} - a¦ Boolean @@ -5894,7 +5839,6 @@ This property is only returned if a memory quota is set for the query. [%hardbreaks] {blank} - a¦ Integer @@ -5910,7 +5854,6 @@ Name of the client application or program that issued the query. [%hardbreaks] {blank} - a¦ String @@ -5926,7 +5869,6 @@ Username with whose privileges the query is run. [%hardbreaks] {blank} - a¦ String @@ -6001,7 +5943,6 @@ If a request does not include this parameter, the node-level `atrcollection` set *Default:* `+++""+++` *Example:* `+++"default:`travel-sample`.transaction.test"+++` {blank} - a¦ String @@ -6023,7 +5964,6 @@ Refer to [Auto-Prepare][auto-prepare] for more information. *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -6050,7 +5990,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} - a¦ Boolean @@ -6077,7 +6016,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} - a¦ Boolean @@ -6118,7 +6056,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `+++"60s"+++` *Example:* `+++"30s"+++` {blank} - a¦ String (duration) @@ -6134,7 +6071,6 @@ include::index.adoc[tag=desc-Logging_Parameters, opts=optional] [%hardbreaks] {blank} - a¦ xref:Logging_Parameters[] @@ -6168,7 +6104,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `4000` *Example:* `7000` {blank} - a¦ Integer (int32) @@ -6204,7 +6139,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `20840448` {blank} - a¦ Integer (int32) @@ -6231,7 +6165,6 @@ Refer to [Stream Completed Requests][sys-history] for more information and examp [%hardbreaks] {blank} - a¦ Integer (int32) @@ -6266,7 +6199,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `1000` *Example:* `7000` {blank} - a¦ Integer (int32) @@ -6297,7 +6229,6 @@ If a request does not include this parameter, the node-level `controls` setting *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -6321,7 +6252,6 @@ To stop `cpuprofile`, run with the empty setting of `""`. *Default:* `+++""+++` *Example:* `+++"/tmp/info.txt"+++` {blank} - a¦ String @@ -6341,7 +6271,6 @@ When set to `true`, extra logging is provided. *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -6360,7 +6289,6 @@ The actual value of this field is ignored. [%hardbreaks] *Example:* `true` {blank} - a¦ Boolean @@ -6378,7 +6306,6 @@ Maximum number of user-defined functions. *Default:* `16384` *Example:* `7000` {blank} - a¦ Integer (int32) @@ -6396,7 +6323,6 @@ Maximum size of buffered result. *Default:* `16384` *Example:* `7000` {blank} - a¦ Integer (int32) @@ -6446,7 +6372,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `+++"INFO"+++` *Example:* `+++"DEBUG"+++` {blank} - a¦ String @@ -6463,7 +6388,6 @@ This setting is provided for technical support only. [%hardbreaks] {blank} - a¦ Integer (int32) @@ -6507,7 +6431,6 @@ NOTE: To enable queries to run in parallel, you must specify the cluster-level ` *Default:* `1` *Example:* `0` {blank} - a¦ Integer (int32) @@ -6548,7 +6471,6 @@ If a request includes this parameter, it will be capped by the node-level `memor *Default:* `0` *Example:* `4` {blank} - a¦ Integer (int32) @@ -6570,7 +6492,6 @@ To stop `memprofile`, run with the empty setting of `""`. *Default:* `+++""+++` *Example:* `+++"/tmp/memory-usage.log"+++` {blank} - a¦ String @@ -6588,7 +6509,6 @@ This setting is provided for technical support only. [%hardbreaks] *Default:* `false` {blank} - a¦ Boolean @@ -6617,7 +6537,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `76` *Example:* `16460` {blank} - a¦ Integer (int32) @@ -6654,7 +6573,6 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} - a¦ Integer (int32) @@ -6683,7 +6601,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `100` {blank} - a¦ Integer (int32) @@ -6716,7 +6633,6 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} - a¦ Integer (int32) @@ -6748,7 +6664,6 @@ The minimum of that and the node-level `numatrs` setting is applied. [%hardbreaks] {blank} - a¦ String @@ -6780,7 +6695,6 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. *Default:* `16` *Example:* `64` {blank} - a¦ Integer (int32) @@ -6812,7 +6726,6 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} - a¦ Integer (int32) @@ -6830,7 +6743,6 @@ The default is 16 times the number of logical cores. [%hardbreaks] *Example:* `16` {blank} - a¦ Integer (int32) @@ -6858,7 +6770,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `16384` *Example:* `65536` {blank} - a¦ Integer (int32) @@ -6885,7 +6796,6 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -6928,7 +6838,6 @@ If a request does not include this parameter, the node-level `profile` setting w *Default:* `+++"off"+++` *Example:* `+++"phases"+++` {blank} - a¦ String @@ -6946,7 +6855,6 @@ Maximum size of a request. *Default:* `67108864` *Example:* `70000` {blank} - a¦ Integer (int32) @@ -6982,7 +6890,6 @@ The minimum of that and the node-level `scan-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} - a¦ Integer (int32) @@ -7001,7 +6908,6 @@ The default is 4 times the number of cores on the query node. *Default:* `32` *Example:* `8` {blank} - a¦ Integer (int32) @@ -7039,7 +6945,6 @@ The minimum of that and the node-level `timeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} - a¦ Long (int64) @@ -7082,7 +6987,6 @@ The minimum of that and the node-level `txtimeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} - a¦ Long (int64) @@ -7114,7 +7018,6 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `true` *Example:* `false` {blank} - a¦ Boolean @@ -7163,7 +7066,6 @@ If the request-level parameter and the node-level setting are both `unset`, read *Default:* `+++"unset"+++` *Example:* `+++"on"+++` {blank} - a¦ String @@ -7220,7 +7122,6 @@ The full prepared statement in encoded format. [%hardbreaks] {blank} - a¦ String @@ -7237,7 +7138,6 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} - a¦ Integer @@ -7254,7 +7154,6 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} - a¦ Integer @@ -7271,7 +7170,6 @@ This may be a UUID that was assigned automatically, or a name that was user-spec [%hardbreaks] {blank} - a¦ String @@ -7288,7 +7186,6 @@ Currently, only the `default` namespace is available. [%hardbreaks] {blank} - a¦ String @@ -7304,7 +7201,6 @@ The node on which the prepared statement is stored. [%hardbreaks] {blank} - a¦ String @@ -7320,7 +7216,6 @@ The text of the query. [%hardbreaks] {blank} - a¦ String @@ -7336,7 +7231,6 @@ The count of times the prepared statement has been executed. [%hardbreaks] {blank} - a¦ Integer @@ -7356,7 +7250,6 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} - a¦ String (duration) @@ -7375,7 +7268,6 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} - a¦ String (duration) @@ -7393,7 +7285,6 @@ This property is only returned when the prepared statement has been executed. [%hardbreaks] {blank} - a¦ Date (date-time) @@ -7413,7 +7304,6 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} - a¦ String (duration) @@ -7432,7 +7322,6 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} - a¦ String (duration) @@ -7452,7 +7341,6 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} - a¦ String (duration) @@ -7471,7 +7359,6 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} - a¦ String (duration) @@ -7528,7 +7415,6 @@ Total number of active requests. [%hardbreaks] {blank} - a¦ Integer @@ -7544,7 +7430,6 @@ Total number of query requests with `at_plus` index consistency. [%hardbreaks] {blank} - a¦ Integer @@ -7562,7 +7447,6 @@ Records in the output queue that have not yet been sent to the server are not co [%hardbreaks] {blank} - a¦ Integer @@ -7578,7 +7462,6 @@ The total number of audit records sent to the server that failed. [%hardbreaks] {blank} - a¦ Integer @@ -7594,7 +7477,6 @@ The number of potentially auditable requests that cause no audit action to be ta [%hardbreaks] {blank} - a¦ Integer @@ -7610,7 +7492,6 @@ The total number of potentially auditable requests sent to the query engine. [%hardbreaks] {blank} - a¦ Integer @@ -7626,7 +7507,6 @@ Total number of cancelled requests. [%hardbreaks] {blank} - a¦ Integer @@ -7642,7 +7522,6 @@ Total number of DELETE operations. [%hardbreaks] {blank} - a¦ Integer @@ -7658,7 +7537,6 @@ The total number of query errors returned so far. [%hardbreaks] {blank} - a¦ Integer @@ -7674,7 +7552,6 @@ Total number of secondary index scans. [%hardbreaks] {blank} - a¦ Integer @@ -7690,7 +7567,6 @@ Total number of INSERT operations. [%hardbreaks] {blank} - a¦ Integer @@ -7706,7 +7582,6 @@ Total number of requests for unsupported endpoints. [%hardbreaks] {blank} - a¦ Integer @@ -7722,7 +7597,6 @@ Total number of document mutations. [%hardbreaks] {blank} - a¦ Integer @@ -7738,7 +7612,6 @@ Total number of prepared statements executed. [%hardbreaks] {blank} - a¦ Integer @@ -7754,7 +7627,6 @@ Total number of primary index scans. [%hardbreaks] {blank} - a¦ Integer @@ -7770,7 +7642,6 @@ Total number of queued requests. [%hardbreaks] {blank} - a¦ Integer @@ -7786,7 +7657,6 @@ Total end-to-end time to process all queries (ns). [%hardbreaks] {blank} - a¦ Integer @@ -7803,7 +7673,6 @@ Number of query requests processed per second. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7820,7 +7689,6 @@ Number of query requests processed per second. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7837,7 +7705,6 @@ Number of query requests processed per second. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7854,7 +7721,6 @@ The 75th percentile. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7871,7 +7737,6 @@ The 95th percentile. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7888,7 +7753,6 @@ The 99th percentile. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7905,7 +7769,6 @@ The 99.9th percentile. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7921,7 +7784,6 @@ Total number of query requests. [%hardbreaks] {blank} - a¦ Integer @@ -7938,7 +7800,6 @@ The maximum value. [%hardbreaks] {blank} - a¦ Integer @@ -7955,7 +7816,6 @@ The mean value. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7972,7 +7832,6 @@ Mean rate since the query service started. [%hardbreaks] {blank} - a¦ Big Decimal @@ -7989,7 +7848,6 @@ The median value. [%hardbreaks] {blank} - a¦ Big Decimal @@ -8006,7 +7864,6 @@ The minimum value. [%hardbreaks] {blank} - a¦ Integer @@ -8023,7 +7880,6 @@ The standard deviation. [%hardbreaks] {blank} - a¦ Big Decimal @@ -8039,7 +7895,6 @@ Total number of query requests. [%hardbreaks] {blank} - a¦ Integer @@ -8055,7 +7910,6 @@ Number of queries that take longer than 1000ms. [%hardbreaks] {blank} - a¦ Integer @@ -8071,7 +7925,6 @@ Number of queries that take longer than 250ms. [%hardbreaks] {blank} - a¦ Integer @@ -8087,7 +7940,6 @@ Number of queries that take longer than 5000ms. [%hardbreaks] {blank} - a¦ Integer @@ -8103,7 +7955,6 @@ Number of queries that take longer than 500ms. [%hardbreaks] {blank} - a¦ Integer @@ -8119,7 +7970,6 @@ Total number of results (documents) returned by the query engine. [%hardbreaks] {blank} - a¦ Integer @@ -8135,7 +7985,6 @@ Total size of data returned by the query engine (bytes). [%hardbreaks] {blank} - a¦ Integer @@ -8151,7 +8000,6 @@ Total number of query requests with `request_plus` index consistency. [%hardbreaks] {blank} - a¦ Integer @@ -8167,7 +8015,6 @@ Total number of SELECT requests. [%hardbreaks] {blank} - a¦ Integer @@ -8183,7 +8030,6 @@ Time to execute all queries (ns). [%hardbreaks] {blank} - a¦ Integer @@ -8199,7 +8045,6 @@ Total number of query requests with `not_bounded` index consistency. [%hardbreaks] {blank} - a¦ Integer @@ -8215,7 +8060,6 @@ Total number of UPDATE requests. [%hardbreaks] {blank} - a¦ Integer @@ -8231,7 +8075,6 @@ The total number of query warnings returned so far. [%hardbreaks] {blank} - a¦ Integer @@ -8288,7 +8131,6 @@ The number of reads and retries for each bucket. [%hardbreaks] {blank} - a¦ Object @@ -8304,7 +8146,6 @@ The uptime of the query engine. [%hardbreaks] {blank} - a¦ String (duration) @@ -8320,7 +8161,6 @@ The local time of the query engine. [%hardbreaks] {blank} - a¦ Date (date-time) @@ -8336,7 +8176,6 @@ The version of the query engine. [%hardbreaks] {blank} - a¦ String @@ -8352,7 +8191,6 @@ The number of active threads used by the query engine. [%hardbreaks] {blank} - a¦ Integer @@ -8368,7 +8206,6 @@ The maximum number of logical cores available to the query engine. [%hardbreaks] {blank} - a¦ Integer @@ -8384,7 +8221,6 @@ The total number of times FFDC has been invoked since the last restart. [%hardbreaks] {blank} - a¦ Integer @@ -8400,7 +8236,6 @@ The target heap size of the next garbage collection cycle. [%hardbreaks] {blank} - a¦ Long (int64) @@ -8416,7 +8251,6 @@ The total time spent pausing for garbage collection since the query engine start [%hardbreaks] {blank} - a¦ String (duration) @@ -8432,7 +8266,6 @@ The percentage of time spent pausing for garbage collection since the last time [%hardbreaks] {blank} - a¦ Long (int64) @@ -8448,7 +8281,6 @@ False when either the unbounded or plus request queues are full; true otherwise. [%hardbreaks] {blank} - a¦ Boolean @@ -8464,7 +8296,6 @@ Amount of free memory on the host. [%hardbreaks] {blank} - a¦ Long (int64) @@ -8481,7 +8312,6 @@ This reflects the node-quota setting. [%hardbreaks] {blank} - a¦ Long (int64) @@ -8497,7 +8327,6 @@ Total memory on the host. [%hardbreaks] {blank} - a¦ Long (int64) @@ -8513,7 +8342,6 @@ This the total document memory quota on the node. [%hardbreaks] {blank} - a¦ Long (int64) @@ -8529,7 +8357,6 @@ A calculation for how busy the server is. [%hardbreaks] {blank} - a¦ Integer @@ -8545,7 +8372,6 @@ The moving 15 minute average of the load calculation. [%hardbreaks] {blank} - a¦ Integer @@ -8562,7 +8388,6 @@ This increases as heap objects are allocated, and decreases as objects are freed [%hardbreaks] {blank} - a¦ Long (int64) @@ -8579,7 +8404,6 @@ This increases as heap objects are allocated, but does not decrease when objects [%hardbreaks] {blank} - a¦ Long (int64) @@ -8596,7 +8420,6 @@ This measures the virtual address space reserved by the query engine for heaps, [%hardbreaks] {blank} - a¦ Long (int64) @@ -8612,7 +8435,6 @@ The name or IP address and port of the node. [%hardbreaks] {blank} - a¦ String @@ -8629,7 +8451,6 @@ The total number of values allocated to contain documents or computations around [%hardbreaks] {blank} - a¦ Integer @@ -8645,7 +8466,6 @@ The currently allocated document memory on the node. [%hardbreaks] {blank} - a¦ Integer @@ -8662,7 +8482,6 @@ The percentage of time spent executing user code since the last time the statist [%hardbreaks] {blank} - a¦ Long (int64) @@ -8679,7 +8498,6 @@ The percentage of time spent executing system code since the last time the stati [%hardbreaks] {blank} - a¦ Long (int64) @@ -8695,7 +8513,6 @@ Current process memory use. [%hardbreaks] {blank} - a¦ Integer @@ -8711,7 +8528,6 @@ Average CPU usage per core. [%hardbreaks] {blank} - a¦ Big Decimal @@ -8727,7 +8543,6 @@ Process RSS (bytes) [%hardbreaks] {blank} - a¦ Integer @@ -8743,7 +8558,6 @@ The number of active servicers for the dominant workload — unbound queue s [%hardbreaks] {blank} - a¦ Integer @@ -8759,7 +8573,6 @@ Total number of completed requests. [%hardbreaks] {blank} - a¦ Integer @@ -8775,7 +8588,6 @@ Total number of active requests. [%hardbreaks] {blank} - a¦ Integer @@ -8792,7 +8604,6 @@ Number of query requests processed per second. [%hardbreaks] {blank} - a¦ Big Decimal @@ -8809,7 +8620,6 @@ Number of query requests processed per second. [%hardbreaks] {blank} - a¦ Big Decimal @@ -8826,7 +8636,6 @@ Number of query requests processed per second. [%hardbreaks] {blank} - a¦ Big Decimal @@ -8842,7 +8651,6 @@ Number of queued requests. [%hardbreaks] {blank} - a¦ Integer @@ -8858,7 +8666,6 @@ High water mark for request quota use. [%hardbreaks] {blank} - a¦ Integer @@ -8875,7 +8682,6 @@ The mean value. [%hardbreaks] {blank} - a¦ String (duration) @@ -8892,7 +8698,6 @@ The median value. [%hardbreaks] {blank} - a¦ String (duration) @@ -8909,7 +8714,6 @@ The 80th percentile. [%hardbreaks] {blank} - a¦ String (duration) @@ -8926,7 +8730,6 @@ The 95th percentile. [%hardbreaks] {blank} - a¦ String (duration) @@ -8943,7 +8746,6 @@ The 99th percentile. [%hardbreaks] {blank} - a¦ String (duration) @@ -8959,7 +8761,6 @@ Percentage of requests that are prepared statements. [%hardbreaks] {blank} - a¦ Integer @@ -8976,7 +8777,6 @@ Number of servicers temporarily paused due to memory pressure. [%hardbreaks] {blank} - a¦ Integer @@ -8993,7 +8793,6 @@ Number of times servicers have been temporarily paused. [%hardbreaks] {blank} - a¦ Integer @@ -9010,7 +8809,6 @@ High water mark for temp space use directly by query. [%hardbreaks] {blank} - a¦ Integer @@ -9027,7 +8825,6 @@ Current Query temp space use. [%hardbreaks] {blank} - a¦ Integer diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index 89406815..d656e675 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -1219,7 +1219,6 @@ The name of the property is the name of the library. [%hardbreaks] *Example:* `+++"function add(a, b) { return a + b; } function mul(a, b) { return a * b; }"+++` {blank} - a¦ String @@ -1277,7 +1276,6 @@ The name of a library. [%hardbreaks] *Example:* `+++"math"+++` {blank} - a¦ String @@ -1295,7 +1293,6 @@ For scoped libraries, the bucket in which the library is stored. For global libr [%hardbreaks] *Example:* `+++"travel-sample"+++` {blank} - a¦ String @@ -1313,7 +1310,6 @@ For scoped libraries, the scope in which the library is stored. For global libra [%hardbreaks] *Example:* `+++"inventory"+++` {blank} - a¦ String @@ -1331,7 +1327,6 @@ The JavaScript code for all functions in the library. [%hardbreaks] *Example:* `+++"function add(a, b) { return a + b; } function mul(a, b) { return a * b; }"+++` {blank} - a¦ String diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc index e68f7b54..3ca2ac08 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -754,7 +754,6 @@ This property is always present in every condition returned in the Query REST AP [%hardbreaks] {blank} - a¦ Integer @@ -771,7 +770,6 @@ This property is always present in every condition returned in the Query REST AP [%hardbreaks] {blank} - a¦ String @@ -791,7 +789,6 @@ The name should be fully qualified. [%hardbreaks] *Example:* `+++"indexing.scan.io_failure"+++` {blank} - a¦ String @@ -812,7 +809,6 @@ One of the following SQL++ severity levels, listed in order of severity: [%hardbreaks] {blank} - a¦ Integer @@ -829,7 +825,6 @@ If the value is `false`, it tells clients and users that a retry without modific [%hardbreaks] {blank} - a¦ Boolean @@ -892,7 +887,6 @@ The value of the query setting Scan Consistency used for the query. [%hardbreaks] {blank} - a¦ String @@ -908,7 +902,6 @@ Whether the cost-based optimizer was enabled for the query. [%hardbreaks] {blank} - a¦ Boolean @@ -925,7 +918,6 @@ This property is only returned if a memory quota was set for the query. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -942,7 +934,6 @@ The type of query statement. [%hardbreaks] *Example:* `+++"SELECT"+++` {blank} - a¦ String @@ -1001,7 +992,6 @@ Note that bucket names may be prefixed with `local:`, and admin names may be pre [%hardbreaks] *Example:* `+++"local:bucket-name"+++` {blank} - a¦ String @@ -1018,7 +1008,6 @@ A password for authentication. [%hardbreaks] *Example:* `+++"password"+++` {blank} - a¦ String @@ -1083,7 +1072,6 @@ Name of the operator. [%hardbreaks] *Example:* `+++"Fetch"+++` {blank} - a¦ String @@ -1099,7 +1087,6 @@ include::index.adoc[tag=desc-Statistics, opts=optional] [%hardbreaks] {blank} - a¦ xref:Statistics[] @@ -1115,7 +1102,6 @@ Further nested operators, each with their own execution timings. [%hardbreaks] {blank} - a¦ Object @@ -1177,7 +1163,6 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} - a¦ String @@ -1193,7 +1178,6 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} - a¦ String @@ -1209,7 +1193,6 @@ The total number of objects in the results. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1225,7 +1208,6 @@ The total number of bytes in the results. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1241,7 +1223,6 @@ The number of mutations that were made during the request. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1260,7 +1241,6 @@ If a query includes ORDER BY, LIMIT, or OFFSET clauses, an application can use t [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1277,7 +1257,6 @@ This property is only returned if a memory quota was set for the query. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1293,7 +1272,6 @@ The number of errors that occurred during the request. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1309,7 +1287,6 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} - a¦ Integer (unsigned) @@ -1372,7 +1349,6 @@ Timestamp when the query was received. [%hardbreaks] {blank} - a¦ Date (date-time) @@ -1388,7 +1364,6 @@ IP address and port number of the node where the query was executed. [%hardbreaks] {blank} - a¦ String @@ -1405,7 +1380,6 @@ Count of documents processed at selective phases involved in the query execution [%hardbreaks] *Example:* `{"fetch":16,"indexScan":187}` {blank} - a¦ Object @@ -1428,7 +1402,6 @@ This is in essence the count of all the operators in the `executionTimings` obje [%hardbreaks] *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} - a¦ Object @@ -1445,7 +1418,6 @@ Cumulative execution times for various phases involved in the query execution, s [%hardbreaks] *Example:* `{"authorize":"823.631µs","fetch":"656.873µs","indexScan":"29.146543ms","instantiate":"236.221µs","parse":"826.382µs","plan":"11.831101ms","run":"16.892181ms"}` {blank} - a¦ Object @@ -1461,7 +1433,6 @@ include::index.adoc[tag=desc-Execution_Timings, opts=optional] [%hardbreaks] {blank} - a¦ xref:Execution_Timings[] @@ -1526,7 +1497,6 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d [%hardbreaks] *Example:* `["LAX",6]` {blank} - a¦ Any Type array @@ -1559,7 +1529,6 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Example:* `+++"default:`travel-sample`.transaction.test"+++` {blank} - a¦ String @@ -1582,7 +1551,6 @@ Refer to [Auto-Execute][auto-execute] for more information. *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -1602,7 +1570,6 @@ SQL++ is agnostic about the content of this parameter; it is just echoed in the [%hardbreaks] {blank} - a¦ String @@ -1623,7 +1590,6 @@ Values are case-insensitive. *Default:* `+++"NONE"+++` *Example:* `+++"zip"+++` {blank} - a¦ String @@ -1653,7 +1619,6 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Example:* `true` {blank} - a¦ Boolean @@ -1676,7 +1641,6 @@ If credentials are supplied in the request header, then HTTP Basic Authenticatio [%hardbreaks] *Example:* `[{"user":"local:bucket-name","pass":"password"},{"user":"admin:admin-name","pass":"password"}]` {blank} - a¦ xref:Credentials[] array @@ -1705,7 +1669,6 @@ Set the durability level to `"none"` or `""` to specify no durability. *Default:* `+++"majority"+++` *Example:* `+++"none"+++` {blank} - a¦ String @@ -1722,7 +1685,6 @@ It is included for compatibility with previous versions of Couchbase Server. [%hardbreaks] {blank} - a¦ String @@ -1741,7 +1703,6 @@ Only possible value is `UTF-8` and is case-insensitive. [%hardbreaks] *Default:* `+++"UTF-8"+++` {blank} - a¦ String @@ -1762,7 +1723,6 @@ Values are case-insensitive. *Default:* `+++"JSON"+++` *Example:* `+++"XML"+++` {blank} - a¦ String @@ -1797,7 +1757,6 @@ When disabled, no timeout is applied and the KV operation runs for however long *Default:* `+++"2.5s"+++` *Example:* `+++"10ms"+++` {blank} - a¦ String @@ -1834,7 +1793,6 @@ To enable queries to run in parallel, you must specify the cluster-level `queryM [%hardbreaks] *Example:* `3` {blank} - a¦ Integer (int32) @@ -1876,7 +1834,6 @@ When you change the cluster-level setting, the node-level setting is overwritten *Default:* `0` *Example:* `4` {blank} - a¦ Integer (int32) @@ -1894,7 +1851,6 @@ Specifies that metrics should be returned with query results. *Default:* `true` *Example:* `false` {blank} - a¦ Boolean @@ -1912,7 +1868,6 @@ Currently, only the `default` namespace is available. [%hardbreaks] *Example:* `+++"default"+++` {blank} - a¦ String @@ -1947,7 +1902,6 @@ When you change the cluster-level setting, the node-level setting is overwritten *Default:* `1024` *Example:* `512` {blank} - a¦ Integer (int32) @@ -1978,7 +1932,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `64` {blank} - a¦ Integer (int32) @@ -2009,7 +1962,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `1024` {blank} - a¦ Integer (int32) @@ -2033,7 +1985,6 @@ If both `prepared` and `statement` are present and non-empty, an error is return [%hardbreaks] *Example:* `+++"[127.0.0.1:8091]pricy_hotel"+++` {blank} - a¦ String @@ -2058,7 +2009,6 @@ Not supported for statements in a transaction. *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -2084,7 +2034,6 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Example:* `false` {blank} - a¦ Boolean @@ -2124,7 +2073,6 @@ The request-level parameter overrides the node-level setting. *Values:* `"off"`, `"phases"`, `"timings"` *Example:* `+++"phases"+++` {blank} - a¦ String @@ -2146,7 +2094,6 @@ If the namespace name is omitted, the default namespace in the current session i *Default:* `+++"default:"+++` *Example:* `+++"default:travel-sample.inventory"+++` {blank} - a¦ String @@ -2175,7 +2122,6 @@ When using GET requests, it's best to set `readonly` to `true`. *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -2210,7 +2156,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `1024` {blank} - a¦ Integer (int32) @@ -2260,7 +2205,6 @@ Refer to [Transactional Scan Consistency][transactional-scan-consistency] for de *Default:* `+++"not_bounded"+++` *Example:* `+++"at_plus"+++` {blank} - a¦ String @@ -2293,7 +2237,6 @@ For queries referencing multiple keyspaces, use `scan_vectors`. [%hardbreaks] *Example:* `{"5":[5409393,"VB5ID"],"19":[47574574,"VB19ID"]}` {blank} - a¦ Object @@ -2314,7 +2257,6 @@ The scan vectors can be Full or Sparse. [%hardbreaks] {blank} - a¦ Object @@ -2349,7 +2291,6 @@ Specify `0` or a negative integer to disable. *Default:* `+++""+++` *Example:* `+++"30m"+++` {blank} - a¦ String (duration) @@ -2367,7 +2308,6 @@ Include a header for the results schema in the response. *Default:* `true` *Example:* `false` {blank} - a¦ Boolean @@ -2387,7 +2327,6 @@ If `false` (the default), statement projection terms are returned in the order s *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -2416,7 +2355,6 @@ This restriction does not apply when specifying the request parameters in JSON f [%hardbreaks] *Example:* `+++"SELECT * FROM `travel-sample`.inventory.hotel LIMIT 1"+++` {blank} - a¦ String @@ -2465,7 +2403,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `+++"30m"+++` {blank} - a¦ String (duration) @@ -2482,7 +2419,6 @@ For internal use only. [%hardbreaks] {blank} - a¦ Object @@ -2506,7 +2442,6 @@ The transaction must be active and non-expired. [%hardbreaks] *Example:* `+++"d81d9b4a-b758-4f98-b007-87ba262d3a51"+++` {blank} - a¦ UUID (UUID) @@ -2530,7 +2465,6 @@ If the `txid` request-level parameter is set, the `tximplicit` parameter is igno *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -2549,7 +2483,6 @@ If the transaction statement number is lower than the transaction statement numb [%hardbreaks] *Example:* `10` {blank} - a¦ Integer (int32) @@ -2603,7 +2536,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `+++"30m"+++` {blank} - a¦ String (duration) @@ -2634,7 +2566,6 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `true` {blank} - a¦ Boolean @@ -2662,7 +2593,6 @@ Refer to [Flex Indexes][flex-indexes] for more information. *Default:* `false` *Example:* `true` {blank} - a¦ Boolean @@ -2712,7 +2642,6 @@ When you change the cluster-level setting, the node-level setting is overwritten *Default:* `+++"unset"+++` *Example:* `+++"true"+++` {blank} - a¦ String @@ -2742,7 +2671,6 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d [%hardbreaks] {blank} - a¦ Any Type @@ -2804,7 +2732,6 @@ A unique identifier for the response. [%hardbreaks] {blank} - a¦ UUID (UUID) @@ -2820,7 +2747,6 @@ The client context ID of the request, if one was supplied — see `client_co [%hardbreaks] {blank} - a¦ String @@ -2838,7 +2764,6 @@ Present only when the query completes successfully. [%hardbreaks] *Example:* `{"id":"json"}` {blank} - a¦ Object @@ -2855,7 +2780,6 @@ An object can be any JSON value. [%hardbreaks] {blank} - a¦ Any Type array @@ -2872,7 +2796,6 @@ The status of the request. [%hardbreaks] *Values:* `"success"`, `"running"`, `"errors"`, `"completed"`, `"stopped"`, `"timeout"`, `"fatal"` {blank} - a¦ String @@ -2889,7 +2812,6 @@ If an error occurred during processing of the request, it will be represented by [%hardbreaks] {blank} - a¦ xref:Conditions[] array @@ -2906,7 +2828,6 @@ If a warning occurred during processing of the request, it is represented by a w [%hardbreaks] {blank} - a¦ xref:Conditions[] array @@ -2922,7 +2843,6 @@ include::index.adoc[tag=desc-Metrics, opts=optional] [%hardbreaks] {blank} - a¦ xref:Metrics[] @@ -2938,7 +2858,6 @@ include::index.adoc[tag=desc-Controls, opts=optional] [%hardbreaks] {blank} - a¦ xref:Controls[] @@ -2954,7 +2873,6 @@ include::index.adoc[tag=desc-Profile, opts=optional] [%hardbreaks] {blank} - a¦ xref:Profile[] @@ -3017,7 +2935,6 @@ Number of input documents to the operator. [%hardbreaks] *Example:* `187` {blank} - a¦ Integer (int32) @@ -3034,7 +2951,6 @@ Number of output documents after the operator processing. [%hardbreaks] *Example:* `16` {blank} - a¦ Integer (int32) @@ -3051,7 +2967,6 @@ Number of switches between executing, waiting for services, or waiting for the g [%hardbreaks] *Example:* `413` {blank} - a¦ Integer (int32) @@ -3068,7 +2983,6 @@ Time spent executing the operator code inside SQL++ query engine. [%hardbreaks] *Example:* `+++"128.434µs"+++` {blank} - a¦ String (duration) @@ -3085,7 +2999,6 @@ Time spent waiting to be scheduled for CPU time. [%hardbreaks] *Example:* `+++"15.027879ms"+++` {blank} - a¦ String (duration) @@ -3106,7 +3019,6 @@ For fetch, it is time spent waiting on the KV store. [%hardbreaks] *Example:* `+++"1.590934ms"+++` {blank} - a¦ String (duration) diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index 837357ef..70574ce2 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -925,7 +925,6 @@ Setting this field to `true` enables access to all endpoints. [%hardbreaks] {blank} - a¦ Boolean @@ -948,7 +947,6 @@ Note that each URL must include the port, protocol, and all other components of [%hardbreaks] {blank} - a¦ String array @@ -970,7 +968,6 @@ Note that each URL must include the port, protocol, and all other components of [%hardbreaks] {blank} - a¦ String array @@ -1038,7 +1035,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} - a¦ Boolean @@ -1065,7 +1061,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} - a¦ Boolean @@ -1106,7 +1101,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `+++"60s"+++` *Example:* `+++"30s"+++` {blank} - a¦ String (duration) @@ -1140,7 +1134,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `4000` *Example:* `7000` {blank} - a¦ Integer (int32) @@ -1176,7 +1169,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `20840448` {blank} - a¦ Integer (int32) @@ -1211,7 +1203,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `1000` *Example:* `7000` {blank} - a¦ Integer (int32) @@ -1261,7 +1252,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `+++"INFO"+++` *Example:* `+++"DEBUG"+++` {blank} - a¦ String @@ -1306,7 +1296,6 @@ NOTE: To enable queries to run in parallel, you must specify the cluster-level ` *Default:* `1` *Example:* `0` {blank} - a¦ Integer (int32) @@ -1344,7 +1333,6 @@ If a request includes this parameter, it will be capped by the node-level `memor *Default:* `0` *Example:* `4` {blank} - a¦ Integer (int32) @@ -1370,7 +1358,6 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] {blank} - a¦ Integer (int32) @@ -1407,7 +1394,6 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} - a¦ Integer (int32) @@ -1436,7 +1422,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `100` {blank} - a¦ Integer (int32) @@ -1472,7 +1457,6 @@ If a request includes this parameter, it will be capped by the node-level `numat *Exclusive minimum:* `true` *Example:* `512` {blank} - a¦ Integer (int32) @@ -1505,7 +1489,6 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} - a¦ Integer (int32) @@ -1537,7 +1520,6 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. *Default:* `16` *Example:* `64` {blank} - a¦ Integer (int32) @@ -1569,7 +1551,6 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} - a¦ Integer (int32) @@ -1597,7 +1578,6 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `16384` *Example:* `65536` {blank} - a¦ Integer (int32) @@ -1633,7 +1613,6 @@ The minimum of that and the node-level `scan-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} - a¦ Integer (int32) @@ -1671,7 +1650,6 @@ The minimum of that and the node-level `timeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} - a¦ Long (int64) @@ -1722,7 +1700,6 @@ If a request includes this parameter, it will be capped by the node-level `txtim *Default:* `+++"0ms"+++` *Example:* `+++"0.5s"+++` {blank} - a¦ String (duration) @@ -1744,7 +1721,6 @@ The default path is `var/lib/couchbase/tmp` within the Couchbase Server installa [%hardbreaks] *Example:* `+++"/opt/couchbase/var/lib/couchbase/tmp"+++` {blank} - a¦ String @@ -1767,7 +1743,6 @@ The maximum size is limited only by the available disk space. *Default:* `5120` *Example:* `2048` {blank} - a¦ Integer (int32) @@ -1799,7 +1774,6 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `true` *Example:* `false` {blank} - a¦ Boolean @@ -1848,7 +1822,6 @@ If the request-level parameter and the node-level setting are both `unset`, read *Default:* `+++"unset"+++` *Example:* `+++"on"+++` {blank} - a¦ String @@ -1864,7 +1837,6 @@ include::index.adoc[tag=desc-Access, opts=optional] [%hardbreaks] {blank} - a¦ xref:Access[] From bac0ecefabf2baf7397992eccb27f72295b83b3f Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 10 Jul 2025 19:00:24 +0100 Subject: [PATCH 9/9] Check again