Skip to content

DOC-8634: numatrs should not be a request level parameter #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simon-dew merged 5 commits into from
Dec 9, 2025
Merged

DOC-8634: numatrs should not be a request level parameter #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cc2e208
Update numatrs request-level parameter
simon-dew Dec 9, 2025
7766224
Update output documentation.
simon-dew Dec 9, 2025
e4029e0
Remove link to numatrs request-level parameter in Admin
simon-dew Dec 9, 2025
16353c5
Remove link to numatrs request-level parameter in Settings
simon-dew Dec 9, 2025
4e2fef0
Wording tweak
simon-dew Dec 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions docs/modules/n1ql/partials/n1ql-rest-api/admin/definitions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -709,10 +709,7 @@ __optional__|[[numatrs-srv]]
Specifies the total number of xref:learn:data/transactions.adoc#additional-storage-use[active transaction records].

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

In addition, the {numatrs_req}[request-level] `numatrs` parameter specifies this property per request.
The minimum of that and the node-level `numatrs` setting is applied.|string
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.|string
|**pipeline-batch** +
__optional__|[[pipeline-batch-srv]]
Controls the number of items execution operators can batch for Fetch from the KV.
Expand Down
12 changes: 2 additions & 10 deletions docs/modules/n1ql/partials/n1ql-rest-api/query/definitions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,16 +229,8 @@ __optional__|[[namespace]] Specifies the namespace to use. Currently, only the `
**Example** : `"default"`|string
|**numatrs** +
__optional__|[[numatrs_req]]
Specifies the total number of {transactions-understanding-transactions}[active transaction records].
Must be a positive integer.

The {numatrs-srv}[node-level] `numatrs` setting specifies the default for this parameter for a single node.
The request-level parameter overrides the node-level setting.

In addition, the {queryNumAtrs}[cluster-level] `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. +
**Default** : `1024` +
**Example** : `512`|integer (int32)
Reserved for future use.
This parameter is ignored and has no effect.|integer (int32)
|**pipeline_batch** +
__optional__|[[pipeline_batch_req]]
Controls the number of items execution operators can batch for Fetch from the KV.
Expand Down
5 changes: 1 addition & 4 deletions docs/modules/rest-api/partials/query-settings/definitions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,10 +204,7 @@ __optional__|[[queryNumAtrs]]
Specifies the total number of xref:learn:data/transactions.adoc#additional-storage-use[active transaction records] for all Query nodes in the cluster.

The {numatrs-srv}[node-level] `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 {numatrs_req}[request-level] `numatrs` parameter.
If a request includes this parameter, it will be capped by the node-level `numatrs` setting. +
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. +
**Default** : `1024` +
**Minimum value (exclusive)** : `0` +
**Example** : `512`|integer (int32)
Expand Down
3 changes: 0 additions & 3 deletions src/admin/swagger/admin.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1452,9 +1452,6 @@ definitions:

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

In addition, the {numatrs_req}[request-level] `numatrs` parameter specifies this property per request.
The minimum of that and the node-level `numatrs` setting is applied.
n1ql-feat-ctrl:
type: integer
format: int32
Expand Down
12 changes: 2 additions & 10 deletions src/query-service/swagger/query-service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,16 +402,8 @@ definitions:
format: int32
description: |
[[numatrs_req]]
Specifies the total number of {transactions-understanding-transactions}[active transaction records].
Must be a positive integer.

The {numatrs-srv}[node-level] `numatrs` setting specifies the default for this parameter for a single node.
The request-level parameter overrides the node-level setting.

In addition, the {queryNumAtrs}[cluster-level] `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.
default: 1024
example: 512
Reserved for future use.
This parameter is ignored and has no effect.
pipeline_batch:
type: integer
format: int32
Expand Down
3 changes: 0 additions & 3 deletions src/query-settings/swagger/query-settings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,9 +274,6 @@ definitions:

The {numatrs-srv}[node-level] `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 {numatrs_req}[request-level] `numatrs` parameter.
If a request includes this parameter, it will be capped by the node-level `numatrs` setting.
queryPipelineBatch:
type: integer
format: int32
Expand Down
Loading