Skip to content

Docs: add Calcite settings examples #4806 #5749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AzazelSensei wants to merge 1 commit into
base: main
Choose a base branch
from
+149 −2
Open

Docs: add Calcite settings examples #4806 #5749

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
151 changes: 149 additions & 2 deletions docs/user/admin/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,8 +1024,35 @@ You can enable Calcite as new query optimizer and execution engine to all coming
3. This setting is node scope.
4. This setting can be updated dynamically.

Check `introduce v3 engine <../../../dev/intro-v3-engine.md>`_ for more details.
Check `join doc <../../ppl/cmd/join.rst>`_ for example.
Check `introduce v3 engine <../../dev/intro-v3-engine.md>`_ for more details.
Check `join doc <../ppl/cmd/join.md>`_ for example.

Example
-------

You can update the setting with a new value like this.

SQL query::

>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_plugins/_query/settings -d '{
"transient" : {
"plugins.calcite.enabled" : "true"
}
}'

Result set::

{
"acknowledged" : true,
"persistent" : { },
"transient" : {
"plugins" : {
"calcite" : {
"enabled" : "true"
}
}
}
}

plugins.calcite.fallback.allowed
================================
Expand All @@ -1043,6 +1070,35 @@ If Calcite is enabled, you can use this setting to decide whether to allow fallb
2. This setting is node scope.
3. This setting can be updated dynamically.

Example
-------

You can update the setting with a new value like this.

SQL query::

>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_plugins/_query/settings -d '{
"transient" : {
"plugins.calcite.fallback.allowed" : "true"
}
}'

Result set::

{
"acknowledged" : true,
"persistent" : { },
"transient" : {
"plugins" : {
"calcite" : {
"fallback" : {
"allowed" : "true"
}
}
}
}
}

plugins.calcite.pushdown.enabled
================================

Expand All @@ -1059,6 +1115,35 @@ If Calcite is enabled, you can use this setting to decide whether to enable the
2. This setting is node scope.
3. This setting can be updated dynamically.

Example
-------

You can update the setting with a new value like this.

SQL query::

>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_plugins/_query/settings -d '{
"transient" : {
"plugins.calcite.pushdown.enabled" : "false"
}
}'

Result set::

{
"acknowledged" : true,
"persistent" : { },
"transient" : {
"plugins" : {
"calcite" : {
"pushdown" : {
"enabled" : "false"
}
}
}
}
}

plugins.calcite.pushdown.rowcount.estimation.factor
===================================================

Expand All @@ -1075,6 +1160,39 @@ If Calcite pushdown optimization is enabled, this setting is used to estimate th
2. This setting is node scope.
3. This setting can be updated dynamically.

Example
-------

You can update the setting with a new value like this.

SQL query::

>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_plugins/_query/settings -d '{
"transient" : {
"plugins.calcite.pushdown.rowcount.estimation.factor" : "0.5"
}
}'

Result set::

{
"acknowledged" : true,
"persistent" : { },
"transient" : {
"plugins" : {
"calcite" : {
"pushdown" : {
"rowcount" : {
"estimation" : {
"factor" : "0.5"
}
}
}
}
}
}
}

plugins.calcite.all_join_types.allowed
======================================

Expand All @@ -1090,3 +1208,32 @@ Join types ``inner``, ``left``, ``outer`` (alias of ``left``), ``semi`` and ``an
1. The default value is false since 3.3.0.
2. This setting is node scope.
3. This setting can be updated dynamically.

Example
-------

You can update the setting with a new value like this.

SQL query::

>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_plugins/_query/settings -d '{
"transient" : {
"plugins.calcite.all_join_types.allowed" : "true"
}
}'

Result set::

{
"acknowledged" : true,
"persistent" : { },
"transient" : {
"plugins" : {
"calcite" : {
"all_join_types" : {
"allowed" : "true"
}
}
}
}
}