Skip to content

Commit

Permalink
Merge pull request #30 from rustyconover/fix_add_descriptions
Browse files Browse the repository at this point in the history
fix: add extended descriptions for lindel, shellfs and crypto.
  • Loading branch information
carlopi authored Jul 5, 2024
2 parents 7c2235c + c27bb66 commit 0cc6bbb
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 0 deletions.
7 changes: 7 additions & 0 deletions extensions/crypto/description.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,10 @@ extension:
repo:
github: rustyconover/duckdb-crypto-extension
ref: b6ccda3451d4fac8a2c0ae5ab2bca5216f22424c

docs:
hello_world: |
SELECT * from read_csv('seq 1 100 | grep 2 |');
extended_description: |
This extension, `crypto`, adds cryptographic hash functions and
the ability to calculate a HMAC to DuckDB's SQL engine.
3 changes: 3 additions & 0 deletions extensions/crypto/docs/function_descriptions.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
function,description,comment,example
crypto_hash,"Calculate the value of a hash function","","select crypto_hash('md5', 'test');"
crypto_hmac,"Calculate a HMAC value","","select crypto_hmac('sha2-256', 'secret key', 'secret message');"
8 changes: 8 additions & 0 deletions extensions/lindel/description.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,11 @@ extension:
repo:
github: rustyconover/duckdb-lindel-extension
ref: 76f5bc78e8bfd1a7953c8cc4c284209b65626216

docs:
hello_world: |
SELECT hilbert_encode([1, 2, 3]::tinyint[3]);
extended_description: |
This `lindel` extension adds functions for the linearization and
delinearization of numeric arrays in DuckDB. It allows you to order
multi-dimensional data using space-filling curves.
5 changes: 5 additions & 0 deletions extensions/lindel/docs/function_descriptions.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
function,description,comment,example
hilbert_encode,"Encode an array of values using the Hilbert space filling curve","","select hilbert_encode([43, 3]::integer[2]);"
hilbert_decode,"Decode a Hilbert encoded set of values","","select hilbert_decode(7::uint16, 2, false, true) as values;"
morton_encode,"Encode an array of values using Morton encoding","","select morton_encode([43, 3]::integer[2]);"
morton_decode,"Decode an array of values using Morton encoding","","select morton_decode(7::uint16, 2, false, true) as values;"
9 changes: 9 additions & 0 deletions extensions/shellfs/description.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,12 @@ extension:
repo:
github: rustyconover/duckdb-shellfs-extension
ref: d01c73d211544f5f0ff62acb8263a9874f973ddd

docs:
hello_world: |
SELECT * from read_csv('seq 1 100 | grep 2 |');
extended_description: |
The `shellfs`` extension for DuckDB enables the use of Unix pipes for input and output.
By appending a pipe character `|`` to a filename, DuckDB will treat it as a series of commands
to execute and capture the output. Conversely, if you prefix a filename with `|`, DuckDB will
treat it as an output pipe.

0 comments on commit 0cc6bbb

Please sign in to comment.