Neon
Run Readyset against a Neon Postgres database using RDST.
This guide walks you through running Readyset against a Neon Postgres database using RDST, the Readyset Data and SQL Toolkit.
This guide is intended for local or test deployments using Docker. For production deployments, see the production installation guide.
Prerequisites
- pipx installed (pipx installation guide)
- Docker installed and running
- A Neon account with a Postgres project
Steps
Get your Neon connection string
In the Neon Console, open your project and navigate to the Connection Details panel. Copy the connection string. It will look like this:
postgresql://<user>:<password>@<endpoint-id>.<region>.aws.neon.tech/<dbname>Neon has extra parameters in the connection string to enable SSL (?sslmode=require). This is not required for Readyset configuration.
Set your password as an environment variable
RDST uses environment variables to store the database password for security purposes.
export NEON_PASSWORD="<neon-database-password>"Configure your Neon database as a target
Add your Neon database as a named target:
rdst configure add --target neon --connection-string "postgresql://<user>:<password>@<endpoint-id>.<region>.aws.neon.tech/<dbname>"Once RDST creates the target, deploy the cache.
