Update the setting defaults in sql plugin (#11598)

* Update the setting defaults in sql plugin

Signed-off-by: Lantao Jin <[email protected]>

* Doc review

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Revert "Doc review"

This reverts commit b7fa236.

Signed-off-by: Lantao Jin <[email protected]>

* add a new config plugins.ppl.query.timeout

Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Update _search-plugins/sql/settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>

* Apply suggestions from code review

Signed-off-by: Nathan Bower <[email protected]>

---------

Signed-off-by: Lantao Jin <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>
Signed-off-by: Nathan Bower <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>

Author: 3 people

_search-plugins/sql/settings.md

@@ -72,18 +72,31 @@ Requests to the `_plugins/_ppl` and `_plugins/_sql` endpoints include index name
 
 Setting | Default | Description
 :--- | :--- | :---
-`plugins.sql.enabled` | True | Change to `false` to disable the `SQL` support in the plugin.
-`plugins.ppl.enabled` | True | Change to `false` to disable the `PPL` support in the plugin.
-`plugins.sql.slowlog` | 2 seconds | Configures the time limit (in seconds) for slow queries. The plugin logs slow queries as `Slow query: elapsed=xxx (ms)` in `opensearch.log`.
-`plugins.sql.cursor.keep_alive` | 1 minute | Configures how long the cursor context is kept open. Cursor contexts are resource-intensive, so we recommend a low value.
-`plugins.query.memory_limit` | 85% | Configures the heap memory usage limit for the circuit breaker of the query engine.
-`plugins.query.size_limit` | 10000 | Sets the default size of index that the query engine fetches from OpenSearch.
-`plugins.query.datasources.enabled` | true | Change to `false` to disable support for data sources in the plugin.
-`plugins.query.field_type_tolerance` | true | If `false`, then an array is reduced to the first non-array value at any nesting level. For example, `[[1, 2], [3, 4]]` will be reduced to `1`. If `true`, then the array is preserved. Default is `true`.
-`plugins.calcite.enabled` | true | Enables the Apache Calcite query engine, including advanced SQL and PPL capabilities such as subsearches, joins, and lookup operations.
-`plugins.calcite.all_join_types.allowed` | false | Enables performance-sensitive join types, like `RIGHT`, `FULL`, and `CROSS` joins. Change to `true` to allow these join operations.
-`plugins.ppl.syntax.legacy.preferred` | true | Controls certain PPL syntax behaviors, including default argument values. When `false`, uses newer syntax standards.
-`plugins.ppl.values.max.limit` | 0 | Sets the maximum number of unique values that the `VALUES` aggregation function can return. A value of `0` indicates no limit.
+`plugins.sql.enabled` | `true` | Change to `false` to disable the `SQL` support in the plugin.
+`plugins.ppl.enabled` | `true` | Change to `false` to disable the `PPL` support in the plugin.
+`plugins.sql.slowlog` | `2` | Configures the time limit (in seconds) for slow queries. The plugin logs slow queries as `Slow query: elapsed=xxx (ms)` in `opensearch.log`.
+`plugins.sql.cursor.keep_alive` | `1m` | Configures the amount of time that the cursor context remains open. Because cursor contexts are resource intensive, we recommend a low value.
+`plugins.query.memory_limit` | `85%` | Configures the heap memory usage limit for the query engine's circuit breaker.
+`plugins.query.size_limit` | `10000` | Sets the maximum number of rows returned from a query execution.
+`plugins.query.datasources.enabled` | `true` | Change to `false` to disable support for data sources in the plugin.
+`plugins.query.field_type_tolerance` | `true` | If `false`, then an array is reduced to the first non-array value at any nesting level. For example, `[[1, 2], [3, 4]]` is reduced to `1`. If `true`, then the array is preserved. Default is `true`.
+`plugins.query.buckets` | `10000` | Sets the number of aggregation buckets returned in a single response. Default is the `plugins.query.size_limit` value.
+`plugins.calcite.enabled` | `true` | Enables the Apache Calcite query engine, including advanced SQL and PPL capabilities such as subsearch, `join`, and `lookup` operations.
+`plugins.calcite.pushdown.enabled` | `true` | Change to `false` to disable the operator push-down optimization. We recommend using the default value.
+`plugins.calcite.fallback.allowed` | `false` | Change to `true` to allow fallback to the v2 engine.
+`plugins.calcite.pushdown.rowcount.estimation.factor` | `0.9` | A factor used to multiply the row count of a table scan to estimate the resulting row count. We recommend using the default value.
+`plugins.calcite.all_join_types.allowed` | `false` | Enables performance-sensitive join types, such as `RIGHT`, `FULL`, and `CROSS` joins. Change to `true` to allow these join operations.
+`plugins.ppl.syntax.legacy.preferred` | `true` | Controls PPL syntax behaviors, including default argument values. When `false`, uses newer syntax standards. For more information, see the [legacy syntax documentation](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/admin/settings.rst#plugins-ppl-syntax-legacy-preferred).
+`plugins.ppl.values.max.limit` | `0` | Sets the maximum number of unique values that the `VALUES` aggregation function can return. A value of `0` indicates no limit.
+`plugins.ppl.rex.max_match.limit` | `10` | Sets the maximum number of matches extracted by the `rex` command.
+`plugins.ppl.subsearch.maxout` | `10000` | Sets the maximum number of rows to return from a subsearch.
+`plugins.ppl.join.subsearch_maxout` | `50000` | Sets the maximum number of rows to return from a subsearch used in a join operation.
+`plugins.ppl.pattern.method` | `simple_pattern` | Sets the method for the `patterns` command. Valid values are `simple_pattern` and `brain`. For more information, see [`patterns` syntax](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/patterns.rst#syntax).
+`plugins.ppl.pattern.mode` | `label` | Sets the mode for the `patterns` command. Valid values are `label` and `aggregation`. For more information, see [`patterns` syntax](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/patterns.rst#syntax).
+`plugins.ppl.pattern.max.sample.count` | `10` | Sets the maximum number of sample logs returned per pattern in aggregation mode.
+`plugins.ppl.pattern.buffer.limit` | `100000` | Sets the size of the internal temporary buffer used by the `brain` algorithm.
+`plugins.ppl.pattern.show.numbered.token` | `false` | Change to `true` to enable the numbered token output format.
+`plugins.ppl.query.timeout` | `5m` | Configures the maximum amount of time that a PPL query can run. If a query exceeds this limit, execution stops and returns a timeout error.
 
 ## Spark connector settings