Readyset Docs

Connect via Database Shell

1. Connect to Readyset using psql, the Postgres client

Readyset is wire-compatible with Postgres, so you can use psql to connect to it in the same way you would an ordinary database.

Readyset uses the same username, password and database name as your upstream database, so to connect, fill in those values in your connection string and run:

psql 'postgresql://<username>:<password>@127.0.0.1:5433/<database name>'

Once connected, you can see the status of tables in Readyset by running:

testdb=> SHOW READYSET STATUS;

1. Connect to Readyset using the MySQL client

Readyset is wire-compatible with MySQL, so you can use the mysql client to connect to it in the same way you would an ordinary database.

Readyset uses the same username, password and database name as your upstream database. To connect, fill in those values and run:

mysql -h<READYSET HOST> -u<USER> -p<PASSWORD> -P<READYSET PORT> <DATABASE>

Once connected, you can see the status of tables in Readyset by running:

mysql> SHOW READYSET STATUS;

You can also use the shell to view and cache queries: