Enum TopCommand 

pub enum TopCommand {
    Shell,
    Db {
        command: DbCommand,
    },
    Migrations {
        command: MigrationsCommand,
    },
    Migrate {
        command: MigrateCommand,
    },
    Live {
        command: LiveCmd,
    },
    Docs {
        output: Option<PathBuf>,
        workspace: Option<PathBuf>,
    },
    Verify {
        workspace: Option<PathBuf>,
    },
    Schema {
        format: SchemaFormat,
        output: Option<PathBuf>,
    },
    Analyze {
        format: AnalyzeFormat,
        threshold_vacuum: f64,
        threshold_partition_rows: i64,
        workspace: Option<PathBuf>,
    },
}

Variants

Shell

Launch interactive Rhai shell.

Db

Database management.

Fields

command: DbCommand

Migrations

Schema migration tooling .

Fields

command: MigrationsCommand

Migrate

Compatibility alias for djogi migrations. See djogi migrations --help for the full command tree. Currently only apply is supported as an alias: djogi migrate apply delegates to djogi migrations apply.

Fields

command: MigrateCommand

Live

Live-migration operator surface — drives expand → backfill → flip → contract sequences for ExpandContract- classified deltas. Requires PostgreSQL 18 or later.

Fields

command: LiveCmd

Docs

Render Markdown documentation from the descriptor inventory. One file per registered model under <output>/<app>/, plus a top-level README.md index. Output is byte-deterministic against the same descriptor set.

Fields

output: Option<PathBuf>

Output directory. Defaults to <workspace>/target/djogi-docs/.

workspace: Option<PathBuf>

Workspace root override. Defaults to the current working directory.

Verify

6 — read-only HMAC cross-check of every migrations/<target>/<app>/schema_snapshot.json against the audit DB’s djogi_ddl_audit ledger. Requires PostgreSQL 18 or later — exits with code 2 if the server is below the minimum. Exit codes: 0 when every snapshot reports OK or Skipped (audit table absent or no audit row yet), 1 on any mismatch or runtime error (config / connect / I/O / key decode). Read-only. Verify never issues INSERT, UPDATE, DELETE, or DDL — the only SQL leaving the CLI is a positional-bind SELECT against djogi_ddl_audit.

Fields

workspace: Option<PathBuf>

Workspace root override. Defaults to the current working directory.

Schema

2 — JSON descriptor dump. Emits a deterministic JSON document covering every model registered via inventory::submit!. Use for agent integration, CI assertions on schema drift, and machine-readable handoffs to downstream codegen. Read-only. Schema never opens a Postgres connection; the inventory walk is fully in-process.

Fields

format: SchemaFormat

Output format. json is the only value in v0.1.0; openapi and markdown are reserved for .

output: Option<PathBuf>

Optional output file. Absent means stdout.

Analyze

Partition / vacuum analysis for adopter Postgres tables. Queries pg_stat_user_tables (and, when installed, pg_partman) and recommends vacuum / partition actions per the precedence laid out in analyze::Recommendation. Requires PostgreSQL 18 or later — exits with code 2 if the server is below the minimum. Read-only. Analyze issues only SELECT against system catalogues; it never writes.

Fields

format: AnalyzeFormat

Output format. human (default) prints one line per table; json emits a deterministic, sorted array of {table, recommendation} objects suitable for CI dashboards.

threshold_vacuum: f64

Dead-tuple ratio strictly above which VacuumNeeded fires. Default 0.2 (20% bloat) — typical OLTP workloads tighten this; warehouse workloads tend to leave it as-is. Validated at parse time via [parse_threshold_vacuum]: rejects NaN / infinity / values outside [0.0, 1.0] so silent “never-fires” misconfigurations are impossible.

threshold_partition_rows: i64

Live row count strictly above which an unpartitioned table triggers PartitionRecommended. Default 10_000_000. The same threshold drives the per-partition row average that fires PartitionCountIncrease.

workspace: Option<PathBuf>

Workspace root override. Defaults to the current working directory. Mirrors djogi verify --workspace.

Trait Implementations

impl FromArgMatches for TopCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for TopCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand