From 9af09f33c75d4eb17ac6dd50e4d511961ea000e7 Mon Sep 17 00:00:00 2001 From: Isaac Van Doren Date: Fri, 8 May 2026 12:48:23 -0500 Subject: [PATCH 1/2] Add ParadeDB docs --- paradedb/README-short.txt | 1 + paradedb/compose.yaml | 15 ++++++ paradedb/content.md | 102 ++++++++++++++++++++++++++++++++++++++ paradedb/get-help.md | 1 + paradedb/github-repo | 1 + paradedb/license.md | 1 + paradedb/logo.png | Bin 0 -> 1569 bytes paradedb/maintainer.md | 1 + paradedb/metadata.json | 7 +++ 9 files changed, 129 insertions(+) create mode 100644 paradedb/README-short.txt create mode 100644 paradedb/compose.yaml create mode 100644 paradedb/content.md create mode 100644 paradedb/get-help.md create mode 100644 paradedb/github-repo create mode 100644 paradedb/license.md create mode 100644 paradedb/logo.png create mode 100644 paradedb/maintainer.md create mode 100644 paradedb/metadata.json diff --git a/paradedb/README-short.txt b/paradedb/README-short.txt new file mode 100644 index 000000000000..e133c9b01973 --- /dev/null +++ b/paradedb/README-short.txt @@ -0,0 +1 @@ +ParadeDB brings Elastic-quality full-text search and analytics directly inside Postgres. diff --git a/paradedb/compose.yaml b/paradedb/compose.yaml new file mode 100644 index 000000000000..bd8c87b0bd43 --- /dev/null +++ b/paradedb/compose.yaml @@ -0,0 +1,15 @@ +services: + paradedb: + image: paradedb:latest + container_name: paradedb + environment: + POSTGRES_USER: myuser + POSTGRES_PASSWORD: mypassword + POSTGRES_DB: mydatabase + ports: + - "5432:5432" + volumes: + - paradedb_data:/var/lib/postgresql/ + +volumes: + paradedb_data: diff --git a/paradedb/content.md b/paradedb/content.md new file mode 100644 index 000000000000..6482d321f4fe --- /dev/null +++ b/paradedb/content.md @@ -0,0 +1,102 @@ +

+ ParadeDB +
+

+ +

+ Simple, Elastic-quality search for Postgres
+

+ +

+ Website • + Docs • + Community • + Blog • + Changelog +

+ +

+ Docker Pulls  + License  + Community  + Follow @paradedb +

+ +--- + +## Installation + +```bash +curl -fsSL https://paradedb.com/install.sh | sh +``` + +When you're ready to deploy, check out our [hosting options](https://docs.paradedb.com/deploy/overview). + +## What is ParadeDB? + +[ParadeDB](https://paradedb.com) is a PostgreSQL extension that brings Elastic-quality full-text search and analytics directly inside Postgres. + +- [x] [Full-Text Search](https://docs.paradedb.com/documentation/full-text/overview) + - [x] [BM25 Scoring](https://docs.paradedb.com/documentation/sorting/score) + - [x] [Top K](https://docs.paradedb.com/documentation/sorting/topk) + - [x] [Highlighting](https://docs.paradedb.com/documentation/full-text/highlight) + - [x] [Tokenizers & Token Filters](https://docs.paradedb.com/documentation/tokenizers/overview) +- [x] [Filtering](https://docs.paradedb.com/documentation/filtering) +- [x] [Aggregates](https://docs.paradedb.com/documentation/aggregates/overview) + - [x] [Columnar Storage](https://docs.paradedb.com/documentation/indexing/columnar) + - [x] [Bucket & Metrics](https://docs.paradedb.com/documentation/aggregates/overview) + - [x] [Facets](https://docs.paradedb.com/documentation/aggregates/facets) +- [x] [JOINs](https://docs.paradedb.com/documentation/joins/overview) +- [ ] Vector Search (coming soon) +- [ ] Hybrid Search (coming soon) + +Star and watch this repository to follow along. See our [current projects](https://github.com/paradedb/paradedb/projects?query=is%3Aopen) and [long-term roadmap](https://docs.paradedb.com/welcome/roadmap). + +## How It Works + +ParadeDB integrates battle-tested Rust libraries for search and analytics inside Postgres, contributing upstream whenever possible. Our primary dependencies are: + +- [pgrx](https://github.com/pgcentralfoundation/pgrx) — bridges Postgres and Rust +- [Tantivy](https://github.com/quickwit-oss/tantivy) — powers full-text search +- [Apache DataFusion](https://github.com/apache/datafusion) — handles OLAP processing + +For a deeper dive, see our [architecture docs](https://docs.paradedb.com/welcome/architecture) or [CMU Database Group talk](https://db.cs.cmu.edu/events/building-blocks-paradedb-philippe-noel/). + +## Integrations + +ParadeDB integrates with the tools you already use, with more on the way. + +### ORMs & Frameworks + +- [Django](https://github.com/paradedb/django-paradedb) +- [SQLAlchemy](https://github.com/paradedb/sqlalchemy-paradedb) +- [Rails](https://github.com/paradedb/rails-paradedb) +- More coming (Prisma, and others) + +### AI Agents + +- [Agent Skills](https://github.com/paradedb/agent-skills) +- [MCP Integration](https://docs.paradedb.com/documentation/getting-started/ai-agents) + +### PaaS & Cloud Platforms + +- [Railway](https://docs.paradedb.com/deploy/cloud-platforms/railway) +- [Render](https://docs.paradedb.com/deploy/cloud-platforms/render) +- [DigitalOcean](https://docs.paradedb.com/deploy/cloud-platforms/digitalocean) +- More coming (Heroku, and others) + +## Community & Support + +- [Slack](https://paradedb.com/slack) — ask questions, share what you're building +- [GitHub Discussions](https://github.com/paradedb/paradedb/discussions) — longer-form Q&A +- [GitHub Issues](https://github.com/paradedb/paradedb/issues/new/choose) — bug reports and feature requests +- [Email](mailto:sales@paradedb.com) — enterprise support and commercial licensing + +## Contributing + +We welcome contributions of all sizes! Check out our [good first issues](https://github.com/paradedb/paradedb/labels/good%20first%20issue) to get started. For larger contributions, we recommend discussing them with us in [Slack](https://paradedb.com/slack) first. See our [Contributing Guide](/CONTRIBUTING.md) and [Code of Conduct](/CODE_OF_CONDUCT.md) for details. + +## License + +ParadeDB Community is licensed under the [GNU Affero General Public License v3.0](LICENSE). For [ParadeDB Enterprise](https://docs.paradedb.com/deploy/enterprise) licensing, contact [sales@paradedb.com](mailto:sales@paradedb.com). + diff --git a/paradedb/get-help.md b/paradedb/get-help.md new file mode 100644 index 000000000000..62776a243ffa --- /dev/null +++ b/paradedb/get-help.md @@ -0,0 +1 @@ +[the ParadeDB Slack](https://www.paradedb.com/slack) diff --git a/paradedb/github-repo b/paradedb/github-repo new file mode 100644 index 000000000000..89f0859ef353 --- /dev/null +++ b/paradedb/github-repo @@ -0,0 +1 @@ +https://github.com/paradedb/paradedb diff --git a/paradedb/license.md b/paradedb/license.md new file mode 100644 index 000000000000..3d2c9b6d3f53 --- /dev/null +++ b/paradedb/license.md @@ -0,0 +1 @@ +View [license information](https://github.com/paradedb/paradedb/blob/main/LICENSE) for the software contained in this image. diff --git a/paradedb/logo.png b/paradedb/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9ecf8ba42c859e34ccc467f625136dbd62c79281 GIT binary patch literal 1569 zcmc&!>r>JR6lHs2WNEqLL@BrpEW=iB{At{n6zQqSCF007WxBUyY5BJ_VckbLXbLZTX9USOqxoO8H z5C~-Hf5Io!Twi?&@EUV=#2@Yif!2@v`*;zPN~Tpo(Kcfa9rOOzx8LoabUCgvR?Z;w z=OGA1FbW(|7AhtsTXVg|`J>wa-o{&RZykiOZK{&0E3DS_XV`GPAHdU}J|(iN9+dL> zpZE8v?(M2sPDr+Tltjg`Jl*7OjMhM}xuK>m_u?U?vN+N1rv3SF%D`H9F&MIqz1~8a zzK-mb4#2%gci@;4R<^spPMfOwGljlNqg9p;X)kmr2nL4!b6aI6x3a)P?#@CM$;t&Q z%)jQOi!len(79=Eh3cL$Mr3f@i^Wk7_3ZehmQ-JHb+{tYbd+{EAbBc4r9AsuzI#p) zVP`9_URMfb7yL9;B!rn(mR6$GEyikL`~A%pE9b7fnJ&-FZ2zGi>d@|y< ziHPJWtyAXH_J6%42Kd?B~+o6$cJhMewr8YdGt z#|OeN7Uaf9k&xQ6t6zrLz|OFr=@-;DfStPGtqtLOb5gizex%!tt#6yJwe`Jxhi7X9 z)u(q#CT{=(ZghSt$x6a_7;mDQSBfGb5PDqe^$ z2~GD+9^mNuw|9|p{ZzwTFY)E{y$#l#-qF+f3>BX3JXFCjQ0xf(86uvFX#K#4ig>_N6J}3H+GZ{jWmU z-!{nPwOP7wDfiH%@(UGRT4!V(QP}ic)8;5ws{a7>#SXzHBj=6*LX07YZki9D0V-qKII0prNP5 z{5zKM{+|j_|I40oY z)d}(Z>UO7kGp~g5Mc?7Lq8-9<0t>nHS}%}Ls9VX0;rxIfnTIZqJiL)tbiWf#g|%4V z>S`!a5kZFB(HhudsQ3!KC1ei{qT_|{eVkv@R374ISEaS28}Er{S<9&%?@}D{xw23( zm8PL+*SgU~_C($b1Ya1lT;16fR?XoU+Fj#yqNc%MJKIyPZ^U2Q$^PT1^K`S@n@q6Y V{SHxf$V4*$`TGX?Jn=rC{x3~V#vuRz literal 0 HcmV?d00001 diff --git a/paradedb/maintainer.md b/paradedb/maintainer.md new file mode 100644 index 000000000000..000ec262a461 --- /dev/null +++ b/paradedb/maintainer.md @@ -0,0 +1 @@ +[the ParadeDB team](%%GITHUB-REPO%%) diff --git a/paradedb/metadata.json b/paradedb/metadata.json new file mode 100644 index 000000000000..3d3937b21fb1 --- /dev/null +++ b/paradedb/metadata.json @@ -0,0 +1,7 @@ +{ + "hub": { + "categories": [ + "databases-and-storage" + ] + } +} From c3a9677b6f33146c04d34bed16ead2a76e3c8b3c Mon Sep 17 00:00:00 2001 From: Isaac Van Doren Date: Fri, 8 May 2026 12:49:58 -0500 Subject: [PATCH 2/2] Apply markdown formatting changes --- paradedb/content.md | 61 ++++++++++++++++++++++----------------------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/paradedb/content.md b/paradedb/content.md index 6482d321f4fe..c6ca5365ff7e 100644 --- a/paradedb/content.md +++ b/paradedb/content.md @@ -36,19 +36,19 @@ When you're ready to deploy, check out our [hosting options](https://docs.parade [ParadeDB](https://paradedb.com) is a PostgreSQL extension that brings Elastic-quality full-text search and analytics directly inside Postgres. -- [x] [Full-Text Search](https://docs.paradedb.com/documentation/full-text/overview) - - [x] [BM25 Scoring](https://docs.paradedb.com/documentation/sorting/score) - - [x] [Top K](https://docs.paradedb.com/documentation/sorting/topk) - - [x] [Highlighting](https://docs.paradedb.com/documentation/full-text/highlight) - - [x] [Tokenizers & Token Filters](https://docs.paradedb.com/documentation/tokenizers/overview) -- [x] [Filtering](https://docs.paradedb.com/documentation/filtering) -- [x] [Aggregates](https://docs.paradedb.com/documentation/aggregates/overview) - - [x] [Columnar Storage](https://docs.paradedb.com/documentation/indexing/columnar) - - [x] [Bucket & Metrics](https://docs.paradedb.com/documentation/aggregates/overview) - - [x] [Facets](https://docs.paradedb.com/documentation/aggregates/facets) -- [x] [JOINs](https://docs.paradedb.com/documentation/joins/overview) -- [ ] Vector Search (coming soon) -- [ ] Hybrid Search (coming soon) +- [x] [Full-Text Search](https://docs.paradedb.com/documentation/full-text/overview) + - [x] [BM25 Scoring](https://docs.paradedb.com/documentation/sorting/score) + - [x] [Top K](https://docs.paradedb.com/documentation/sorting/topk) + - [x] [Highlighting](https://docs.paradedb.com/documentation/full-text/highlight) + - [x] [Tokenizers & Token Filters](https://docs.paradedb.com/documentation/tokenizers/overview) +- [x] [Filtering](https://docs.paradedb.com/documentation/filtering) +- [x] [Aggregates](https://docs.paradedb.com/documentation/aggregates/overview) + - [x] [Columnar Storage](https://docs.paradedb.com/documentation/indexing/columnar) + - [x] [Bucket & Metrics](https://docs.paradedb.com/documentation/aggregates/overview) + - [x] [Facets](https://docs.paradedb.com/documentation/aggregates/facets) +- [x] [JOINs](https://docs.paradedb.com/documentation/joins/overview) +- [ ] Vector Search (coming soon) +- [ ] Hybrid Search (coming soon) Star and watch this repository to follow along. See our [current projects](https://github.com/paradedb/paradedb/projects?query=is%3Aopen) and [long-term roadmap](https://docs.paradedb.com/welcome/roadmap). @@ -56,9 +56,9 @@ Star and watch this repository to follow along. See our [current projects](https ParadeDB integrates battle-tested Rust libraries for search and analytics inside Postgres, contributing upstream whenever possible. Our primary dependencies are: -- [pgrx](https://github.com/pgcentralfoundation/pgrx) — bridges Postgres and Rust -- [Tantivy](https://github.com/quickwit-oss/tantivy) — powers full-text search -- [Apache DataFusion](https://github.com/apache/datafusion) — handles OLAP processing +- [pgrx](https://github.com/pgcentralfoundation/pgrx) — bridges Postgres and Rust +- [Tantivy](https://github.com/quickwit-oss/tantivy) — powers full-text search +- [Apache DataFusion](https://github.com/apache/datafusion) — handles OLAP processing For a deeper dive, see our [architecture docs](https://docs.paradedb.com/welcome/architecture) or [CMU Database Group talk](https://db.cs.cmu.edu/events/building-blocks-paradedb-philippe-noel/). @@ -68,29 +68,29 @@ ParadeDB integrates with the tools you already use, with more on the way. ### ORMs & Frameworks -- [Django](https://github.com/paradedb/django-paradedb) -- [SQLAlchemy](https://github.com/paradedb/sqlalchemy-paradedb) -- [Rails](https://github.com/paradedb/rails-paradedb) -- More coming (Prisma, and others) +- [Django](https://github.com/paradedb/django-paradedb) +- [SQLAlchemy](https://github.com/paradedb/sqlalchemy-paradedb) +- [Rails](https://github.com/paradedb/rails-paradedb) +- More coming (Prisma, and others) ### AI Agents -- [Agent Skills](https://github.com/paradedb/agent-skills) -- [MCP Integration](https://docs.paradedb.com/documentation/getting-started/ai-agents) +- [Agent Skills](https://github.com/paradedb/agent-skills) +- [MCP Integration](https://docs.paradedb.com/documentation/getting-started/ai-agents) ### PaaS & Cloud Platforms -- [Railway](https://docs.paradedb.com/deploy/cloud-platforms/railway) -- [Render](https://docs.paradedb.com/deploy/cloud-platforms/render) -- [DigitalOcean](https://docs.paradedb.com/deploy/cloud-platforms/digitalocean) -- More coming (Heroku, and others) +- [Railway](https://docs.paradedb.com/deploy/cloud-platforms/railway) +- [Render](https://docs.paradedb.com/deploy/cloud-platforms/render) +- [DigitalOcean](https://docs.paradedb.com/deploy/cloud-platforms/digitalocean) +- More coming (Heroku, and others) ## Community & Support -- [Slack](https://paradedb.com/slack) — ask questions, share what you're building -- [GitHub Discussions](https://github.com/paradedb/paradedb/discussions) — longer-form Q&A -- [GitHub Issues](https://github.com/paradedb/paradedb/issues/new/choose) — bug reports and feature requests -- [Email](mailto:sales@paradedb.com) — enterprise support and commercial licensing +- [Slack](https://paradedb.com/slack) — ask questions, share what you're building +- [GitHub Discussions](https://github.com/paradedb/paradedb/discussions) — longer-form Q&A +- [GitHub Issues](https://github.com/paradedb/paradedb/issues/new/choose) — bug reports and feature requests +- [Email](mailto:sales@paradedb.com) — enterprise support and commercial licensing ## Contributing @@ -99,4 +99,3 @@ We welcome contributions of all sizes! Check out our [good first issues](https:/ ## License ParadeDB Community is licensed under the [GNU Affero General Public License v3.0](LICENSE). For [ParadeDB Enterprise](https://docs.paradedb.com/deploy/enterprise) licensing, contact [sales@paradedb.com](mailto:sales@paradedb.com). -