-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
./script/fetch_extensions.sh duckdb Will fetch all each relevant extension usign the provided duckdb binary. ./script/generate_md.sh duckdb Will, usign the just installed extensions, generate markdown files for each extension
- Loading branch information
Showing
2 changed files
with
100 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| rm -rf build | ||
| for extension_folder in extensions/*; | ||
| do | ||
| extension_name=$(basename -- $extension_folder) | ||
| echo "Installing $extension_name" | ||
| $1 -c "SET extension_directory = 'build/extension_dir'; FORCE INSTALL '$extension_name' FROM community;" | ||
| done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Example of use | ||
| # ./scripts/generated_docs_readme.sh build/release/duckdb | ||
|
|
||
| platform=$($1 -csv -c "PRAGMA platform" | tail -n1) | ||
| version_raw=$($1 -csv -c "PRAGMA version" | tail -n1) | ||
| version=$(echo "$version_raw-,$version_raw" | cut -d '-' -f 2 | cut -d ',' -f 2) | ||
|
|
||
| DOCS=build/docs | ||
|
|
||
| rm -rf $DOCS | ||
| mkdir -p $DOCS | ||
|
|
||
| echo "Extension repository docs" > $DOCS/README.md | ||
|
|
||
| for extension_file in build/extension_dir/$version/$platform/*.duckdb_extension; | ||
| do | ||
| extension_full=$(basename -- $extension_file) | ||
| extension="${extension_full%%.*}" | ||
| echo "Generating docs for $extension" | ||
| EXTENSION_README=$DOCS/$extension.md | ||
| things="extensions functions settings types" | ||
| rm -f pre.db | ||
| rm -f post.db | ||
| for thing in $things; do | ||
| $1 -unsigned pre.db -c "SET extension_directory = 'build/extensions'; CREATE OR REPLACE TABLE $thing AS FROM duckdb_$thing();" | ||
| rm -rf temp | ||
| $1 -unsigned post.db -c "SET extension_directory = 'build/extensions'; FORCE INSTALL $extension FROM 'build/extension_dir'; LOAD $extension; CREATE OR REPLACE TABLE $thing AS FROM duckdb_$thing();" | ||
| rm -rf temp | ||
| done | ||
|
|
||
| mkdir -p $DOCS/$extension | ||
|
|
||
| $1 post.db -c "ATTACH 'pre.db'; CREATE OR REPLACE TABLE fun_no_overload AS SELECT function_name, function_type, split_part(description, chr(10), 1) as description, comment, example FROM (FROM (SELECT function_name, function_type, description, comment, example FROM functions ORDER BY function_name) EXCEPT (SELECT function_name, function_type, description, comment, example FROM pre.functions ORDER BY function_name)) GROUP BY ALL ORDER BY function_name;" | ||
| $1 post.db -c "ATTACH 'pre.db'; CREATE OR REPLACE TABLE fun_with_overload AS SELECT function_name, function_type, split_part(description, chr(10), 1) as description, comment, example FROM (FROM ( SELECT count(*), function_name, function_type, description, comment, example FROM functions GROUP BY ALL ORDER BY function_name) EXCEPT (SELECT count(*), function_name, function_type, description, comment, example FROM pre.functions GROUP BY ALL ORDER BY function_name)) GROUP BY ALL ORDER BY function_name;" | ||
| $1 $DOCS/$extension.db -c "ATTACH 'post.db'; CREATE OR REPLACE TABLE functions AS FROM post.fun_no_overload GROUP BY ALL ORDER BY function_name;" | ||
| $1 $DOCS/$extension.db -c "ATTACH 'post.db'; CREATE OR REPLACE TABLE functions_overloads AS FROM post.fun_with_overload EXCEPT FROM post.fun_no_overload GROUP BY ALL ORDER BY function_name;" | ||
| $1 $DOCS/$extension.db -c "ATTACH 'pre.db'; ATTACH 'post.db'; CREATE OR REPLACE TABLE new_settings AS FROM ( SELECT * EXCLUDE (value) FROM post.settings ORDER BY name) EXCEPT (SELECT * EXCLUDE (value) FROM pre.settings ORDER BY name) ORDER BY name;" | ||
| $1 $DOCS/$extension.db -c "ATTACH 'pre.db'; ATTACH 'post.db'; CREATE OR REPLACE TABLE description AS FROM ( SELECT * EXCLUDE (install_path, loaded, installed) FROM post.extensions ORDER BY extension_name) EXCEPT (SELECT * EXCLUDE (install_path, loaded, installed) FROM pre.extensions ORDER BY extension_name) ORDER BY extension_name;" | ||
| $1 $DOCS/$extension.db -c "ATTACH 'pre.db'; ATTACH 'post.db'; CREATE OR REPLACE TABLE types AS FROM ( SELECT type_name, type_size, logical_type, type_category, internal FROM post.types ORDER BY ALL) EXCEPT (SELECT type_name, type_size, logical_type, type_category, internal FROM pre.types ORDER BY ALL) ORDER BY type_name;" | ||
|
|
||
| if [ -s "extensions/$extension/docs/function_descriptions.csv" ]; then | ||
| cp extensions/$extension/docs/function_descriptions.csv $DOCS/functions.csv | ||
| $1 $DOCS/$extension.db -c "CREATE TABLE tmp AS SELECT function_name, function_type, other.description as description, other.comment as comment, other.example as example FROM functions, read_csv('$DOCS/functions.csv') AS other WHERE function_name == other.function; DROP TABLE functions; CREATE TABLE functions AS FROM tmp; DROP TABLE tmp;" | ||
| $1 $DOCS/$extension.db -c "CREATE TABLE tmp AS SELECT function_name, function_type, other.description as description, other.comment as comment, other.example as example FROM functions_overloads, read_csv('$DOCS/functions.csv') AS other WHERE function_name == other.function; DROP TABLE functions_overloads; CREATE TABLE functions_overloads AS FROM tmp; DROP TABLE tmp;" | ||
| fi | ||
|
|
||
| $1 $DOCS/$extension.db -markdown -c "FROM new_settings;" > $DOCS/$extension/settings.md | ||
| $1 $DOCS/$extension.db -markdown -c "FROM functions;" > $DOCS/$extension/functions.md | ||
| $1 $DOCS/$extension.db -markdown -c "FROM functions_overloads;" > $DOCS/$extension/functions_overloads.md | ||
| $1 $DOCS/$extension.db -markdown -c "FROM description;" > $DOCS/$extension/extension.md | ||
| $1 $DOCS/$extension.db -markdown -c "FROM types;" > $DOCS/$extension/types.md | ||
|
|
||
| rm -f pre.db | ||
| rm -f post.db | ||
|
|
||
| if [ -s "$DOCS/$extension/extension.md" ]; then | ||
| echo "## $extension" > $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| cat $DOCS/$extension/extension.md >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
|
|
||
| if [ -s "$DOCS/$extension/functions.md" ]; then | ||
| echo "### Added functions" >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| cat $DOCS/$extension/functions.md >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| fi | ||
| if [ -s "$DOCS/$extension/functions_overloads.md" ]; then | ||
| echo "### Added function overloads" >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| cat $DOCS/$extension/functions_overloads.md >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| fi | ||
| if [ -s "$DOCS/$extension/types.md" ]; then | ||
| echo "### Added types" >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| cat $DOCS/$extension/types.md >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| fi | ||
| if [ -s "$DOCS/$extension/settings.md" ]; then | ||
| echo "### Added settings" >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| cat $DOCS/$extension/settings.md >> $EXTENSION_README | ||
| echo "" >> $EXTENSION_README | ||
| fi | ||
| echo "" >> $EXTENSION_README | ||
| fi | ||
| rm -rf $DOCS/$extension | ||
| done | ||
|
|
||
| echo "" >> $DOCS/README.md |