Skip to content

secret-arrow/paradedb

Repository files navigation

ParadeDB

Postgres for Search and Analytics

WebsiteDocsCommunityBlogChangelog


Publish ParadeDB Docker Pulls Artifact Hub

ParadeDB is an Elasticsearch alternative built on Postgres. We're modernizing the features of Elasticsearch's product suite, starting with real-time search and analytics.

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
    • Acclerated analytical queries and column-oriented storage with pg_analytics
    • External object store integrations (S3/Azure/GCS/HDFS)
    • External Apache Iceberg and Delta Lake support
    • High volume data/Kafka ingest
    • Non-Parquet file formats (Avro/ORC)
  • Self-Hosted ParadeDB
  • Cloud Database
    • Managed cloud
    • Cloud Marketplace Images
    • Web-based SQL Editor
  • Specialized Workloads
    • Support for geospatial data with PostGIS
    • Support for cron jobs with pg_cron

Get Started

To get started, please visit our documentation.

Creating a ParadeDB Instance

ParadeDB Cloud

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

Self-Hosted

ParadeDB Docker Image

To quickly get a ParadeDB instance up and running, simply pull and run the latest Docker image:

docker run --name paradedb paradedb/paradedb

This will start a ParadeDB instance with default user postgres and password postgres. You can then connect to the database using psql:

docker exec -it paradedb psql -U postgres

To install ParadeDB locally or on-premise, we recommend using our docker-compose.yml file. Alternatively, you can pass the appropriate environment variables to the docker run command, replacing the <> with your desired values:

docker run \
  --name paradedb \
  -e POSTGRESQL_USERNAME=<user> \
  -e POSTGRESQL_PASSWORD=<password> \
  -e POSTGRESQL_DATABASE=<dbname> \
  -e POSTGRESQL_POSTGRES_PASSWORD=<superuser_password> \
  -v paradedb_data:/bitnami/postgresql \
  -p 5432:5432 \
  -d \
  paradedb/paradedb:latest

This will start a ParadeDB instance with non-root user <user> and password <password>, and your ParadeDB data will be persisted across restarts in a Docker volume named paradedb_data. The superuser_password will be associated with superuser postgres and is necessary for ParadeDB extensions to install properly. You can then connect to the database using psql:

docker exec -it paradedb psql -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 setting PARADEDB_TELEMETRY to false or by unsetting the variable.

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!

Support

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

To get community support, you can:

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 and as commercial software, with the exception of pg_sparse which is licensed under the PostgreSQL License.

For commercial licensing, please contact us at sales@paradedb.com.

If you are an open-source project and would like to use ParadeDB under a different license, please contact us at hello@paradedb.com.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published