Common Connection Options

Various EdgeDB terminal tools such as edgedb repl, edgedb configure, edgedb dump, and edgedb restore use the following connection options:

-I name, --instance=name

Specifies the named instance to connect too. The actual connection parameters are stored in $HOME/.edgedb/credentials and are usually created by edgedb server init or similar commands.

-H hostname, --host=hostname

Specifies the host name of the machine on which the server is running. If hostname begins with a slash (/), it is used as the directory where the command looks for the server Unix-domain socket. Defaults to the value of the EDGEDB_HOST environment variable.

-P port, --port=port

Specifies the TCP port or the local Unix-domain socket file extension on which the server is listening for connections. Defaults to the value of the EDGEDB_PORT environment variable or, if not set, to 5656.

-u username, --user=username

Connect to the database as the user username. Defaults to the value of the EDGEDB_USER environment variable, or, if not set, to the login name of the current OS user.

-d dbname, --database=dbname

Specifies the name of the database to connect to. Default to the value of the EDGEDB_DATABASE environment variable, or, if not set, to the calculated value of username.

--dsn=dsn

Specifies the DSN for EdgeDB to connect to (overrides all other options except password)

--admin

If specified, attempt to connect to the server via the administrative Unix-domain socket. The user must have permission to access the socket, but no other authentication checks are performed.

--password | --no-password

If --password is specified, force edgedb to prompt for a password before connecting to the database. This is usually not necessary, since edgedb will prompt for a password automatically if the server requires it.

Specifying --no-password disables all password prompts.

--password-from-stdin

Use the first line of standard input as the password.

--connect-timeout=timeout

Specifies a timeout period. In case EdgeDB doesn’t respond for this period the command will fail (or retry if --wait-until-available is also specified). The timeout value must be given using time units (e.g. hr, min, sec, ms, etc.). The default value is 10s.

--wait-until-available=wait_time

In case EdgeDB connection can’t be established, keep retrying up to wait_time (e.g. 30s).