update doc

Signed-off-by: Peng Huo <penghuo@gmail.com>
opensearch-project · Oct 30, 2023 · 6153f3e · 6153f3e
1 parent 85e98cc
commit 6153f3e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 13 deletions.
diff --git a/common/src/main/java/org/opensearch/sql/common/setting/Settings.java b/common/src/main/java/org/opensearch/sql/common/setting/Settings.java
@@ -38,7 +38,6 @@ public enum Key {
     METRICS_ROLLING_INTERVAL("plugins.query.metrics.rolling_interval"),
     SPARK_EXECUTION_ENGINE_CONFIG("plugins.query.executionengine.spark.config"),
     CLUSTER_NAME("cluster.name"),
-    SPARK_EXECUTION_SESSION_ENABLED("plugins.query.executionengine.spark.session.enabled"),
     SPARK_EXECUTION_SESSION_LIMIT("plugins.query.executionengine.spark.session.limit"),
     SPARK_EXECUTION_REFRESH_JOB_LIMIT("plugins.query.executionengine.spark.refresh_job.limit"),
     SESSION_INDEX_TTL("plugins.query.executionengine.spark.session.index.ttl"),

diff --git a/docs/user/admin/settings.rst b/docs/user/admin/settings.rst
@@ -311,15 +311,16 @@ SQL query::
       "status": 400
     }
 
-plugins.query.executionengine.spark.session.enabled
-===================================================
+
+plugins.query.executionengine.spark.session.limit
+==================================================
 
 Description
 -----------
 
-By default, execution engine is executed in session mode. You can disable session mode by this setting.
+Each cluster can have maximum 100 sessions running in parallel by default. You can increase limit by this setting.
 
-1. The default value is true.
+1. The default value is 100.
 2. This setting is node scope.
 3. This setting can be updated dynamically.
 
@@ -328,7 +329,7 @@ You can update the setting with a new value like this.
 SQL query::
 
     sh$ curl -sS -H 'Content-Type: application/json' -X PUT localhost:9200/_plugins/_query/settings \
-    ... -d '{"transient":{"plugins.query.executionengine.spark.session.enabled":"false"}}'
+    ... -d '{"transient":{"plugins.query.executionengine.spark.session.limit":200}}'
     {
       "acknowledged": true,
       "persistent": {},
@@ -338,7 +339,7 @@ SQL query::
             "executionengine": {
               "spark": {
                 "session": {
-                  "enabled": "false"
+                  "limit": "200"
                 }
               }
             }
@@ -347,15 +348,16 @@ SQL query::
       }
     }
 
-plugins.query.executionengine.spark.session.limit
-==================================================
+
+plugins.query.executionengine.spark.refresh_job.limit
+=====================================================
 
 Description
 -----------
 
-Each cluster can have maximum 100 sessions running in parallel by default. You can increase limit by this setting.
+Each cluster can have maximum 20 datasources. You can increase limit by this setting.
 
-1. The default value is 100.
+1. The default value is 20.
 2. This setting is node scope.
 3. This setting can be updated dynamically.
 
@@ -364,7 +366,7 @@ You can update the setting with a new value like this.
 SQL query::
 
     sh$ curl -sS -H 'Content-Type: application/json' -X PUT localhost:9200/_plugins/_query/settings \
-    ... -d '{"transient":{"plugins.query.executionengine.spark.session.limit":200}}'
+    ... -d '{"transient":{"plugins.query.executionengine.spark.refresh_job.limit":200}}'
     {
       "acknowledged": true,
       "persistent": {},
@@ -373,7 +375,7 @@ SQL query::
           "query": {
             "executionengine": {
               "spark": {
-                "session": {
+                "refresh_job": {
                   "limit": "200"
                 }
               }