chore: update Community Extensions docs

duckdb · Dec 7, 2024 · 86fec5a · 86fec5a
1 parent 2f4854e
commit 86fec5a
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 2 deletions.
diff --git a/_includes/list_of_community_extensions.md b/_includes/list_of_community_extensions.md
@@ -19,6 +19,7 @@
 | [lindel]({% link community_extensions/extensions/lindel.md %})               | [<span class=github>GitHub</span>](https://github.com/rustyconover/duckdb-lindel-extension)         | Linearization/Delinearization, Z-Order, Hilbert and Morton Curves                                                         |
 | [magic]({% link community_extensions/extensions/magic.md %})                 | [<span class=github>GitHub</span>](https://github.com/carlopi/duckdb_magic)                         | libmagic/file utilities ported to DuckDB                                                                                  |
 | [open_prompt]({% link community_extensions/extensions/open_prompt.md %})     | [<span class=github>GitHub</span>](https://github.com/quackscience/duckdb-extension-openprompt)     | Interact with LLMs with a simple DuckDB Extension                                                                         |
+| [pcap_reader]({% link community_extensions/extensions/pcap_reader.md %})     | [<span class=github>GitHub</span>](https://github.com/quackscience/duckdb-extension-pcap)           | Read PCAP files from DuckDB                                                                                               |
 | [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                                                                          |

diff --git a/community_extensions/extensions/gsheets.md b/community_extensions/extensions/gsheets.md
@@ -63,8 +63,8 @@ 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: 172
-extension_star_count_pretty: 172
+extension_star_count: 173
+extension_star_count_pretty: 173
 extension_download_count: 204
 extension_download_count_pretty: 204
 image: '/images/community_extensions/social_preview/preview_community_extension_gsheets.png'

diff --git a/community_extensions/extensions/pcap_reader.md b/community_extensions/extensions/pcap_reader.md
@@ -0,0 +1,79 @@
+---
+warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github/duckdb/community-extensions repository, check README there
+title: pcap_reader
+excerpt: |
+  DuckDB Community Extensions
+  Read PCAP files from DuckDB
+
+extension:
+  name: pcap_reader
+  description: Read PCAP files from DuckDB
+  version: 0.0.1
+  language: Rust
+  build: cmake
+  license: MIT
+  excluded_platforms: "windows_amd64_rtools;windows_amd64"
+  requires_toolchains: "rust;python3"
+  maintainers:
+    - lmangani
+    - glongo
+
+repo:
+  github: quackscience/duckdb-extension-pcap
+  ref: 658db756b32a434a144ef3521872bc5727a5f996
+
+docs:
+  hello_world: |
+    -- Basic PCAP reader
+    D SELECT * FROM pcap_reader('test.pcap') LIMIT 3;
+    ┌────────────┬────────────────┬────────────────┬──────────┬──────────┬──────────┬─────────┬───────────────────────────────────────────┐
+    │ timestamp  │     src_ip     │     dst_ip     │ src_port │ dst_port │ protocol │ length  │                 payload                   │
+    │  varchar   │    varchar     │    varchar     │ varchar  │ varchar  │ varchar  │ varchar │                 varchar                   │
+    ├────────────┼────────────────┼────────────────┼──────────┼──────────┼──────────┼─────────┼───────────────────────────────────────────┤
+    │ 1733513420 │ xx.xx.xx.xxx   │ yyy.yyy.yy.yyy │ 64078    │ 5080     │ UDP      │ 756     │ INVITE sip:810442837619024@yyy.yyy.yy.y…  │
+    │ 1733513420 │ yyy.yyy.yy.yyy │ xx.xx.xx.xxx   │ 5080     │ 64078    │ UDP      │ 360     │ SIP/2.0 100 Trying\r\nVia: SIP/2.0/UDP …  │
+    │ 1733513420 │ yyy.yyy.yy.yyy │ xx.xx.xx.xxx   │ 5080     │ 64078    │ UDP      │ 909     │ SIP/2.0 480 Temporarily Unavailable\r\n…  │
+    ├────────────┴────────────────┴────────────────┴──────────┴──────────┴──────────┴─────────┴───────────────────────────────────────────┤
+    │ 3 rows                                                                                                                    8 columns │
+    └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+
+  extended_description: |
+    The PCAP Reader Extension is experimental, use at your own risk!
+
+extension_star_count: 2
+extension_star_count_pretty: 2
+extension_download_count: null
+extension_download_count_pretty: n/a
+image: '/images/community_extensions/social_preview/preview_community_extension_pcap_reader.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 |
+|---------------|---------------|-------------|---------|---------|
+| pcap_reader   | table         |             |         |         |
+
+
+
+---
+