Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions paradedb/README-short.txt
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.
15 changes: 15 additions & 0 deletions paradedb/compose.yaml
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:
97 changes: 97 additions & 0 deletions paradedb/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<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> &bull;
<a href="https://docs.paradedb.com">Docs</a> &bull;
<a href="https://paradedb.com/slack">Community</a> &bull;
<a href="https://paradedb.com/blog/">Blog</a> &bull;
<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>&nbsp;
<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>&nbsp;
<a href="https://paradedb.com/slack"><img src="https://img.shields.io/badge/Community-Join%20Slack-purple?logo=slack" alt="Community"></a>&nbsp;
<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.

- [Full-Text Search](https://docs.paradedb.com/documentation/full-text/overview)
- [BM25 Scoring](https://docs.paradedb.com/documentation/sorting/score)
- [Top K](https://docs.paradedb.com/documentation/sorting/topk)
- [Highlighting](https://docs.paradedb.com/documentation/full-text/highlight)
- [Tokenizers & Token Filters](https://docs.paradedb.com/documentation/tokenizers/overview)
- [Filtering](https://docs.paradedb.com/documentation/filtering)
- [Aggregates](https://docs.paradedb.com/documentation/aggregates/overview)
- [Columnar Storage](https://docs.paradedb.com/documentation/indexing/columnar)
- [Bucket & Metrics](https://docs.paradedb.com/documentation/aggregates/overview)
- [Facets](https://docs.paradedb.com/documentation/aggregates/facets)
- [JOINs](https://docs.paradedb.com/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://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)

### 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)

## 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://docs.paradedb.com/deploy/enterprise) licensing, contact [sales@paradedb.com](mailto:sales@paradedb.com).
1 change: 1 addition & 0 deletions paradedb/get-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the ParadeDB Slack](https://www.paradedb.com/slack)
1 change: 1 addition & 0 deletions paradedb/github-repo
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://github.com/paradedb/paradedb
1 change: 1 addition & 0 deletions paradedb/license.md
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.
Binary file added paradedb/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions paradedb/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the ParadeDB team](%%GITHUB-REPO%%)
7 changes: 7 additions & 0 deletions paradedb/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"hub": {
"categories": [
"databases-and-storage"
]
}
}