Skip to content
Open
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
98 changes: 97 additions & 1 deletion docs/user/admin/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ When OpenSearch bootstraps, SQL plugin will register a few settings in OpenSearc
plugins.sql.enabled
======================

Version
-------
1.0

Description
-----------

Expand Down Expand Up @@ -81,6 +85,10 @@ Result set::
plugins.sql.slowlog
============================

Version
-------
1.0

Description
-----------

Expand Down Expand Up @@ -121,6 +129,10 @@ Result set::
plugins.sql.cursor.keep_alive
================================

Version
-------
1.0

Description
-----------

Expand Down Expand Up @@ -163,6 +175,10 @@ Result set::
plugins.query.size_limit
========================

Version
-------
1.0

Description
-----------

Expand Down Expand Up @@ -193,7 +209,7 @@ plugins.query.buckets

Version
-------
3.4.0
3.4

Description
-----------
Expand Down Expand Up @@ -228,6 +244,10 @@ The number of aggregation buckets is fixed to ``1000`` in v2. ``plugins.query.bu
plugins.query.memory_limit
==========================

Version
-------
1.0

Description
-----------

Expand Down Expand Up @@ -256,6 +276,10 @@ Result set::
Thread Pool Settings
====================

Version
-------
3.4

The SQL plugin is integrated with the `OpenSearch Thread Pool Settings <https://docs.opensearch.org/latest/install-and-configure/configuring-opensearch/thread-pool-settings/>`_.
There are two thread pools which can be configured on cluster setup via `settings.yml`::

Expand All @@ -277,6 +301,10 @@ A ``sql-worker`` thread may spawn multiple background threads.
plugins.query.executionengine.spark.session.limit
==================================================

Version
-------
2.12

Description
-----------

Expand Down Expand Up @@ -314,6 +342,10 @@ SQL query::
plugins.query.executionengine.spark.refresh_job.limit
=====================================================

Version
-------
2.12

Description
-----------

Expand Down Expand Up @@ -351,6 +383,10 @@ SQL query::
plugins.query.datasources.limit
===============================

Version
-------
2.12

Description
-----------

Expand Down Expand Up @@ -384,6 +420,10 @@ SQL query::
plugins.query.executionengine.spark.session_inactivity_timeout_millis
=====================================================================

Version
-------
2.12

Description
-----------

Expand Down Expand Up @@ -420,6 +460,10 @@ SQL query::
plugins.query.executionengine.spark.auto_index_management.enabled
=================================================================

Version
-------
2.12

Description
-----------
This setting controls the automatic management of request and result indices for each data source. When enabled, it
Expand Down Expand Up @@ -456,6 +500,10 @@ SQL query::
plugins.query.executionengine.spark.session.index.ttl
=====================================================

Version
-------
2.12

Description
-----------
This setting defines the time-to-live (TTL) for request indices when plugins.query.executionengine.spark.auto_index_management.enabled
Expand Down Expand Up @@ -493,6 +541,10 @@ SQL query::
plugins.query.executionengine.spark.result.index.ttl
====================================================

Version
-------
2.12

Description
-----------
This setting specifies the TTL for result indices when plugins.query.executionengine.spark.auto_index_management.enabled
Expand Down Expand Up @@ -529,6 +581,10 @@ SQL query::
plugins.query.executionengine.async_query.enabled
=================================================

Version
-------
2.12

Description
-----------
You can disable submit async query to reject all coming requests.
Expand Down Expand Up @@ -560,6 +616,10 @@ Request::
plugins.query.executionengine.async_query.external_scheduler.enabled
=====================================================================

Version
-------
2.17

Description
-----------
This setting controls whether the external scheduler is enabled for async queries.
Expand Down Expand Up @@ -595,6 +655,10 @@ Request ::
plugins.query.executionengine.async_query.external_scheduler.interval
=====================================================================

Version
-------
2.17

Description
-----------
This setting defines the interval at which the external scheduler applies for auto refresh queries. It optimizes Spark applications by allowing them to automatically decide whether to use the Spark scheduler or the external scheduler.
Expand Down Expand Up @@ -629,6 +693,10 @@ Request ::
plugins.query.executionengine.spark.streamingjobs.housekeeper.interval
======================================================================

Version
-------
2.13

Description
-----------
This setting specifies the interval at which the streaming job housekeeper runs to clean up streaming jobs associated with deleted and disabled data sources.
Expand Down Expand Up @@ -665,6 +733,10 @@ Request ::
plugins.query.datasources.enabled
=================================

Version
-------
2.16

Description
-----------

Expand Down Expand Up @@ -745,6 +817,10 @@ To Re-enable Data Sources:::
plugins.query.field_type_tolerance
==================================

Version
-------
2.19

Description
-----------

Expand Down Expand Up @@ -804,6 +880,10 @@ first element of an array is returned, preserving the default behavior.
plugins.calcite.enabled
=======================

Version
-------
3.0

Description
-----------

Expand All @@ -820,6 +900,10 @@ Check `join doc <../../ppl/cmd/join.rst>`_ for example.
plugins.calcite.fallback.allowed
================================

Version
-------
3.1

Description
-----------

Expand All @@ -832,6 +916,10 @@ If Calcite is enabled, you can use this setting to decide whether to allow fallb
plugins.calcite.pushdown.enabled
================================

Version
-------
3.1

Description
-----------

Expand All @@ -844,6 +932,10 @@ If Calcite is enabled, you can use this setting to decide whether to enable the
plugins.calcite.pushdown.rowcount.estimation.factor
===================================================

Version
-------
3.1

Description
-----------

Expand All @@ -856,6 +948,10 @@ If Calcite pushdown optimization is enabled, this setting is used to estimate th
plugins.calcite.all_join_types.allowed
======================================

Version
-------
3.3

Description
-----------

Expand Down
Loading
Loading