Skip to content

Commit

Permalink
chore: update Community Extensions docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Quack Mc Docs authored and carlopi committed Dec 12, 2024
1 parent 57b9cc6 commit 2851b2e
Show file tree
Hide file tree
Showing 34 changed files with 159 additions and 83 deletions.
1 change: 1 addition & 0 deletions _includes/list_of_community_extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
| [pivot_table]({% link community_extensions/extensions/pivot_table.md %}) | [<span class=github>GitHub</span>](https://github.com/Alex-Monahan/pivot_table) | Provides a spreadsheet-style pivot_table function |
| [prql]({% link community_extensions/extensions/prql.md %}) | [<span class=github>GitHub</span>](https://github.com/ywelsch/duckdb-prql) | Support for PRQL, the Pipelined Relational Query Language |
| [psql]({% link community_extensions/extensions/psql.md %}) | [<span class=github>GitHub</span>](https://github.com/ywelsch/duckdb-psql) | Support for PSQL, a piped SQL dialect for DuckDB |
| [pyroscope]({% link community_extensions/extensions/pyroscope.md %}) | [<span class=github>GitHub</span>](https://github.com/quackscience/duckdb-extension-pyroscope) | DuckDB Pyroscope Extension for Continuous Profiling |
| [quack]({% link community_extensions/extensions/quack.md %}) | [<span class=github>GitHub</span>](https://github.com/duckdb/extension-template) | Provides a hello world example demo |
| [rusty_quack]({% link community_extensions/extensions/rusty_quack.md %}) | [<span class=github>GitHub</span>](https://github.com/duckdb/extension-template-rs) | Provides a hello world example demo from the Rust-based extension template |
| [scrooge]({% link community_extensions/extensions/scrooge.md %}) | [<span class=github>GitHub</span>](https://github.com/pdet/Scrooge-McDuck) | Provides functionality for financial data-analysis, including data scanners for the Ethereum Blockchain and Yahoo Finance |
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/avro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ docs:
extension_star_count: 11
extension_star_count_pretty: 11
extension_download_count: 187
extension_download_count_pretty: 187
extension_download_count: 1167
extension_download_count_pretty: 1.2k
image: '/images/community_extensions/social_preview/preview_community_extension_avro.png'
layout: community_extension_doc
---
Expand Down
8 changes: 4 additions & 4 deletions community_extensions/extensions/bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ docs:
The DuckDB BigQuery Extension integrates DuckDB with Google BigQuery, allowing direct querying and management of BigQuery datasets.
For detailed setup and usage instructions, visit the [extension repository](https://github.com/hafenkran/duckdb-bigquery).
extension_star_count: 71
extension_star_count_pretty: 71
extension_download_count: 622
extension_download_count_pretty: 622
extension_star_count: 76
extension_star_count_pretty: 76
extension_download_count: 520
extension_download_count_pretty: 520
image: '/images/community_extensions/social_preview/preview_community_extension_bigquery.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/capi_quack.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ docs:
extension_star_count: 5
extension_star_count_pretty: 5
extension_download_count: 281
extension_download_count_pretty: 281
extension_download_count: 283
extension_download_count_pretty: 283
image: '/images/community_extensions/social_preview/preview_community_extension_capi_quack.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/chsql.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ docs:
extension_star_count: 42
extension_star_count_pretty: 42
extension_download_count: 278
extension_download_count_pretty: 278
extension_download_count: 288
extension_download_count_pretty: 288
image: '/images/community_extensions/social_preview/preview_community_extension_chsql.png'
layout: community_extension_doc
---
Expand Down
8 changes: 4 additions & 4 deletions community_extensions/extensions/cronjob.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ docs:
extended_description: |
This extension is experimental and potentially unstable. Do not use it in production.
extension_star_count: 25
extension_star_count_pretty: 25
extension_download_count: 274
extension_download_count_pretty: 274
extension_star_count: 26
extension_star_count_pretty: 26
extension_download_count: 277
extension_download_count_pretty: 277
image: '/images/community_extensions/social_preview/preview_community_extension_cronjob.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ repo:

extension_star_count: 12
extension_star_count_pretty: 12
extension_download_count: 303
extension_download_count_pretty: 303
extension_download_count: 305
extension_download_count_pretty: 305
image: '/images/community_extensions/social_preview/preview_community_extension_crypto.png'
layout: community_extension_doc
---
Expand Down
12 changes: 6 additions & 6 deletions community_extensions/extensions/duckpgq.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ excerpt: |
extension:
name: duckpgq
description: Extension that adds support for SQL/PGQ and graph algorithms
version: 0.1.0
version: 0.2.0
language: C++
build: cmake
license: MIT
Expand All @@ -17,7 +17,7 @@ extension:

repo:
github: cwida/duckpgq-extension
ref: 5dcec704050b15b12a7894172089dd4a79ca1435
ref: fb38a09818121021c268b4328f9fb82500f233d0

docs:
hello_world: |
Expand Down Expand Up @@ -60,10 +60,10 @@ docs:
*Disclaimer:* As this extension is part of an ongoing research project by the Database Architectures group at CWI, some features may still be under development. We appreciate your understanding and patience as we continue to improve it.
extension_star_count: 92
extension_star_count_pretty: 92
extension_download_count: 2869
extension_download_count_pretty: 2.9k
extension_star_count: 94
extension_star_count_pretty: 94
extension_download_count: 3153
extension_download_count_pretty: 3.2k
image: '/images/community_extensions/social_preview/preview_community_extension_duckpgq.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/evalexpr_rhai.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ repo:

extension_star_count: 14
extension_star_count_pretty: 14
extension_download_count: 534
extension_download_count_pretty: 534
extension_download_count: 550
extension_download_count_pretty: 550
image: '/images/community_extensions/social_preview/preview_community_extension_evalexpr_rhai.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/faiss.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ docs:
extension_star_count: 8
extension_star_count_pretty: 8
extension_download_count: 281
extension_download_count_pretty: 281
extension_download_count: 277
extension_download_count_pretty: 277
image: '/images/community_extensions/social_preview/preview_community_extension_faiss.png'
layout: community_extension_doc
---
Expand Down
13 changes: 9 additions & 4 deletions community_extensions/extensions/flockmtl.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ docs:
extended_description: |
This extension is experimental and potentially unstable. Do not use it in production.
extension_star_count: 75
extension_star_count_pretty: 75
extension_download_count: 275
extension_download_count_pretty: 275
extension_star_count: 78
extension_star_count_pretty: 78
extension_download_count: 285
extension_download_count_pretty: 285
image: '/images/community_extensions/social_preview/preview_community_extension_flockmtl.png'
layout: community_extension_doc
---
Expand Down Expand Up @@ -84,9 +84,14 @@ LOAD {{ page.extension.name }};
| function_name | function_type | description | comment | example |
|-------------------|---------------|-------------|---------|---------|
| fusion_relative | scalar | | | |
| llm_complete | scalar | | | |
| llm_complete_json | scalar | | | |
| llm_embedding | scalar | | | |
| llm_filter | scalar | | | |
| llm_first | aggregate | | | |
| llm_last | aggregate | | | |
| llm_reduce | aggregate | | | |
| llm_rerank | aggregate | | | |
4 changes: 2 additions & 2 deletions community_extensions/extensions/fuzzycomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,8 @@ repo:

extension_star_count: 8
extension_star_count_pretty: 8
extension_download_count: 274
extension_download_count_pretty: 274
extension_download_count: 280
extension_download_count_pretty: 280
image: '/images/community_extensions/social_preview/preview_community_extension_fuzzycomplete.png'
layout: community_extension_doc
---
Expand Down
8 changes: 4 additions & 4 deletions community_extensions/extensions/gsheets.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ docs:
The DuckDB GSheets Extension allows reading and writing of data in Google Sheets from DuckDB.
For detailed setup and usage instructions, visit the docs at [duckdb-gsheets.com](https://duckdb-gsheets.com).
extension_star_count: 177
extension_star_count_pretty: 177
extension_download_count: 294
extension_download_count_pretty: 294
extension_star_count: 183
extension_star_count_pretty: 183
extension_download_count: 299
extension_download_count_pretty: 299
image: '/images/community_extensions/social_preview/preview_community_extension_gsheets.png'
layout: community_extension_doc
---
Expand Down
6 changes: 3 additions & 3 deletions community_extensions/extensions/h3.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ docs:
extended_description: |
The H3 extension adds support for the [H3 hierarchical hexagonal grid system](https://h3geo.org/).
extension_star_count: 173
extension_star_count_pretty: 173
extension_download_count: 11915
extension_star_count: 174
extension_star_count_pretty: 174
extension_download_count: 11929
extension_download_count_pretty: 11.9k
image: '/images/community_extensions/social_preview/preview_community_extension_h3.png'
layout: community_extension_doc
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/hostfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ docs:
For more information, please see the [HostFS documentation](https://github.com/gropaul/hostFS).
extension_star_count: 11
extension_star_count_pretty: 11
extension_download_count: 288
extension_download_count_pretty: 288
extension_download_count: 295
extension_download_count_pretty: 295
image: '/images/community_extensions/social_preview/preview_community_extension_hostfs.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/http_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ docs:
extension_star_count: 44
extension_star_count_pretty: 44
extension_download_count: 291
extension_download_count_pretty: 291
extension_download_count: 322
extension_download_count_pretty: 322
image: '/images/community_extensions/social_preview/preview_community_extension_http_client.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/httpserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ docs:
extension_star_count: 130
extension_star_count_pretty: 130
extension_download_count: 316
extension_download_count_pretty: 316
extension_download_count: 575
extension_download_count_pretty: 575
image: '/images/community_extensions/social_preview/preview_community_extension_httpserver.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/lindel.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ repo:

extension_star_count: 36
extension_star_count_pretty: 36
extension_download_count: 307
extension_download_count_pretty: 307
extension_download_count: 312
extension_download_count_pretty: 312
image: '/images/community_extensions/social_preview/preview_community_extension_lindel.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/magic.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ docs:
extension_star_count: 4
extension_star_count_pretty: 4
extension_download_count: 286
extension_download_count_pretty: 286
extension_download_count: 293
extension_download_count_pretty: 293
image: '/images/community_extensions/social_preview/preview_community_extension_magic.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/open_prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ docs:
extension_star_count: 25
extension_star_count_pretty: 25
extension_download_count: 276
extension_download_count_pretty: 276
extension_download_count: 282
extension_download_count_pretty: 282
image: '/images/community_extensions/social_preview/preview_community_extension_open_prompt.png'
layout: community_extension_doc
---
Expand Down
8 changes: 4 additions & 4 deletions community_extensions/extensions/pcap_reader.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ docs:
extended_description: |
The PCAP Reader Extension is experimental, use at your own risk!
extension_star_count: 5
extension_star_count_pretty: 5
extension_download_count: 137
extension_download_count_pretty: 137
extension_star_count: 6
extension_star_count_pretty: 6
extension_download_count: 175
extension_download_count_pretty: 175
image: '/images/community_extensions/social_preview/preview_community_extension_pcap_reader.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/pivot_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ docs:
extension_star_count: 7
extension_star_count_pretty: 7
extension_download_count: 306
extension_download_count_pretty: 306
extension_download_count: 310
extension_download_count_pretty: 310
image: '/images/community_extensions/social_preview/preview_community_extension_pivot_table.png'
layout: community_extension_doc
---
Expand Down
4 changes: 2 additions & 2 deletions community_extensions/extensions/prql.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ docs:
extension_star_count: 263
extension_star_count_pretty: 263
extension_download_count: 294
extension_download_count_pretty: 294
extension_download_count: 299
extension_download_count_pretty: 299
image: '/images/community_extensions/social_preview/preview_community_extension_prql.png'
layout: community_extension_doc
---
Expand Down
8 changes: 4 additions & 4 deletions community_extensions/extensions/psql.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ docs:
extended_description: |
PSQL extends DuckDB's SQL with a pipe syntax to provide simple composable queries. It's a lightweight variant of piped languages such as PRQL and Kusto, yet leveraging the full power of DuckDB's SQL.
extension_star_count: 57
extension_star_count_pretty: 57
extension_download_count: 278
extension_download_count_pretty: 278
extension_star_count: 58
extension_star_count_pretty: 58
extension_download_count: 283
extension_download_count_pretty: 283
image: '/images/community_extensions/social_preview/preview_community_extension_psql.png'
layout: community_extension_doc
---
Expand Down
70 changes: 70 additions & 0 deletions community_extensions/extensions/pyroscope.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github/duckdb/community-extensions repository, check README there
title: pyroscope
excerpt: |
DuckDB Community Extensions
DuckDB Pyroscope Extension for Continuous Profiling
extension:
name: pyroscope
description: DuckDB Pyroscope Extension for Continuous Profiling
version: 0.0.1
language: Rust
build: cmake
license: MIT
excluded_platforms: "windows_amd64_rtools;windows_amd64;wasm_threads;wasm_eh;wasm_mvp"
requires_toolchains: "rust;python3"
maintainers:
- lmangani
- akvlad

repo:
github: quackscience/duckdb-extension-pyroscope
ref: 5b727e408b78cd725e6312f1bb8fd2aa84e7f8f8

docs:
hello_world: |
---- Start the tracer, requires backend URL
D SELECT * FROM trace_start('https://pyroscope:4000');
---- Stop the tracer
D SELECT * FROM trace_stop();
extended_description: |
The Pyroscope Extension is experimental, use at your own risk!
extension_star_count: 6
extension_star_count_pretty: 6
extension_download_count: null
extension_download_count_pretty: n/a
image: '/images/community_extensions/social_preview/preview_community_extension_pyroscope.png'
layout: community_extension_doc
---

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}
{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions
<div class="extension_functions_table"></div>
| function_name | function_type | description | comment | example |
|---------------|---------------|-------------|---------|---------|
| trace_start | table | | | |
| trace_stop | table | | | |
Loading

0 comments on commit 2851b2e

Please sign in to comment.