# paradedb
**Repository Path**: delin10/paradedb
## Basic Information
- **Project Name**: paradedb
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-08-08
- **Last Updated**: 2024-08-08
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Postgres for Search and Analytics
---
[](https://github.com/paradedb/paradedb/actions/workflows/publish-paradedb.yml)
[](https://artifacthub.io/packages/search?repo=paradedb)
[](https://hub.docker.com/r/paradedb/paradedb)
[](https://github.com/paradedb/paradedb?tab=AGPL-3.0-1-ov-file#readme)
[](https://join.slack.com/t/paradedbcommunity/shared_invite/zt-2lkzdsetw-OiIgbyFeiibd1DG~6wFgTQ)
[](https://x.com/paradedb)
[ParadeDB](https://paradedb.com) 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
- [x] Search
- [x] Full-text search with BM25 with [pg_search](https://github.com/paradedb/paradedb/tree/dev/pg_search#overview)
- [x] Dense and sparse vector search with [pgvector](https://github.com/pgvector/pgvector#pgvector)
- [x] Hybrid search
- [ ] Analytics
- [x] An analytical query engine over data in Postgres or in any object store or table format with [pg_analytics](https://github.com/paradedb/pg_analytics)
- [ ] Column-oriented table access method for fast analytics inside Postgres
- [ ] High-volume data/Kafka ingest
- [x] Self-Hosted ParadeDB
- [x] Docker image based on [Postgres](https://hub.docker.com/_/postgres) ([see deployment instructions](https://docs.paradedb.com/deploy/aws))
- [x] Kubernetes Helm chart based on [CloudNativePG](https://artifacthub.io/packages/helm/cloudnative-pg/cloudnative-pg) ([see deployment instructions](https://docs.paradedb.com/deploy/helm))
- [x] Specialized Workloads
- [ ] Support for geospatial data with [PostGIS](https://github.com/postgis/postgis)
- [x] Support for cron jobs with [pg_cron](https://github.com/citusdata/pg_cron)
- [x] Support for basic incremental view maintenance (IVM) via [pg_ivm](https://github.com/sraoss/pg_ivm)
## Get Started
To get started, please visit our [documentation](https://docs.paradedb.com).
## Deploying ParadeDB
ParadeDB and its extensions are available as commercial software for installation on self-hosted Postgres deployment and via Docker and Kubernetes as standalone images. For more information, including enterprise features and support, please [contact us by email](mailto:sales@paradedb.com).
### Extensions
You can find prebuilt binaries for all ParadeDB extensions on Debian 12, Ubuntu 22.04 and 24.04, and Red Hat Enterprise Linux 8 and 9 for Postgres 14, 15 and 16 in the [GitHub Releases](https://github.com/paradedb/paradedb/releases/latest). We officially support Postgres 12 and above, and you can compile the extensions for other versions of Postgres by following the instructions in the respective extension's README.
### Docker Image
To quickly get a ParadeDB instance up and running, simply pull and run the latest Docker image:
```bash
docker run --name paradedb -e POSTGRES_PASSWORD=password paradedb/paradedb
```
This will start a ParadeDB instance with default user `postgres` and password `password`. You can then connect to the database using `psql`:
```bash
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:
```bash
docker run \
--name paradedb \
-e POSTGRES_USER= \
-e POSTGRES_PASSWORD= \
-e POSTGRES_DB= \
-v paradedb_data:/var/lib/postgresql/ \
-p 5432:5432 \
-d \
paradedb/paradedb:latest
```
This will start a ParadeDB instance with non-root user `` and password ``. The `-v` flag enables your ParadeDB data to persist across restarts in a Docker volume named `paradedb_data`.
You can then connect to the database using `psql`:
```bash
docker exec -it paradedb psql -U -d -p 5432 -W
```
ParadeDB collects anonymous telemetry to help us understand how many people are using the project. You can opt out of telemetry using configuration variables within Postgres:
```sql
ALTER SYSTEM SET paradedb.pg_search_telemetry TO 'off';
ALTER SYSTEM SET paradedb.pg_analytics_telemetry TO 'off';
```
### 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](https://github.com/paradedb/helm-charts) or download it directly from [Artifact Hub](https://artifacthub.io/packages/helm/paradedb/paradedb).
### ParadeDB Cloud
At the moment, ParadeDB is not available as a managed cloud service. If you are interested in a ParadeDB Cloud service, please let us know by joining our [waitlist](https://form.typeform.com/to/jHkLmIzx).
## Support
If you're missing a feature or have found a bug, please open a
[GitHub Issue](https://github.com/paradedb/paradedb/issues/new/choose).
To get community support, you can:
- Post a question in the [ParadeDB Slack Community](https://join.slack.com/t/paradedbcommunity/shared_invite/zt-2lkzdsetw-OiIgbyFeiibd1DG~6wFgTQ)
- Ask for help on our [GitHub Discussions](https://github.com/paradedb/paradedb/discussions)
If you need commercial support, please [contact the ParadeDB team](mailto:sales@paradedb.com).
## 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](https://github.com/paradedb/paradedb/labels/good%20first%20issue)
or message us in the [ParadeDB Community Slack](https://join.slack.com/t/paradedbcommunity/shared_invite/zt-2lkzdsetw-OiIgbyFeiibd1DG~6wFgTQ). 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](/CONTRIBUTING.md).
This project is released with a [Contributor Code of Conduct](/CODE_OF_CONDUCT.md).
By participating in this project, you agree to follow its terms.
Thank you for helping us make ParadeDB better for everyone :heart:.
## License
ParadeDB is licensed under the [GNU Affero General Public License v3.0](LICENSE) and as commercial software. For commercial licensing, please contact us at [sales@paradedb.com](mailto:sales@paradedb.com).