Skip to content

Commit 6a335fd

Browse files
isaacvandoisaacvando
committed
Add ParadeDB docs
1 parent 7068d3b commit 6a335fd

9 files changed

Lines changed: 124 additions & 0 deletions

File tree

‎paradedb/README-short.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ParadeDB brings Elastic-quality full-text search and analytics directly inside Postgres.

‎paradedb/compose.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
services:
2+
paradedb:
3+
image: paradedb:latest
4+
container_name: paradedb
5+
environment:
6+
POSTGRES_USER: myuser
7+
POSTGRES_PASSWORD: mypassword
8+
POSTGRES_DB: mydatabase
9+
ports:
10+
- 5432:5432
11+
volumes:
12+
- paradedb_data:/var/lib/postgresql/
13+
14+
volumes:
15+
paradedb_data:

‎paradedb/content.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<h1 align="center">
2+
<a href="https://paradedb.com"><img src="docs/logo/readme.svg" alt="ParadeDB"></a>
3+
<br>
4+
</h1>
5+
6+
<p align="center">
7+
<b>Simple, Elastic-quality search for Postgres</b><br/>
8+
</p>
9+
10+
<h3 align="center">
11+
<a href="https://paradedb.com">Website</a> &bull;
12+
<a href="https://docs.paradedb.com">Docs</a> &bull;
13+
<a href="https://paradedb.com/slack">Community</a> &bull;
14+
<a href="https://paradedb.com/blog/">Blog</a> &bull;
15+
<a href="https://docs.paradedb.com/changelog/">Changelog</a>
16+
</h3>
17+
18+
<p align="center">
19+
<a href="https://hub.docker.com/r/paradedb/paradedb"><img src="https://img.shields.io/docker/pulls/paradedb/paradedb" alt="Docker Pulls"></a>&nbsp;
20+
<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;
21+
<a href="https://paradedb.com/slack"><img src="https://img.shields.io/badge/Community-Join%20Slack-purple?logo=slack" alt="Community"></a>&nbsp;
22+
<a href="https://x.com/paradedb"><img src="https://img.shields.io/twitter/follow/paradedb" alt="Follow @paradedb"></a>
23+
</p>
24+
25+
---
26+
27+
## Installation
28+
29+
```bash
30+
curl -fsSL https://paradedb.com/install.sh | sh
31+
```
32+
33+
When you're ready to deploy, check out our [hosting options](https://docs.paradedb.com/deploy/overview).
34+
35+
## What is ParadeDB?
36+
37+
[ParadeDB](https://paradedb.com) is a PostgreSQL extension that brings Elastic-quality full-text search and analytics directly inside Postgres.
38+
39+
- [Full-Text Search](https://docs.paradedb.com/documentation/full-text/overview)
40+
- [BM25 Scoring](https://docs.paradedb.com/documentation/sorting/score)
41+
- [Top K](https://docs.paradedb.com/documentation/sorting/topk)
42+
- [Highlighting](https://docs.paradedb.com/documentation/full-text/highlight)
43+
- [Tokenizers & Token Filters](https://docs.paradedb.com/documentation/tokenizers/overview)
44+
- [Filtering](https://docs.paradedb.com/documentation/filtering)
45+
- [Aggregates](https://docs.paradedb.com/documentation/aggregates/overview)
46+
- [Columnar Storage](https://docs.paradedb.com/documentation/indexing/columnar)
47+
- [Bucket & Metrics](https://docs.paradedb.com/documentation/aggregates/overview)
48+
- [Facets](https://docs.paradedb.com/documentation/aggregates/facets)
49+
- [JOINs](https://docs.paradedb.com/documentation/joins/overview)
50+
51+
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).
52+
53+
## How It Works
54+
55+
ParadeDB integrates battle-tested Rust libraries for search and analytics inside Postgres, contributing upstream whenever possible. Our primary dependencies are:
56+
57+
- [pgrx](https://github.com/pgcentralfoundation/pgrx) — bridges Postgres and Rust
58+
- [Tantivy](https://github.com/quickwit-oss/tantivy) — powers full-text search
59+
- [Apache DataFusion](https://github.com/apache/datafusion) — handles OLAP processing
60+
61+
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/).
62+
63+
## Integrations
64+
65+
ParadeDB integrates with the tools you already use, with more on the way.
66+
67+
### ORMs & Frameworks
68+
69+
- [Django](https://github.com/paradedb/django-paradedb)
70+
- [SQLAlchemy](https://github.com/paradedb/sqlalchemy-paradedb)
71+
- [Rails](https://github.com/paradedb/rails-paradedb)
72+
73+
### AI Agents
74+
75+
- [Agent Skills](https://github.com/paradedb/agent-skills)
76+
- [MCP Integration](https://docs.paradedb.com/documentation/getting-started/ai-agents)
77+
78+
### PaaS & Cloud Platforms
79+
80+
- [Railway](https://docs.paradedb.com/deploy/cloud-platforms/railway)
81+
- [Render](https://docs.paradedb.com/deploy/cloud-platforms/render)
82+
- [DigitalOcean](https://docs.paradedb.com/deploy/cloud-platforms/digitalocean)
83+
84+
## Community & Support
85+
86+
- [Slack](https://paradedb.com/slack) — ask questions, share what you're building
87+
- [GitHub Discussions](https://github.com/paradedb/paradedb/discussions) — longer-form Q&A
88+
- [GitHub Issues](https://github.com/paradedb/paradedb/issues/new/choose) — bug reports and feature requests
89+
- [Email](mailto:sales@paradedb.com) — enterprise support and commercial licensing
90+
91+
## Contributing
92+
93+
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.
94+
95+
## License
96+
97+
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).

‎paradedb/get-help.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[the ParadeDB Slack](https://www.paradedb.com/slack)

‎paradedb/github-repo‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://github.com/paradedb/paradedb

‎paradedb/license.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
View [license information](https://github.com/paradedb/paradedb/blob/main/LICENSE) for the software contained in this image.

‎paradedb/logo.png‎

3.79 KB
Loading

‎paradedb/maintainer.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[the ParadeDB team](%%GITHUB-REPO%%)

‎paradedb/metadata.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"hub": {
3+
"categories": [
4+
"databases-and-storage"
5+
]
6+
}
7+
}

0 commit comments

Comments
 (0)