Skip to content

Commit 68626bd

Browse files
simon-dewdgnicholson
authored andcommitted
DOC-13542: Update Capella REST API builds for Morpheus
- [Template] Add tags to additional descriptions - Build output documentation - TEMP: Add preview config
1 parent 91d8e45 commit 68626bd

5 files changed

Lines changed: 135 additions & 0 deletions

File tree

docs/modules/n1ql-rest-admin/pages/index.adoc

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4988,9 +4988,11 @@ endif::alt-markdown-links[]
49884988
The opaque ID or context provided by the client.
49894989
If specified, all completed requests with this client context ID are logged.
49904990

4991+
// tag::desc-more[]
49914992
Refer to the [request-level][client_context_id] `client_context_id` parameter for more information.
49924993

49934994
[client_context_id]: ../n1ql-rest-query/index.html#client_context_id
4995+
// end::desc-more[]
49944996
--
49954997

49964998
[%hardbreaks]
@@ -5718,9 +5720,11 @@ ifdef::alt-markdown-links[]
57185720
endif::alt-markdown-links[]
57195721
The opaque ID or context provided by the client.
57205722

5723+
// tag::desc-more[]
57215724
Refer to the [request-level][client_context_id] `client_context_id` parameter for more information.
57225725

57235726
[client_context_id]: ../n1ql-rest-query/index.html#client_context_id
5727+
// end::desc-more[]
57245728
--
57255729

57265730
[%hardbreaks]
@@ -6202,10 +6206,12 @@ If any part of the path contains a special character, that part of the path must
62026206

62036207
[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries
62046208

6209+
// tag::desc-more[]
62056210
The [request-level][atrcollection_req] `atrcollection` parameter specifies this property per request.
62066211
If a request does not include this parameter, the node-level `atrcollection` setting will be used.
62076212

62086213
[atrcollection_req]: ../n1ql-rest-query/index.html#atrcollection_req
6214+
// end::desc-more[]
62096215
--
62106216

62116217
[%hardbreaks]
@@ -6249,10 +6255,12 @@ ifdef::alt-markdown-links[]
62496255
endif::alt-markdown-links[]
62506256
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.
62516257

6258+
// tag::desc-more[]
62526259
The [cluster-level][queryCleanupClientAttempts] `queryCleanupClientAttempts` setting specifies this property for the whole cluster.
62536260
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
62546261

62556262
[queryCleanupClientAttempts]: ../n1ql-rest-settings/index.html#queryCleanupClientAttempts
6263+
// end::desc-more[]
62566264
--
62576265

62586266
[%hardbreaks]
@@ -6275,10 +6283,12 @@ ifdef::alt-markdown-links[]
62756283
endif::alt-markdown-links[]
62766284
When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client.
62776285

6286+
// tag::desc-more[]
62786287
The [cluster-level][queryCleanupLostAttempts] `queryCleanupLostAttempts` setting specifies this property for the whole cluster.
62796288
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
62806289

62816290
[queryCleanupLostAttempts]: ../n1ql-rest-settings/index.html#queryCleanupLostAttempts
6291+
// end::desc-more[]
62826292
--
62836293

62846294
[%hardbreaks]
@@ -6315,10 +6325,12 @@ Valid units are:
63156325

63166326
[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries
63176327

6328+
// tag::desc-more[]
63186329
The [cluster-level][queryCleanupWindow] `queryCleanupWindow` setting specifies this property for the whole cluster.
63196330
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
63206331

63216332
[queryCleanupWindow]: ../n1ql-rest-settings/index.html#queryCleanupWindow
6333+
// end::desc-more[]
63226334
--
63236335

63246336
[%hardbreaks]
@@ -6363,10 +6375,12 @@ Refer to [Configure Completed Requests][sys-completed-config] for more informati
63636375

63646376
[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config
63656377

6378+
// tag::desc-more[]
63666379
The [cluster-level][queryCompletedLimit] `queryCompletedLimit` setting specifies this property for the whole cluster.
63676380
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
63686381

63696382
[queryCompletedLimit]: ../n1ql-rest-settings/index.html#queryCompletedLimit
6383+
// end::desc-more[]
63706384
--
63716385

63726386
[%hardbreaks]
@@ -6397,10 +6411,12 @@ Refer to [Configure Completed Requests][sys-completed-config] for more informati
63976411

63986412
[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config
63996413

6414+
// tag::desc-more[]
64006415
The [cluster-level][queryCompletedMaxPlanSize] `queryCompletedMaxPlanSize` setting specifies this property for the whole cluster.
64016416
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
64026417

64036418
[queryCompletedMaxPlanSize]: ../n1ql-rest-settings/index.html#queryCompletedMaxPlanSize
6419+
// end::desc-more[]
64046420
--
64056421

64066422
[%hardbreaks]
@@ -6456,10 +6472,12 @@ Refer to [Configure Completed Requests][sys-completed-config] for more informati
64566472

64576473
[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config
64586474

6475+
// tag::desc-more[]
64596476
The [cluster-level][queryCompletedThreshold] `queryCompletedThreshold` setting specifies this property for the whole cluster.
64606477
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
64616478

64626479
[queryCompletedThreshold]: ../n1ql-rest-settings/index.html#queryCompletedThreshold
6480+
// end::desc-more[]
64636481
--
64646482

64656483
[%hardbreaks]
@@ -6486,10 +6504,12 @@ When set to `true`, the query response document includes a controls section with
64866504

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

6507+
// tag::desc-more[]
64896508
The [request-level][controls_req] `controls` parameter specifies this property per request.
64906509
If a request does not include this parameter, the node-level `controls` setting will be used.
64916510

64926511
[controls_req]: ../n1ql-rest-query/index.html#controls_req
6512+
// end::desc-more[]
64936513
--
64946514

64956515
[%hardbreaks]
@@ -6628,10 +6648,12 @@ Major items, like crashes.
66286648

66296649
* `NONE` — Doesn't write anything.
66306650

6651+
// tag::desc-more[]
66316652
The [cluster-level][queryLogLevel] `queryLogLevel` setting specifies this property for the whole cluster.
66326653
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
66336654

66346655
[queryLogLevel]: ../n1ql-rest-settings/index.html#queryLogLevel
6656+
// end::desc-more[]
66356657
--
66366658

66376659
[%hardbreaks]
@@ -6682,6 +6704,7 @@ Refer to [Max Parallelism][max-parallelism] for more information.
66826704

66836705
[max-parallelism]: ../n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism
66846706

6707+
// tag::desc-more[]
66856708
The [cluster-level][queryMaxParallelism] `queryMaxParallelism` setting specifies this property for the whole cluster.
66866709
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
66876710

@@ -6692,6 +6715,7 @@ NOTE: To enable queries to run in parallel, you must specify the cluster-level `
66926715

66936716
[queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism
66946717
[max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req
6718+
// end::desc-more[]
66956719
--
66966720

66976721
[%hardbreaks]
@@ -6724,6 +6748,7 @@ It does not take into account any other memory that might be used to process a r
67246748
Within a transaction, this setting enforces the memory quota for the transaction by tracking the
67256749
delta table and the transaction log (approximately).
67266750

6751+
// tag::desc-more[]
67276752
The [cluster-level][queryMemoryQuota] `queryMemoryQuota` setting specifies this property for the whole cluster.
67286753
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
67296754

@@ -6732,6 +6757,7 @@ If a request includes this parameter, it will be capped by the node-level `memor
67326757

67336758
[queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota
67346759
[memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req
6760+
// end::desc-more[]
67356761
--
67366762

67376763
[%hardbreaks]
@@ -6794,10 +6820,12 @@ SQL++ feature control.
67946820
This setting is provided for technical support only.
67956821
The value may be an integer, or a string representing a hexadecimal number.
67966822

6823+
// tag::desc-more[]
67976824
The [cluster-level][queryN1QLFeatCtrl] `queryN1QLFeatCtrl` setting specifies this property for the whole cluster.
67986825
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
67996826

68006827
[queryN1QLFeatCtrl]: ../n1ql-rest-settings/index.html#queryN1QLFeatCtrl
6828+
// end::desc-more[]
68016829
--
68026830

68036831
[%hardbreaks]
@@ -6831,10 +6859,12 @@ To do this, the Query service calculates the difference between the total system
68316859

68326860
- If the difference is 8 GiB or less, the default soft memory limit is set to 90% of the total system RAM.
68336861

6862+
// tag::desc-more[]
68346863
The [cluster-level][queryNodeQuota] `queryNodeQuota` setting specifies this property for the whole cluster.
68356864
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
68366865

68376866
[queryNodeQuota]: ../n1ql-rest-settings/index.html#queryNodeQuota
6867+
// end::desc-more[]
68386868
--
68396869

68406870
[%hardbreaks]
@@ -6857,10 +6887,12 @@ endif::alt-markdown-links[]
68576887
The percentage of the `node-quota` that is dedicated to tracked value content memory across all active requests on this node.
68586888
(The `memory-quota` setting specifies the maximum amount of document memory an individual request may use on this node.)
68596889

6890+
// tag::desc-more[]
68606891
The [cluster-level][queryNodeQuotaValPercent] `queryNodeQuotaValPercent` setting specifies this property for the whole cluster.
68616892
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
68626893

68636894
[queryNodeQuotaValPercent]: ../n1ql-rest-settings/index.html#queryNodeQuotaValPercent
6895+
// end::desc-more[]
68646896
--
68656897

68666898
[%hardbreaks]
@@ -6891,10 +6923,12 @@ The number of CPUs can never be greater than the number of logical CPUs.
68916923
In Community Edition, the number of allowed CPUs cannot be greater than 4.
68926924
In Enterprise Edition, there is no limit to the number of allowed CPUs.
68936925

6926+
// tag::desc-more[]
68946927
The [cluster-level][queryNumCpus] `queryNumCpus` setting specifies this property for the whole cluster.
68956928
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
68966929

68976930
[queryNumCpus]: ../n1ql-rest-settings/index.html#queryNumCpus
6931+
// end::desc-more[]
68986932
--
68996933

69006934
[%hardbreaks]
@@ -6919,6 +6953,7 @@ Specifies the total number of [active transaction records][additional-storage-us
69196953

69206954
[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries
69216955

6956+
// tag::desc-more[]
69226957
The [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies this property for the whole cluster.
69236958
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
69246959

@@ -6927,6 +6962,7 @@ The minimum of that and the node-level `numatrs` setting is applied.
69276962

69286963
[queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs
69296964
[numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req
6965+
// end::desc-more[]
69306966
--
69316967

69326968
[%hardbreaks]
@@ -6948,6 +6984,7 @@ ifdef::alt-markdown-links[]
69486984
endif::alt-markdown-links[]
69496985
Controls the number of items execution operators can batch for Fetch from the KV.
69506986

6987+
// tag::desc-more[]
69516988
The [cluster-level][queryPipelineBatch] `queryPipelineBatch` setting specifies this property for the whole cluster.
69526989
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
69536990

@@ -6956,6 +6993,7 @@ The minimum of that and the node-level `pipeline-batch` setting is applied.
69566993

69576994
[queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch
69586995
[pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req
6996+
// end::desc-more[]
69596997
--
69606998

69616999
[%hardbreaks]
@@ -6979,6 +7017,7 @@ ifdef::alt-markdown-links[]
69797017
endif::alt-markdown-links[]
69807018
Maximum number of items each execution operator can buffer between various operators.
69817019

7020+
// tag::desc-more[]
69827021
The [cluster-level][queryPipelineCap] `queryPipelineCap` setting specifies this property for the whole cluster.
69837022
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
69847023

@@ -6987,6 +7026,7 @@ The minimum of that and the node-level `pipeline-cap` setting is applied.
69877026

69887027
[queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap
69897028
[pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req
7029+
// end::desc-more[]
69907030
--
69917031

69927032
[%hardbreaks]
@@ -7027,10 +7067,12 @@ endif::alt-markdown-links[]
70277067
Maximum number of prepared statements in the cache.
70287068
When this cache reaches the limit, the least recently used prepared statements will be discarded as new prepared statements are created.
70297069

7070+
// tag::desc-more[]
70307071
The [cluster-level][queryPreparedLimit] `queryPreparedLimit` setting specifies this property for the whole cluster.
70317072
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
70327073

70337074
[queryPreparedLimit]: ../n1ql-rest-settings/index.html#queryPreparedLimit
7075+
// end::desc-more[]
70347076
--
70357077

70367078
[%hardbreaks]
@@ -7053,10 +7095,12 @@ ifdef::alt-markdown-links[]
70537095
endif::alt-markdown-links[]
70547096
Specifies whether query results are returned in pretty format.
70557097

7098+
// tag::desc-more[]
70567099
The [request-level][pretty_req] `pretty` parameter specifies this property per request.
70577100
If a request does not include this parameter, the node-level setting is used, which defaults to `false`.
70587101

70597102
[pretty_req]: ../n1ql-rest-query/index.html#pretty_req
7103+
// end::desc-more[]
70607104
--
70617105

70627106
[%hardbreaks]
@@ -7094,10 +7138,12 @@ Refer to [Monitoring and Profiling Details][monitor-profile-details] for more in
70947138

70957139
[monitor-profile-details]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#monitor-profile-details
70967140

7141+
// tag::desc-more[]
70977142
The [request-level][profile_req] `profile` parameter specifies this property per request.
70987143
If a request does not include this parameter, the node-level `profile` setting will be used.
70997144

71007145
[profile_req]: ../n1ql-rest-query/index.html#profile_req
7146+
// end::desc-more[]
71017147
--
71027148

71037149
[%hardbreaks]
@@ -7143,6 +7189,7 @@ This parameter controls when to use scan backfill.
71437189
Use `0` or a negative number to disable.
71447190
Smaller values reduce GC, while larger values reduce indexer backfill.
71457191

7192+
// tag::desc-more[]
71467193
The [cluster-level][queryScanCap] `queryScanCap` setting specifies this property for the whole cluster.
71477194
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
71487195

@@ -7151,6 +7198,7 @@ The minimum of that and the node-level `scan-cap` setting is applied.
71517198

71527199
[queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap
71537200
[scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req
7201+
// end::desc-more[]
71547202
--
71557203

71567204
[%hardbreaks]
@@ -7198,6 +7246,7 @@ It must not be delimited by quotes, and must not include a unit.
71987246
Specify `0` (the default value) or a negative integer to disable.
71997247
When disabled, no timeout is applied and the request runs for however long it takes.
72007248

7249+
// tag::desc-more[]
72017250
The [cluster-level][queryTimeout] `queryTimeout` setting specifies this property for the whole cluster.
72027251
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
72037252

@@ -7206,6 +7255,7 @@ The minimum of that and the node-level `timeout` setting is applied.
72067255

72077256
[queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout
72087257
[timeout_req]: ../n1ql-rest-query/index.html#timeout_req
7258+
// end::desc-more[]
72097259
--
72107260

72117261
[%hardbreaks]
@@ -7240,6 +7290,7 @@ When disabled, no timeout is applied and the transaction runs for however long i
72407290

72417291
[tximplicit]: ../n1ql-rest-query/index.html#tximplicit
72427292

7293+
// tag::desc-more[]
72437294
The [cluster-level][queryTxTimeout] `queryTxTimeout` setting specifies this property for the whole cluster.
72447295
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
72457296

@@ -7248,6 +7299,7 @@ The minimum of that and the node-level `txtimeout` setting is applied.
72487299

72497300
[queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout
72507301
[txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req
7302+
// end::desc-more[]
72517303
--
72527304

72537305
[%hardbreaks]
@@ -7271,6 +7323,7 @@ ifdef::alt-markdown-links[]
72717323
endif::alt-markdown-links[]
72727324
Specifies whether the cost-based optimizer is enabled.
72737325

7326+
// tag::desc-more[]
72747327
The [cluster-level][queryUseCBO] `queryUseCBO` setting specifies this property for the whole cluster.
72757328
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
72767329

@@ -7279,6 +7332,7 @@ If a request does not include this parameter, the node-level setting is used, wh
72797332

72807333
[queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO
72817334
[use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req
7335+
// end::desc-more[]
72827336
--
72837337

72847338
[%hardbreaks]
@@ -7317,6 +7371,7 @@ Reading from replica is only possible if the cluster uses Couchbase Server 7.6.0
73177371
Note that KV range scans cannot currently be started on a replica vBucket.
73187372
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.
73197373

7374+
// tag::desc-more[]
73207375
The [cluster-level][queryUseReplica] `queryUseReplica` setting specifies the default for this property for the whole cluster.
73217376
When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster.
73227377

@@ -7326,6 +7381,7 @@ If the request-level parameter and the node-level setting are both `unset`, read
73267381

73277382
[queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica
73287383
[use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req
7384+
// end::desc-more[]
73297385
--
73307386

73317387
[%hardbreaks]

0 commit comments

Comments
 (0)