Documentation / Commands / EDIT ENVIRONMENT

EDIT ENVIRONMENT

Core command EDIT ENV EDENV

Edits an existing Environment

Arguments

<id> (mandatory) existing Environment ID

Examples

EDIT ENVIRONMENT PROD;

Notes

Edits an existing Environment: EDIT ENVIRONMENT <id> (docs/CONNECTION_MODEL.md §5).

id is mandatory and must already exist (matched case-insensitively per §5.1) - the command fails otherwise. Runs an interactive wizard pre-filled with the Environment's current Description, Production flag and Comment, plus an Active [y/n] prompt (this is also how an inactive Environment is reactivated from the CLI), followed by a [y/n/c] confirmation: y saves, n restarts the wizard from the top, anything else aborts without saving. Deactivating an Environment still referenced by any connection - active or inactive - or that is the last remaining active Environment, is refused by DatabaseDefinitionsVault#saveEnvironment, exactly like DEL ENVIRONMENT refuses.

Per §5.1, an Environment's ID is immutable after creation - this command never changes it, using the Environment's own stored ID (not necessarily the exact casing typed on the command line) for the save.

Last modified in release 5.1.6.