From a4e9fdf7160484f9bf3962152e04e1571bfd65aa Mon Sep 17 00:00:00 2001 From: Devon Campbell Date: Tue, 19 Mar 2024 12:23:01 -0400 Subject: [PATCH] Add -b connection option --- docs/cli/edgedb_connopts.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/cli/edgedb_connopts.rst b/docs/cli/edgedb_connopts.rst index 39ebbba0b36..073dc1c6476 100644 --- a/docs/cli/edgedb_connopts.rst +++ b/docs/cli/edgedb_connopts.rst @@ -71,6 +71,19 @@ Connection flags default to the name provided when the link was created. This also includes EdgeDB Cloud instance links created via :ref:`ref_cli_edgedb_project_init`. + .. note:: + + With EdgeDB 5, databases were refactored as branches. If you're using + EdgeDB 5+, use the option below instead of this one. + +:cli:synopsis:`-b , --branch=` + Specifies the name of the branch to connect to. Defaults to the value of + the ``EDGEDB_BRANCH`` environment variable. If that variable isn't set, + local instances will default to the most recently switched branch or the + ``main`` branch, while remote instances will default to the name provided + when the link was created. This also includes EdgeDB Cloud instance links + created via :ref:`ref_cli_edgedb_project_init`. + :cli:synopsis:`--password | --no-password` If :cli:synopsis:`--password` is specified, force ``edgedb`` to prompt for a password before connecting to the database. This is usually not