bebekim / paradedb

PostgreSQL for Search

PostgreSQL for Search

Website • Docs • Community • Blog • Changelog

---

ParadeDB is an ElasticSearch alternative built on Postgres. We're building the features of ElasticSearch's product suite, starting with search.

Status

ParadeDB is currently in Public Beta. Star and watch this repository to get notified of updates.

Roadmap

• Search
  • Full-text search with BM25 with pg_bm25
  • Sparse vector search with pg_sparse
  • Dense vector search with pgvector
  • Hybrid search
• Analytics
  • Real-time aggregations
  • Log ingestion
  • Log monitoring
• Self-hosted ParadeDB
  • Docker image & deployment instructions
  • Kubernetes Helm chart & deployment instructions
• Cloud Database
  • Managed cloud
  • Cloud Marketplace Images
  • Web-based SQL Editor

Creating a ParadeDB Instance

ParadeDB Cloud

ParadeDB Cloud is currently being revamped. To get notified when it becomes live, we invite you to join our waitlist.

Self-Hosted

ParadeDB Docker Image

To install ParadeDB locally or on-premise, simply pull and run the latest Docker image:

docker run \
  -e POSTGRES_USER=<user> \
  -e POSTGRES_PASSWORD=<password> \
  -e POSTGRES_DB=<dbname> \
  -p 5432:5432 \
  -v paradedb-data:/var/lib/postgresql/data \
  -d \
  paradedb/paradedb:latest

The -v flag is optional, but recommended. It will persist the ParadeDB PostgreSQL data across restarts. Alternatively, you can clone this repo and run our docker-compose.yml file. By default, this will start the ParadeDB database at http://localhost:5432. Use psql to connect:

psql -h <hostname> -U <user> -d <dbname> -p 5432 -W

ParadeDB collects anonymous telemetry to help us understand how many people are using the project. You can opt-out of telemetry by adding -e TELEMETRY=false (or unsetting the variable) to your docker run command, or by setting TELEMETRY: false in the docker-compose.yml file.

ParadeDB Helm Chart

ParadeDB is also available for Kubernetes via our Helm chart. You can find our Helm chart in the ParadeDB Helm Chart GitHub repository or download it directly from Artifact Hub.

ParadeDB Extension(s)

To install the ParadeDB extension(s) manually within an existing self-hosted Postgres, see the extension(s)' README. We strongly recommend using the ParadeDB Docker image, which is optimized for running search in Postgres.

If you are self-hosting Postgres and are interested in ParadeDB, please contact the ParadeDB team and we'll be happy to help!

Getting Started

To get started using ParadeDB, please follow the quickstart guide!

Documentation

You can find the complete documentation for ParadeDB at docs.paradedb.com.

Support

If you're missing a feature or have found a bug, please open a GitHub Issue.

To get community support, you can:

• Post a question in the ParadeDB Slack Community
• Ask for help on our GitHub Discussions

If you need commercial support, please contact the ParadeDB team.

Contributing

We welcome community contributions, big or small, and are here to guide you along the way. To get started contributing, check our first timer issues or message us in the ParadeDB Community Slack. Once you contribute, ping us in Slack and we'll send you some ParadeDB swag!

For more information on how to contribute, please see our Contributing Guide.

This project is released with a Contributor Code of Conduct. By participating in this project, you agree to follow its terms.

Thank you for helping us make ParadeDB better for everyone ❤️.

License

ParadeDB is licensed under the GNU Affero General Public License v3.0. The pg_sparse extension is licensed under the PostgreSQL License.