Using a profile

Connection based on a selected profile

A profile can be applied when running a YDB CLI command with the --profile <profile_name> option specified:

ydb --profile <profile_name> <command and command options>

For example:

ydb --profile mydb1 scheme ls -l

In this case, all DB connection parameters are taken from the profile. At the same time, if the authentication parameters are not specified in the profile, the YDB CLI will try to define them based on environment variables, as described in Connecting to and authenticating with a database - Environment variable.

Connection based on a selected profile and specified command line parameters

Apart from the --profile option, there may be other connection parameters specified in the command line. For example:

ydb --profile mydb1 -d /local2 scheme ls -l
ydb --profile mydb1 --user alex scheme ls -l

In this case, the connection parameters specified in the command line have priority over those stored in the profile. This format lets you reuse profiles to connect to different databases or under different accounts. In addition, specifying the authentication parameter in the command line (such as --user alex in the example above) disables environment variable checks regardless of their presence in the profile.

Connection based on an activated profile

If the --profile option is not specified in the command line, the YDB CLI will try to take from the currently activated profile all the connection parameters that it couldn't define in other ways (from command-line options or environment variables, as described in Connecting to and authenticating with a database).

Implicit use of the activated profile may cause errors, so we recommend that you read the Activated profile article before using this mode.