CLI reference / database / declare

stado database declare

Invocation

stado database declare [OPTIONS] --engine <ENGINE> --consumer <CONSUMERS> <NAME>

Purpose

Declare a database in the Stado configuration. Writes `database_api.databases.<name>` through the same validated, atomic write every other configuration change uses. The credential item `<name>-database` is implied; provision its fields with `stado secrets put <name>-database`.

Required inputs and options

Input or optionContract
<NAME>Logical database name (lowercase letters, digits, dashes)
--engine <ENGINE>Database engine
--scope <SCOPES>Access scopes to grant the declaration (read, write)
--consumer <CONSUMERS>Consumer allowed to resolve this database
--jsonEmit machine-readable output

Output and state effect

It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.

Refusals

  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.