diff --git a/modules/fts/pages/fts-advanced-settings-bleveMaxClauseCount.adoc b/modules/fts/pages/fts-advanced-settings-bleveMaxClauseCount.adoc index 5a3ddda970..935594fe83 100644 --- a/modules/fts/pages/fts-advanced-settings-bleveMaxClauseCount.adoc +++ b/modules/fts/pages/fts-advanced-settings-bleveMaxClauseCount.adoc @@ -6,7 +6,9 @@ Using this setting, users can restrict resource utilization, especially the memo The default value of the `bleveMaxClauseCount` setting is *1024*. -The default limit might not be sufficient for queries like wildcard, regex, prefix, disjuncts, fuzzy, etc. So, users can fix the issue by specifying a higher value for the `bleveMaxClauseCount` setting. However, users must check the query patterns to make them more efficient and well-scoped. +The default limit might not be sufficient for queries like wildcard, regular expression, prefix, disjuncts, fuzzy, etc. +Users can fix the issue by specifying a higher value for the `bleveMaxClauseCount` setting. +However, users must check the query patterns to make them more efficient and well-scoped. == Example @@ -15,4 +17,6 @@ The default limit might not be sufficient for queries like wildcard, regex, pref curl -XPUT -H "Content-type:application/json" http://username:password@:8094/api/managerOptions \-d '{ "bleveMaxClauseCount": "10000" } ----- \ No newline at end of file +---- + +include::partial$get-cluster-level-options.adoc[] \ No newline at end of file diff --git a/modules/fts/pages/fts-advanced-settings-bleveMaxResultWindow.adoc b/modules/fts/pages/fts-advanced-settings-bleveMaxResultWindow.adoc index 8e65b4128e..f0466897ef 100644 --- a/modules/fts/pages/fts-advanced-settings-bleveMaxResultWindow.adoc +++ b/modules/fts/pages/fts-advanced-settings-bleveMaxResultWindow.adoc @@ -1,8 +1,9 @@ = bleveMaxResultWindow -The default value of the `bleveMaxResultWindow` setting is *10000*. However, users can change this value if they want to view more records in the result. +The default value of the `bleveMaxResultWindow` setting is *10000*. +However, users can change this value if they want to view more records in the result. -The `bleveMaxResultWindow` setting controls the maximum number of results a query can obtain, which helps limit the max results, thereby limiting the resource usage. It may also increase. +The `bleveMaxResultWindow` setting controls the maximum number of results a query can obtain, which helps limit the max results, thereby limiting the resource usage. == Example @@ -11,4 +12,6 @@ The `bleveMaxResultWindow` setting controls the maximum number of results a quer curl -XPUT -H "Content-type:application/json" http://username:password@:8094/api/managerOptions \-d '{ "bleveMaxResultWindow": "10000" } ----- \ No newline at end of file +---- + +include::partial$get-cluster-level-options.adoc[] \ No newline at end of file diff --git a/modules/fts/pages/fts-advanced-settings-maxReplicasAllowed.adoc b/modules/fts/pages/fts-advanced-settings-maxReplicasAllowed.adoc index 0159539992..dc4a7ddcfc 100644 --- a/modules/fts/pages/fts-advanced-settings-maxReplicasAllowed.adoc +++ b/modules/fts/pages/fts-advanced-settings-maxReplicasAllowed.adoc @@ -11,4 +11,6 @@ The default limit value of this is *3*. curl -XPUT -H "Content-type:application/json" http://username:password@:8094/api/managerOptions \-d '{ "maxReplicasAllowed": "2" } ----- \ No newline at end of file +---- + +include::partial$get-cluster-level-options.adoc[] \ No newline at end of file diff --git a/modules/fts/pages/fts-cluster-options.adoc b/modules/fts/pages/fts-cluster-options.adoc index c3f5b63696..0ce1d754bb 100644 --- a/modules/fts/pages/fts-cluster-options.adoc +++ b/modules/fts/pages/fts-cluster-options.adoc @@ -2,6 +2,8 @@ The following operations are for setting cluster-level options. +== Setting Cluster Level Options + * xref:fts-advanced-settings-bleveMaxResultWindow.adoc[bleveMaxResultWindow] * xref:fts-advanced-settings-bleveMaxClauseCount.adoc[bleveMaxClauseCount] * xref:fts-advanced-settings-maxFeedsPerDCPAgent.adoc[maxFeedsPerDCPAgent] @@ -12,3 +14,34 @@ The following operations are for setting cluster-level options. * xref:fts-advanced-settings-maxReplicasAllowed.adoc[maxReplicasAllowed] * xref:fts-advanced-settings-slowQueryLogTimeout.adoc[slowQueryLogTimeout] * xref:fts-advanced-settings-CBFT-ENV-OPTIONS.adoc[CBFT_ENV_OPTIONS] + +[#getting-cluster-level-options] +== Getting Cluster Level Options + +You can retrieve the current cluster settings for the following options: + +* `bleveMaxResultWindow` +* `bleveMaxClauseCount` +* `maxReplicasAllowed` + +Use the following CURL command to retrieve the parameters. + +include::partial$get-cluster-level-options.adoc[tag=source-get-cluster-options] + +This returns a JSON object containing the option parameters: + +[source,json] +---- +{ + "status": "ok", + "maxReplicasAllowed": 3, + "bucketTypesAllowed": "membase:ephemeral", + "collectionsSupport": true, + "bleveMaxResultWindow": 10000, + "bleveMaxClauseCount": 10000, + "deploymentModel": "default", + "scopedIndexesSupport": true +} +---- + + diff --git a/modules/fts/partials/get-cluster-level-options.adoc b/modules/fts/partials/get-cluster-level-options.adoc new file mode 100644 index 0000000000..876ec043fb --- /dev/null +++ b/modules/fts/partials/get-cluster-level-options.adoc @@ -0,0 +1,12 @@ +[NOTE] +==== +Use the following CURL command to retrieve the current setting for this option: + +// tag::source-get-cluster-options[] +[source,shell, subs="+quotes"] +---- +curl -u : https://##:18094/api/conciseOptions +---- +// end::source-get-cluster-options[] + +==== \ No newline at end of file