You are looking at the documentation for Postico v1.5.19 — would you like to go to the latest version
Postico supports using connection URLs for connecting to PostgreSQL servers.
A typical connection URL might look like this:
This URL would connect to a server running locally (localhost), with user name "jakob", and connect to the database "marketing"
What you can do with connection URLs
connect to a PostgreSQL server by clicking a link on a website (eg. an internal dashboard)
open Postico from the command line with the open command
create and update favorites from the command line
URL Schemes supported by Postico
Postico opens URLs with any of the following schemes:
postgres and postgresql can both be used for direct connections to PostgreSQL servers.
redshift is provided as an alternative for connecting to Amazon Redshift clusters. Postico treats it the same as postgres:
postico: is an alternative url scheme that you can use if you have multiple apps that support postgres: URLs, but want to open Postico specifically
postgres+ssh: can be used to connect to a PostgreSQL server via an SSH tunnel (see examples)
Supported Query Parameters
A nick name for the connection. Can be used when creating a new favorite, or when updating an existing favorite.
A UUID in standard format for the favorite.
If none is provided, a random UUID will be generated.
This is useful if you want to update the favorite later, but want to allow changing the nickname manually.
The database name to connect to.
The host name of the dataase server.
The user name for the dataase server
The password for the dataase server
The port number that the database is running on. Default is 5432
Can be 'true' or 'false'. Wheter to connect via SSH tunnel or not.
The host name of the SSH server.
The port of the SSH server. Default is 22
The username for authenticating with the SSH server.
The password for the SSH server.
Provide the path to a private key file for authenticating to an SSH server.
Can be 'true' or 'false'. Default 'true'.
Whether to automatically create a favorite when no matching favorite was found.
If you set this to 'false', Postico will connect to the URL without creating a favorite.
This avoids cluttering the Favorites window if you use many different connections, but it also disables some features that rely on favorites, like query history.
Can be 'true' or 'false'. Default 'true'. When this is true, Postico immediately connects to the favorite corresponding to the URL.
When it is false, Postico only shows the favorite in the favorite window, but does not connect.