Connecting to PostgreSQL

1. Open the connections page in preferences, see managing connections for more information.
2. Click the Add new Connection button at the top of the connections page.
   
3. Select PostgreSQL from the list.
   
4. Give a Connection name for your own internal reference.
5. For Hostname, enter the hostname of your database server.
6. For Port, use the default 5432, or enter the port used by your server.
7. For Database, enter the name of your database.
8. Select how to connect to database. See below for details on using AWS IAM.
9. If using Username/Password, for Username and Password, enter the username and password for PostgreSQL. These are optional.
10. Toggle connection type for direct or cloud.
11. Share the connection with your team.
12. Configure SSH and SSL settings. These are optional.
13. Hit Connect and you're all set!

Happy querying! 🍭

AWS RDS IAM

If you need to use AWS IAM to sign into your PostgreSQL AWS RDS database, we support that on our Enterprise plan. Please get in touch with us if this applies to you.

Once enabled, you will be able to select one of the "Amazon RDS IAM" authentication methods for the connection. When using the credentials method, you will be asked for the Region, AWS Access Key ID, AWS Secret Access Key, and optionally the AWS Session Token, which can be acquired by going through the My Security Credentials page on AWS or provided by your administrator. For the profile method, you will be asked for Profile which corresponds to the named profile you have configured within the AWS CLI. When authenticating, PopSQL will then open that file to read the stored credential information. For the "Okta" method, it will utilize the AWS Account Federation integration through Okta to authenticate. You will need to provide your Okta organization (e.g. acme.okta.com), the "App Embed Url" for the integration, the region you wish to use, the role to authenticate with, and your okta username / password.

For both methods, you will also be asked for a Username corresponds to the DB user you wish to use to connect to the database. It is expected that your administrator has separately setup the appropriate IAM Policy and Database User Account for you to use here.

This authentication mechanism only works with direct connections, so please make sure your computer can reach RDS (i.e. you may need to configure need to configure the RDS VPC to allow your IP address).