Consolidate configuration sectionds in docs

Author: alamb

.github/workflows/rust.yml

@@ -707,11 +707,6 @@ jobs:
           # If you encounter an error, run './dev/update_function_docs.sh' and commit
           ./dev/update_function_docs.sh
           git diff --exit-code
-      - name: Check if runtime_configs.md has been modified
-        run: |
-          # If you encounter an error, run './dev/update_runtime_config_docs.sh' and commit
-          ./dev/update_runtime_config_docs.sh
-          git diff --exit-code
 
   # Verify MSRV for the crates which are directly used by other projects:
   # - datafusion

dev/update_config_docs.sh

@@ -25,6 +25,8 @@ cd "${SOURCE_DIR}/../" && pwd
 
 TARGET_FILE="docs/source/user-guide/configs.md"
 PRINT_CONFIG_DOCS_COMMAND="cargo run --manifest-path datafusion/core/Cargo.toml --bin print_config_docs"
+PRINT_RUNTIME_CONFIG_DOCS_COMMAND="cargo run --manifest-path datafusion/core/Cargo.toml --bin print_runtime_config_docs"
+
 
 echo "Inserting header"
 cat <<'EOF' > "$TARGET_FILE"
@@ -70,6 +72,27 @@ EOF
 echo "Running CLI and inserting config docs table"
 $PRINT_CONFIG_DOCS_COMMAND >> "$TARGET_FILE"
 
+echo "Inserting runtime config header"
+cat <<'EOF' >> "$TARGET_FILE"
+
+# Runtime Environment Configurations
+
+DataFusion runtime configurations can be set via SQL using the `SET` command.
+
+For example, to configure `datafusion.runtime.memory_limit`:
+
+```sql
+SET datafusion.runtime.memory_limit = '2G';
+```
+
+The following runtime configuration settings are available:
+
+EOF
+
+echo "Running CLI and inserting runtime config docs table"
+$PRINT_RUNTIME_CONFIG_DOCS_COMMAND >> "$TARGET_FILE"
+
+
 echo "Running prettier"
 npx prettier@2.3.2 --write "$TARGET_FILE"
 

dev/update_runtime_config_docs.sh

@@ -125,4 +125,5 @@
 
 redirects = {
     "library-user-guide/adding-udfs": "functions/index.html",
+    "user-guide/runtime_configs": "user_guide/configs.html",
 }

docs/source/conf.py

@@ -144,3 +144,19 @@ Environment variables are read during `SessionConfig` initialisation so they mus
 | datafusion.format.time_format                                           | %H:%M:%S%.f               | Time format for time arrays                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | datafusion.format.duration_format                                       | pretty                    | Duration format. Can be either `"pretty"` or `"ISO8601"`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | datafusion.format.types_info                                            | false                     | Show types in visual representation batches                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+
+# Runtime Environment Configurations
+
+DataFusion runtime configurations can be set via SQL using the `SET` command.
+
+For example, to configure `datafusion.runtime.memory_limit`:
+
+```sql
+SET datafusion.runtime.memory_limit = '2G';
+```
+
+The following runtime configuration settings are available:
+
+| key                             | default | description                                                                                                                                 |
+| ------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| datafusion.runtime.memory_limit | NULL    | Maximum memory limit for query execution. Supports suffixes K (kilobytes), M (megabytes), and G (gigabytes). Example: '2G' for 2 gigabytes. |