Announcing autoscaling in feature-preview!Learn More
Connect

Connect a GUI or IDE

This topic describes how to connect to a Neon database from a GUI application or IDE. Most GUI applications and IDEs that support connecting to a PostgreSQL database also support connecting to Neon.

Gather your connection details

The following details are typically required when configuring a connection:

  • hostname
  • port
  • database name
  • role name
  • password

You can gather most of these details from the Connection Details widget on the Neon Dashboard. Select a branch, a role, and the database you want to connect to. A connection string is constructed for you.

Connection details widget

The connection string includes the role name, hostname, and database name.

postgres://sally@ep-cold-poetry-404091.us-east-2.aws.neon.tech/neondb
             ^                       ^                          ^
             |- <role name>          |- <hostname>              |- <database name>
  • role name: sally
  • hostname: ep-cold-poetry-404091.us-east-2.aws.neon.tech
  • database name: neondb

Passwords are only shown when they are created. If you misplaced your password, you can reset it by selecting the Reset Password link in the Connection Details widget or by navigating to the Roles page.

Neon uses the default PostgreSQL port, 5432.

Connect to the database

In the GUI application or IDE, enter the connection details into the appropriate fields and connect. In the pgAdmin example shown below, clicking Save establishes the database connection.

Register - Server

If the connection is successful, you should be able to view and interact with your database from the GUI application or IDE.

Tested GUI applications and IDEs

Connections from the following GUI applications and IDEs have been tested with Neon:

Connection issues

Applications that use older client libraries or drivers that do not support Server Name Indication (SNI) may not permit connecting to Neon. If you encounter the following error, refer to Connect from older clients for possible workarounds.

ERROR: The endpoint ID is not specified. Either upgrade the PostgreSQL client library (libpq) for SNI support or pass the endpoint ID (the first part of the domain name) as a parameter: '&options=project%3D'. See [https://neon.tech/sni](https://neon.tech/sni) for more information.

Need help?

Send a request to support@neon.tech, or join the Neon community forum.

Edit this page
Was this page helpful?