Connections

The Connections page serves as the central hub within Prostgles UI for managing all your PostgreSQL database connections. From here, you can add and open connections, modify existing ones, and gain an immediate overview of their status and associated workspaces.

Connection controls

• New connection: Opens the form to add a new database connection.
• Display options: Customize how the list of connections is displayed (e.g., show/hide state database, show database names).
• Connection list: Controls to open and manage your database connections.

Adding a connection

Use the New Connection button to add a new database connection.

This will open a form where you can enter the connection details such as host, port, database name, user, and password.

New connection form fields

• PostgreSQL Installation Instructions: Instructions for installing PostgreSQL on your system.
• Connection Name: The name of the connection.
• Connection Type: Allows you change the connection details format: standard or connection string.
• Connection String: The connection string for the database.
• Database Host: The hostname or IP address of the database server.
• Database Port: The port number on which the database server is listening.
• Database User: The username used to connect to the database.
• Database Password: The password for the database user.
• Database Name: The name of the database to connect to.
• More Options: Additional connection options.
  • Schema Filter: Controls which schemas are visible in the dashboard (public by default).
  • Connection Timeout: The maximum time to wait for a connection to the database before timing out.
  • SSL Mode: Configure SSL settings for the connection.
  • Watch Schema: Enabled by default. Enables schema change tracking. Any changes made to the database schema are reflected in the API and UI.
  • Enable Realtime: Enabled by default. Enables realtime data change tracking for tables and views. Requires trigger permissions to the underlying tables.
• Update Connection: Save the changes made to the connection.

Connection list

The connection list displays all your database connections grouped by database host, port and user.

Connection actions

• Open connection: Opens the selected connection dashboard on the default workspace.
• Add new database: Adds a new connection to the selected server.
  • Create new database: Create a new database within the server.
  • Connect to an existing database: Selects a database from the server to connect to.
• Debug: Close All Windows: Force-closes all windows/tabs for this connection. Use if the workspace becomes unresponsive or encounters a bug.
• Status monitor: View real-time statistics, running queries, and system resource usage (CPU, RAM, Disk) for this connection.
• Connection configuration: Access and modify settings for this connection, such as access control, file storage, backup/restore options, and server-side functions.
• Edit connection details: Modify the connection parameters (e.g., display name, database details like host and port). Also allows deleting or cloning the connection.
• Status indicator/Disconnect: Shows the current connection status (green indicates connected). Click to disconnect from the database.
• Workspaces: List of workspaces associated with this connection. Click to switch to a specific workspace.

Create new database

Allows you to create a new database in the selected server. It will use the first connection details from the group connection. If no adequate account is found (no superuser or rolcreatedb), it will be greyed out with with an appropriate explanation tooltip text.

New database options

• Database Name: The name of the new database.
• Sample Schemas: Select a sample schema to create the database with.
• Create database owner: If checked, a new owner will be created for the database. Useful for ensuring the database is owned by a non-superuser account.
• New Owner Name: The name of the new owner.
• New Owner Password: The password of the new owner.
• New Owner Permission Type: Apart from Owner it is possible to create a user with reduced permission types (SELECT/UPDATE/DELETE/INSERT).
• Create and connect: Creates and connects to the new database.

Connect to an existing database

Allows you to connect to an existing database in the selected server. It will use the first connection details from the group connection.

After selecting the database, you can choose to create a new owner or user for the connection should you need to.

• Select Database: Choose a database from the server.
• Create database owner: If checked, a new owner will be created for the database. Useful for ensuring the database is owned by a non-superuser account.
• New Owner Name: The name of the new owner.
• New Owner Password: The password of the new owner.
• New Owner Permission Type: Apart from Owner it is possible to create a user with reduced permission types (SELECT/UPDATE/DELETE/INSERT).
• Save and connect: Connects to the selected database with the new owner.

Edit connection details

Connection settings, credentials, and other parameters to ensure your connection is configured correctly.

• PostgreSQL Installation Instructions: Instructions for installing PostgreSQL on your system.
• Connection Name: The name of the connection.
• Connection Type: Allows you change the connection details format: standard or connection string.
• Connection String: The connection string for the database.
• Database Host: The hostname or IP address of the database server.
• Database Port: The port number on which the database server is listening.
• Database User: The username used to connect to the database.
• Database Password: The password for the database user.
• Database Name: The name of the database to connect to.
• More Options: Additional connection options.
  • Schema Filter: Controls which schemas are visible in the dashboard (public by default).
  • Connection Timeout: The maximum time to wait for a connection to the database before timing out.
  • SSL Mode: Configure SSL settings for the connection.
  • Watch Schema: Enabled by default. Enables schema change tracking. Any changes made to the database schema are reflected in the API and UI.
  • Enable Realtime: Enabled by default. Enables realtime data change tracking for tables and views. Requires trigger permissions to the underlying tables.
• Update Connection: Save the changes made to the connection.