-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Add ParadeDB Docs #2670
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Add ParadeDB Docs #2670
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ParadeDB brings Elastic-quality full-text search and analytics directly inside Postgres. | ||
|
isaacvando marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: |
|
isaacvando marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| <h1 align="center"> | ||
| <a href="https://paradedb.com"><img src="docs/logo/readme.svg" alt="ParadeDB"></a> | ||
| <br> | ||
| </h1> | ||
|
|
||
| <p align="center"> | ||
| <b>Simple, Elastic-quality search for Postgres</b><br/> | ||
| </p> | ||
|
|
||
| <h3 align="center"> | ||
| <a href="https://paradedb.com">Website</a> • | ||
| <a href="https://docs.paradedb.com">Docs</a> • | ||
| <a href="https://paradedb.com/slack">Community</a> • | ||
| <a href="https://paradedb.com/blog/">Blog</a> • | ||
| <a href="https://docs.paradedb.com/changelog/">Changelog</a> | ||
| </h3> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://hub.docker.com/r/paradedb/paradedb"><img src="https://img.shields.io/docker/pulls/paradedb/paradedb" alt="Docker Pulls"></a> | ||
| <a href="https://github.com/paradedb/paradedb?tab=AGPL-3.0-1-ov-file#readme"><img src="https://img.shields.io/github/license/paradedb/paradedb?color=blue" alt="License"></a> | ||
| <a href="https://paradedb.com/slack"><img src="https://img.shields.io/badge/Community-Join%20Slack-purple?logo=slack" alt="Community"></a> | ||
| <a href="https://x.com/paradedb"><img src="https://img.shields.io/twitter/follow/paradedb" alt="Follow @paradedb"></a> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| ## 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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| [the ParadeDB Slack](https://www.paradedb.com/slack) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| https://github.com/paradedb/paradedb |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| View [license information](https://github.com/paradedb/paradedb/blob/main/LICENSE) for the software contained in this image. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| [the ParadeDB team](%%GITHUB-REPO%%) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "hub": { | ||
| "categories": [ | ||
| "databases-and-storage" | ||
| ] | ||
| } | ||
| } | ||
|
isaacvando marked this conversation as resolved.
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.