Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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@<ip>:8094/api/managerOptions \-d '{
"bleveMaxClauseCount": "10000"
}
----
----

include::partial$get-cluster-level-options.adoc[]
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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@<ip>:8094/api/managerOptions \-d '{
"bleveMaxResultWindow": "10000"
}
----
----

include::partial$get-cluster-level-options.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ The default limit value of this is *3*.
curl -XPUT -H "Content-type:application/json" http://username:password@<ip>:8094/api/managerOptions \-d '{
"maxReplicasAllowed": "2"
}
----
----

include::partial$get-cluster-level-options.adoc[]
33 changes: 33 additions & 0 deletions modules/fts/pages/fts-cluster-options.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
}
----


12 changes: 12 additions & 0 deletions modules/fts/partials/get-cluster-level-options.adoc
Original file line number Diff line number Diff line change
@@ -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 <user>:<password> https://#<node>#:18094/api/conciseOptions
----
// end::source-get-cluster-options[]

====
Loading