From 680bf1ecd0531b47185b4718c18d316e704d97a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philippe=20No=C3=ABl?= Date: Mon, 24 Aug 2026 13:31:26 -0700 Subject: [PATCH] Add ParadeDB docs --- paradedb/README-short.txt | 1 + paradedb/compose.yaml | 15 ++++++ paradedb/content.md | 109 ++++++++++++++++++++++++++++++++++++++ paradedb/get-help.md | 1 + paradedb/github-repo | 1 + paradedb/license.md | 1 + paradedb/logo.png | Bin 0 -> 3877 bytes paradedb/maintainer.md | 1 + paradedb/metadata.json | 7 +++ 9 files changed, 136 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..730a7d6d3dd3 --- /dev/null +++ b/paradedb/README-short.txt @@ -0,0 +1 @@ +Search without a second system: full-text search, vector retrieval, and aggregations in Postgres. diff --git a/paradedb/compose.yaml b/paradedb/compose.yaml new file mode 100644 index 000000000000..e42fcd8f86f1 --- /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..704884c0c7fc --- /dev/null +++ b/paradedb/content.md @@ -0,0 +1,109 @@ +

+ ParadeDB +
+

+ +

+ Search without a second system.
+ One Postgres for your application data, full-text search, vector retrieval, and aggregations. +

+ +

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

+ +

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

+ +--- + +## Installation + +To install ParadeDB locally in a fresh Docker container and drop straight into a `psql` session: + +```bash +curl -fsSL https://paradedb.com/install.sh | sh +``` + +When you're ready to deploy, check out our [hosting options](https://www.paradedb.com/docs/deploy/overview). + +## What is ParadeDB? + +[ParadeDB](https://paradedb.com) upgrades Postgres with a custom index for fast full-text and vector search, BM25 scoring, filtering, and aggregations. Your application data and search engine live in one database, with no second system to deploy and nothing to sync. + +Vectors are currently indexed using the [pgvector](https://github.com/pgvector/pgvector) extension, but native vector support is coming to our search index soon. + +- [Full-Text Search](https://www.paradedb.com/docs/documentation/full-text/overview) + - [BM25 Scoring](https://www.paradedb.com/docs/documentation/sorting/score) + - [Top K](https://www.paradedb.com/docs/documentation/sorting/topk) + - [Highlighting](https://www.paradedb.com/docs/documentation/full-text/highlight) + - [Tokenizers & Token Filters](https://www.paradedb.com/docs/documentation/tokenizers/overview) +- [Filtering](https://www.paradedb.com/docs/documentation/filtering) +- [Aggregates](https://www.paradedb.com/docs/documentation/aggregates/overview) + - [Columnar Storage](https://www.paradedb.com/docs/documentation/indexing/columnar) + - [Bucket & Metrics](https://www.paradedb.com/docs/documentation/aggregates/overview) + - [Facets](https://www.paradedb.com/docs/documentation/aggregates/facets) +- [JOINs](https://www.paradedb.com/docs/documentation/joins/overview) + +Star and watch the [repository](https://github.com/paradedb/paradedb) to follow along. See our [current projects](https://github.com/paradedb/paradedb/projects?query=is%3Aopen) and [long-term roadmap](https://www.paradedb.com/docs/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://www.paradedb.com/docs/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 + +- [Drizzle](https://github.com/paradedb/drizzle-paradedb) +- [Django](https://github.com/paradedb/django-paradedb) +- [SQLAlchemy](https://github.com/paradedb/sqlalchemy-paradedb) +- [Rails](https://github.com/paradedb/rails-paradedb) +- [EF Core](https://github.com/paradedb/efcore-paradedb) +- More coming (Prisma, and others) + +### AI Agents + +- [Agent Skills](https://github.com/paradedb/agent-skills) +- [MCP Integration](https://www.paradedb.com/docs/documentation/getting-started/ai-agents) +- [Cursor Plugin](https://cursor.com/marketplace/parade-db) + +### PaaS & Cloud Platforms + +- [Railway](https://www.paradedb.com/docs/deploy/cloud-platforms/railway) +- [Render](https://www.paradedb.com/docs/deploy/cloud-platforms/render) +- [DigitalOcean](https://www.paradedb.com/docs/deploy/cloud-platforms/digitalocean) +- [Fly.io](https://www.paradedb.com/docs/deploy/cloud-platforms/fly) +- [Dokku](https://www.paradedb.com/docs/deploy/cloud-platforms/dokku) +- 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. For [ParadeDB Enterprise](https://www.paradedb.com/docs/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..2f562e766212af60fd9ec776a2d05332118616bc GIT binary patch literal 3877 zcmeHK`#)6c8h_TBOJj^%7i?uW)KP3juA3ufqNqfhV;WnSE-pJ03b_omhNjCoDs81A znNvxc3Ef=UjV4O%5IeMq(1)5DZk3G$12ebB(gq_=a6jQGAUq4(iS|_XSIsMK}k=*}29S4u(>i|2*0OXkfx?TV* zCI%qoZ4F>GfK=O@-e4DJ^1SRWeEv~kIc{l{}|+SpblMp@CQfrY}7 zSpY8{>92^9Y%`%L>Fh(ojHYMu5%^Y-ucy!1>;+KA87W;0`W*uqOCm5^04rx zQS7U#k*m}4ay)nu05v`$uXmvPlKiM5ajcvsmSoCssbBD%A4gR8Mj!vtVUwU-BV3C9 z6gpnC<}e(3O~&2DAs%*)f^#eb8W1MMwz!pX{=l<-+BqKpMxd;&Dq7RK;8V5yBJzq7 zM{C|vDK~IPhJiTnw8l4(8mQLW$RIb8NU+jdQ-#@h=4=egv|n2FDD!8R{Y8FJ7hvFG zw8rVAp*$P6JremU6lZ|197~j8>^O{%T2h9EKMFO#_=}Osp7f-wgt=@0K2uM=N)KSJ zH@Qp?WuU$CBw8@30S4Bl9x$*PATuk)xwr3#Du{Pk0|-6;A&uBA%&2u}L!7cjd|%^Q z4stt?qPQG$n!#&Cr_*Z_5X}MuO(_KhskzV;Y^x*BMfEKxc|>a1SQ)}QNe0%8b~>+J zEn7cfe2TR<4&nu_)BNsY*tZHGey=~q$Od?om0}^Muo)RhHM|C2rR1w*O2EYugJw1d zOX4E;b5eZR8b$OBr1Wk=WoYL)j|U59m;gAxdE-`^GcgfF;h-_cb7jWO7ND~Nsa+km zIMIf#gz<*`m?AtzpR0u;62<--=+b=vkwhOM%|Vj&j2df1w4p;B`nNpkv_~cvqkIdL zg)D2-)aC;z=2?9NV-0}a)=AAG%rFyqK4=ilrBG23MmBM(pM`8x*gh`CTaOAhNziQ; zu^6ZhyYOfZl-ZydCr|A;MdG0=BVP9IU4^F918vrYeKoqEjn}L}3AdcadAe!~4jAr5 zDH^82+zF|-+EO1fP>tW9`2UxQ*0om+T&Xes&v3(4qnAar%7EV8XtEhE!zu7#5fEmX zhnD+QMos=>NVDq*f;nr4!KRMQ5lyKZdUvO8Cc-lhO=LfDjC;P%2?pznD3NvTmD`DG zXWEYm4=td67O-sRQKpu4!WZW&aerQ@32sr8EV;!XUA4o&u9hzMO`B50Xj-lWXw(Ha z`#4pK)5PzE_=lOucb94nSgPUpVS{LZqOT6u0G31fj<=V_U2~+5X@K~<1WkD`tj)`l z1$HM7%uOT>?{PI}`J27xQn)_(Gm<{Hl}gFY3xK%b{ib6h_Y6(!3$X4~`x4;zRgglG zC+gK0X>vjh;Z-qFo5IE~_0Ad!wOrKwTckbn7+T(}8=G*!C)8YxlOk3cq3h&b4~?g~ zDhf|8kGo-AX@rjlL@d@;4Mv2GI(F)p`=_qF-Y^|3cFGn|D5cya|>ZF&spvD!4(6-Kn97PLeSL{UJo?c)uX`+!iQPcYXWLAxAOftJm%PanBZKaR65No6 zLX$5^V35Mh_XXXeGqhMMc#SrTyS2IQ;HLphKbi6HJvY@YmIaD($$;df?}apvzwVkc zpyCJngLOP4ao~CQuz?qvUDAH-Bb{{SVSvTu_=CP@+Uxn0EKh(baWo}qGt(U5zNzP# zp6BUIQv_=(l@xZ&?N7&&Ay;9n9ed;^9{c9wEXvPj06FVpG^D;-dpU?e!djETU3eX# zWS3_eFKcajK(qIJi{_b#p3+lndT%)Hex1Zzhp35kF;q34B&LbyATnf` z5;-VYfG&0&0jKm=nwWz46>GJc)^SaJ`Wl=O!n=qOV`bk{ROx3w1len@`i~4%}&xg^y~S+q4lb%=kTfaYgH9S>)XB)I$K$%4Jua{b}jxwUYoK7 z6=NZVF5N*|7bSSa^o|<_R0L9VOEho0%_9!%fC_r}(v4Ovp&NrfCO6VCH&euEXi*t8 za=g}_u3W>m($)`2I4<5NY)f~+dB>H;-BO>=ed<@Qe=<_<)c02}dEqq@B2gL`*0vl; zPq{lBV$Ya#7sX9aJXc5qGC0e33fLH&t(<|rZ8QLA3jvr}00ayFw(zYV|Gf^=BsS&B Vy)i!HEc*O~)hm5GN>=dF{{@h7LyZ6c 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" + ] + } +}