Prerequisites
- Sign up for Neon, you can sign in with a Github or Google account.
- After signing in, you are directed to the Neon Console where you can set up your project.
Procedure
Step 1 - Set up project on Neon and collect connection info
Once you have set up your project, an.env
file will be generated that contains the connection details for your Neon databases, download the file (and make sure to keep it safe!).


Step 2 - Add Neon database instance to Bytebase
From your Bytebase Create Instance page, choose Add Instance, fill in the details to create the connection as follows:- Database:
PostgreSQL
. - Instance Name: any name of your choosing, e.g.
neon-bb
. - Environment:
Prod
orTest
(select the environment you want to add the instance to). - Host or Socket: the PGHOST from the
.env
file - Port: 5432 (Neon uses the default PostgreSQL port of 5432 to connect)
- Username: copy the PGUSER from the
.env
file - Password: copy the PGPASSWORD from the
.env
file - Database: copy the PGDATABASE from the
.env
file

Step 3 - Check if the database instance is properly imported
All databases should be synced properly. Expect some delay if the database instance is large.
