Settings

The SQL plugin adds a few settings to the standard OpenSearch cluster settings. Most are dynamic, so you can change the default behavior of the plugin without restarting your cluster.

You can update these settings like any other cluster setting:

  1. PUT _cluster/settings
  2. {
  3.   "transient" : {
  4.     "plugins.sql.enabled" : false
  5.   }
  6. }

Similarly, you can also update the settings by sending the request to the plugin setting endpoint _plugins/_query/setting:

  1. PUT _plugins/_query/settings
  2. {
  3.   "transient" : {
  4.     "plugins.sql.enabled" : false
  5.   }
  6. }
SettingDefaultDescription
plugins.sql.enabledTrueChange to false to disable the plugin.
plugins.sql.slowlog2 secondsConfigure 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_alive1 minuteThis value configures how long the cursor context is kept open. Cursor contexts are resource heavy, so we recommend a low value.
plugins.query.memory_limit85%This setting configures the heap memory usage limit for the circuit breaker of the query engine.
plugins.query.size_limit200The setting sets the default size of index that the query engine fetches from OpenSearch.