Skip to content

Commit 66529d9

Browse files
authored
Add version numbers for all settings in the docs (#5019)
1 parent 3f646d5 commit 66529d9

2 files changed

Lines changed: 148 additions & 19 deletions

File tree

docs/user/admin/settings.rst

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ When OpenSearch bootstraps, SQL plugin will register a few settings in OpenSearc
1919
plugins.sql.enabled
2020
======================
2121

22+
Version
23+
-------
24+
1.0
25+
2226
Description
2327
-----------
2428

@@ -81,6 +85,10 @@ Result set::
8185
plugins.sql.slowlog
8286
============================
8387

88+
Version
89+
-------
90+
1.0
91+
8492
Description
8593
-----------
8694

@@ -121,6 +129,10 @@ Result set::
121129
plugins.sql.cursor.keep_alive
122130
================================
123131

132+
Version
133+
-------
134+
1.0
135+
124136
Description
125137
-----------
126138

@@ -163,6 +175,10 @@ Result set::
163175
plugins.query.size_limit
164176
========================
165177

178+
Version
179+
-------
180+
1.0
181+
166182
Description
167183
-----------
168184

@@ -193,7 +209,7 @@ plugins.query.buckets
193209

194210
Version
195211
-------
196-
3.4.0
212+
3.4
197213

198214
Description
199215
-----------
@@ -228,6 +244,10 @@ The number of aggregation buckets is fixed to ``1000`` in v2. ``plugins.query.bu
228244
plugins.query.memory_limit
229245
==========================
230246

247+
Version
248+
-------
249+
1.0
250+
231251
Description
232252
-----------
233253

@@ -256,6 +276,10 @@ Result set::
256276
Thread Pool Settings
257277
====================
258278

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

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

304+
Version
305+
-------
306+
2.12
307+
280308
Description
281309
-----------
282310

@@ -314,6 +342,10 @@ SQL query::
314342
plugins.query.executionengine.spark.refresh_job.limit
315343
=====================================================
316344

345+
Version
346+
-------
347+
2.12
348+
317349
Description
318350
-----------
319351

@@ -351,6 +383,10 @@ SQL query::
351383
plugins.query.datasources.limit
352384
===============================
353385

386+
Version
387+
-------
388+
2.12
389+
354390
Description
355391
-----------
356392

@@ -384,6 +420,10 @@ SQL query::
384420
plugins.query.executionengine.spark.session_inactivity_timeout_millis
385421
=====================================================================
386422

423+
Version
424+
-------
425+
2.12
426+
387427
Description
388428
-----------
389429

@@ -420,6 +460,10 @@ SQL query::
420460
plugins.query.executionengine.spark.auto_index_management.enabled
421461
=================================================================
422462

463+
Version
464+
-------
465+
2.12
466+
423467
Description
424468
-----------
425469
This setting controls the automatic management of request and result indices for each data source. When enabled, it
@@ -456,6 +500,10 @@ SQL query::
456500
plugins.query.executionengine.spark.session.index.ttl
457501
=====================================================
458502

503+
Version
504+
-------
505+
2.12
506+
459507
Description
460508
-----------
461509
This setting defines the time-to-live (TTL) for request indices when plugins.query.executionengine.spark.auto_index_management.enabled
@@ -493,6 +541,10 @@ SQL query::
493541
plugins.query.executionengine.spark.result.index.ttl
494542
====================================================
495543

544+
Version
545+
-------
546+
2.12
547+
496548
Description
497549
-----------
498550
This setting specifies the TTL for result indices when plugins.query.executionengine.spark.auto_index_management.enabled
@@ -529,6 +581,10 @@ SQL query::
529581
plugins.query.executionengine.async_query.enabled
530582
=================================================
531583

584+
Version
585+
-------
586+
2.12
587+
532588
Description
533589
-----------
534590
You can disable submit async query to reject all coming requests.
@@ -560,6 +616,10 @@ Request::
560616
plugins.query.executionengine.async_query.external_scheduler.enabled
561617
=====================================================================
562618

619+
Version
620+
-------
621+
2.17
622+
563623
Description
564624
-----------
565625
This setting controls whether the external scheduler is enabled for async queries.
@@ -595,6 +655,10 @@ Request ::
595655
plugins.query.executionengine.async_query.external_scheduler.interval
596656
=====================================================================
597657

658+
Version
659+
-------
660+
2.17
661+
598662
Description
599663
-----------
600664
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.
@@ -629,6 +693,10 @@ Request ::
629693
plugins.query.executionengine.spark.streamingjobs.housekeeper.interval
630694
======================================================================
631695

696+
Version
697+
-------
698+
2.13
699+
632700
Description
633701
-----------
634702
This setting specifies the interval at which the streaming job housekeeper runs to clean up streaming jobs associated with deleted and disabled data sources.
@@ -665,6 +733,10 @@ Request ::
665733
plugins.query.datasources.enabled
666734
=================================
667735

736+
Version
737+
-------
738+
2.16
739+
668740
Description
669741
-----------
670742

@@ -745,6 +817,10 @@ To Re-enable Data Sources:::
745817
plugins.query.field_type_tolerance
746818
==================================
747819

820+
Version
821+
-------
822+
2.19
823+
748824
Description
749825
-----------
750826

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

883+
Version
884+
-------
885+
3.0
886+
807887
Description
808888
-----------
809889

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

903+
Version
904+
-------
905+
3.1
906+
823907
Description
824908
-----------
825909

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

919+
Version
920+
-------
921+
3.1
922+
835923
Description
836924
-----------
837925

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

935+
Version
936+
-------
937+
3.1
938+
847939
Description
848940
-----------
849941

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

951+
Version
952+
-------
953+
3.3
954+
859955
Description
860956
-----------
861957

0 commit comments

Comments
 (0)