Merge pull request #4065 from Blargian/fix_autogen_functions

Functions documentation: refactor script and fix bug

Author: Blargian

scripts/settings/arithmetic-functions.sql

@@ -224,16 +224,15 @@ if ! $INSTALL_SUCCESS; then
 fi
 
 # --- Auto-generate Settings Documentation ---
-# Source files are assumed to be present in the CWD ($tmp_dir) by copy-clickhouse-repo-docs
 echo "[$SCRIPT_NAME] Auto-generating settings markdown pages..."
-# $target_dir is the project root (clickhouse-docs)
 
-sql_files_found=$(find "$SCRIPT_DIR" -maxdepth 1 -name '*.sql' -print -quit)
+# Process other SQL files first (non-function related)
+sql_files_found=$(find "$SCRIPT_DIR" -maxdepth 1 -name '*.sql' ! -name 'generate-functions.sql' -print -quit)
 if [ -z "$sql_files_found" ]; then
-    echo "[$SCRIPT_NAME] Warning: No *.sql files found in $SCRIPT_DIR to process."
+    echo "[$SCRIPT_NAME] Warning: No non-function *.sql files found in $SCRIPT_DIR to process."
 else
     for SQL_FILE in "$SCRIPT_DIR"/*.sql; do
-      if [ -f "$SQL_FILE" ]; then
+      if [ -f "$SQL_FILE" ] && [ "$(basename "$SQL_FILE")" != "generate-functions.sql" ]; then
         echo "[$SCRIPT_NAME] Processing SQL file: $SQL_FILE"
         # Run ClickHouse from CWD ($tmp_dir), passing absolute path to SQL file
         "$script_path" --queries-file "$SQL_FILE" || {
@@ -246,6 +245,39 @@ else
     done
 fi
 
+# Generate function documentation using the consolidated SQL file
+FUNCTION_SQL_FILE="$SCRIPT_DIR/generate-functions.sql"
+if [ -f "$FUNCTION_SQL_FILE" ]; then
+    echo "[$SCRIPT_NAME] Generating function documentation using consolidated SQL file..."
+
+    # Define function categories to process
+    FUNCTION_CATEGORIES=("Arithmetic" "Arrays" "Bit" "Bitmap" "Comparison" "Conditional")
+
+    for CATEGORY in "${FUNCTION_CATEGORIES[@]}"; do
+        echo "[$SCRIPT_NAME] Processing $CATEGORY functions..."
+        "$script_path" --param_category="$CATEGORY" --queries-file "$FUNCTION_SQL_FILE" || {
+            echo "[$SCRIPT_NAME] FATAL: Failed to execute queries for $CATEGORY functions.";
+            echo "[$SCRIPT_NAME] Attempting to re-run with output:"
+            "$script_path" --param_category="$CATEGORY" --queries-file "$FUNCTION_SQL_FILE"
+            exit 1;
+        }
+
+        # Rename the temporary output file to the correct name
+        CATEGORY_LOWER=$(echo "$CATEGORY" | tr '[:upper:]' '[:lower:]')
+        if [ -f "temp-functions.md" ]; then
+            mv "temp-functions.md" "${CATEGORY_LOWER}-functions.md" || {
+                echo "[$SCRIPT_NAME] Error: Failed to rename temp-functions.md to ${CATEGORY_LOWER}-functions.md"
+                exit 1
+            }
+            echo "[$SCRIPT_NAME] Generated ${CATEGORY_LOWER}-functions.md"
+        else
+            echo "[$SCRIPT_NAME] Warning: temp-functions.md not found after processing $CATEGORY functions"
+        fi
+    done
+else
+    echo "[$SCRIPT_NAME] Warning: Consolidated function SQL file not found at $FUNCTION_SQL_FILE"
+fi
+
 # --- temporary sed replacements ---
 sed -i.bak \
   -e 's/Limit the max number of partitions that can be accessed in one query. <= 0 means unlimited./Limit the max number of partitions that can be accessed in one query. `<=` 0 means unlimited./g' \
@@ -314,7 +346,7 @@ done
 insert_src_files=(
   "experimental-beta-settings.md"
   "arithmetic-functions.md"
-  "array-functions.md"
+  "arrays-functions.md"
   "bit-functions.md"
   "bitmap-functions.md"
   "comparison-functions.md"

scripts/settings/array-functions.sql

@@ -0,0 +1,30 @@
+-- Consolidated function documentation generator
+-- Usage: Pass the category as a parameter, e.g.:
+-- clickhouse --param_category='Arithmetic' --queries-file generate-functions.sql
+
+WITH function_docs AS (
+    SELECT
+        name,
+        description,
+        introduced_in,
+        syntax,
+        arguments,
+        returned_value,
+        examples
+    FROM system.functions
+    WHERE categories = {category:String}
+ORDER BY name ASC
+    )
+SELECT
+    format(
+            '{}{}{}{}{}{}{}',
+            '## ' || name || ' ' || printf('{#%s}', name) || '\n\n',
+            'Introduced in: v' || introduced_in || '\n\n',
+            description || '\n\n',
+            '**Syntax**\n\n' || printf('```sql\n%s\n```', syntax) || '\n\n',
+            if(empty(arguments), '**Arguments**\n\n- None.\n', '**Arguments**\n\n' || arguments || '\n\n'),
+            '**Returned value**\n\n' || trim(returned_value) || '\n\n',
+            '**Examples**\n\n' || examples || '\n'
+    )
+FROM function_docs
+INTO OUTFILE 'temp-functions.md' TRUNCATE FORMAT LineAsString