Skip to content

Apache DataFusion SQL Query Engine

docs: Add `RESET` Command Documentation (#21245)

Eren Avsarogullari2d9e268bc7f8
diff --git a/dev/update_config_docs.sh b/dev/update_config_docs.sh
index f39bdda3ae..7ab998f3da 100755
--- a/dev/update_config_docs.sh
+++ b/dev/update_config_docs.sh
@@ -101,9 +101,24 @@ EOF
echo "Running CLI and inserting config docs table"
$PRINT_CONFIG_DOCS_COMMAND >> "$TARGET_FILE"
-echo "Inserting runtime config header"
+echo "Inserting reset command details and runtime config header"
cat <<'EOF' >> "$TARGET_FILE"
+You can also reset configuration options to default settings via SQL using the `RESET` command. For
+example, to set and reset `datafusion.execution.batch_size`:
+
+```sql
+SET datafusion.execution.batch_size = '10000';
+
+SHOW datafusion.execution.batch_size;
+datafusion.execution.batch_size 10000
+
+RESET datafusion.execution.batch_size;
+
+SHOW datafusion.execution.batch_size;
+datafusion.execution.batch_size 8192
+```
+
# Runtime Configuration Settings
DataFusion runtime configurations can be set via SQL using the `SET` command.
diff --git a/docs/source/user-guide/configs.md b/docs/source/user-guide/configs.md
index 95abb2769d..69627e3cb9 100644
--- a/docs/source/user-guide/configs.md
+++ b/docs/source/user-guide/configs.md
@@ -197,6 +197,21 @@ The following configuration settings are available:
| datafusion.format.duration_format | pretty | Duration format. Can be either `"pretty"` or `"ISO8601"` |
| datafusion.format.types_info | false | Show types in visual representation batches |
+You can also reset configuration options to default settings via SQL using the `RESET` command. For
+example, to set and reset `datafusion.execution.batch_size`:
+
+```sql
+SET datafusion.execution.batch_size = '10000';
+
+SHOW datafusion.execution.batch_size;
+datafusion.execution.batch_size 10000
+
+RESET datafusion.execution.batch_size;
+
+SHOW datafusion.execution.batch_size;
+datafusion.execution.batch_size 8192
+```
+
# Runtime Configuration Settings
DataFusion runtime configurations can be set via SQL using the `SET` command.