Database Lab access using the pgai
Ruby gem
contribute
@mbobin created the pgai
Ruby Gem that
greatly simplifies access to a database clone, with support for:
- Access to all database clones listed in the Postgres.ai instances page;
- Multiple
psql
sessions on the same clone.
If you have AllFeaturesUser
psql
access,
you can follow the steps below to configure the pgai
Gem:
To get started, you need to gather some values from the Postgres.ai instances page:
Go to the instance that you want to configure and the on right side of the screen.
Under Connection, select Connect. The menu might be collapsed.
A dialog with everything that’s needed for configuration appears, using this format:
dblab init --url "http://127.0.0.1:<local-port>" --token TOKEN --environment-id <environment-id>
ssh -NTML <local-port>:localhost:<instance-port> <instance-host> -i ~/.ssh/id_rsa
To configure
ssh
, follow the instruction at Access the console withpsql
, replacing${USER}
with your postgres.ai username.Run the following commands:
gem install pgai # Before running the following command, # grab an access token from https://console.postgres.ai/gitlab/tokens pgai config --prefix=<postgresai-user> # Grab the respective port values from https://console.postgres.ai/gitlab/instances # for the instances you'll be using (in this case, for the `main` database instance) pgai env add --alias main --id <instance-host> --port <instance-port> -n <database_name>
Once this one-time configuration is done, you can use
pgai connect
to connect to a particular database. For instance, to connect to themain
database:pgai connect main
Once done with the clone, you can destroy it:
pgai destroy main
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support