Skip to content

Commit b1d1631

Browse files
committed
Update the setting defaults in sql plugin
Signed-off-by: Lantao Jin <[email protected]>
1 parent 38ed6ec commit b1d1631

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

_search-plugins/sql/settings.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,18 +72,30 @@ Requests to the `_plugins/_ppl` and `_plugins/_sql` endpoints include index name
7272

7373
Setting | Default | Description
7474
:--- | :--- | :---
75-
`plugins.sql.enabled` | True | Change to `false` to disable the `SQL` support in the plugin.
76-
`plugins.ppl.enabled` | True | Change to `false` to disable the `PPL` support in the plugin.
77-
`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`.
78-
`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.
75+
`plugins.sql.enabled` | true | Change to `false` to disable the `SQL` support in the plugin.
76+
`plugins.ppl.enabled` | true | Change to `false` to disable the `PPL` support in the plugin.
77+
`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`.
78+
`plugins.sql.cursor.keep_alive` | 1m | Configures how long the cursor context is kept open. Cursor contexts are resource-intensive, so we recommend a low value.
7979
`plugins.query.memory_limit` | 85% | Configures the heap memory usage limit for the circuit breaker of the query engine.
80-
`plugins.query.size_limit` | 10000 | Sets the default size of index that the query engine fetches from OpenSearch.
80+
`plugins.query.size_limit` | 10000 | Sets the maximum amount of rows returned from a query execution results.
8181
`plugins.query.datasources.enabled` | true | Change to `false` to disable support for data sources in the plugin.
8282
`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`.
83+
`plugins.query.buckets` | 10000 | Sets how many aggregation buckets will return in a single response. The default value equals to `plugins.query.size_limit`.
8384
`plugins.calcite.enabled` | true | Enables the Apache Calcite query engine, including advanced SQL and PPL capabilities such as subsearches, joins, and lookup operations.
85+
`plugins.calcite.pushdown.enabled` | true | Change to `false` to disable the operator pushdown optimization. We recommend using the default value.
86+
`plugins.calcite.fallback.allowed` | false | Change to `true` to allow fallback to v2 engine.
87+
`plugins.calcite.pushdown.rowcount.estimation.factor` | 0.9 | The value is a factor to multiply the row count of the table scan to get the estimated row count. We recommend using the default value.
8488
`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.
8589
`plugins.ppl.syntax.legacy.preferred` | true | Controls certain PPL syntax behaviors, including default argument values. When `false`, uses newer syntax standards.
8690
`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.
91+
`plugins.ppl.rex.max_match.limit` | 10 | Maximum number of matches to extract in `rex` command.
92+
`plugins.ppl.subsearch.maxout` | 10000 | Sets the maximum of rows to return from subsearch.
93+
`plugins.ppl.join.subsearch_maxout` | 50000 | Sets the maximum of rows from subsearch to join against.
94+
`plugins.ppl.pattern.method` | "simple_pattern" | Sets the default patterns method. Another supported method is "brain".
95+
`plugins.ppl.pattern.mode` | "label" | Sets the default patterns mode. Another supported mode is "aggregation".
96+
`plugins.ppl.pattern.max.sample.count` | 10 | Sets the default max sample logs returned per pattern in aggregation mode.
97+
`plugins.ppl.pattern.buffer.limit` | 100000 | Sets the default size of internal temporary buffer used in "brain" algorithm.
98+
`plugins.ppl.pattern.show.numbered.token` | false | Change to `true` to turn on numbered token output format.
8799

88100
## Spark connector settings
89101

0 commit comments

Comments
 (0)