Enum Command 

pub enum Command {
    Serve {
        db_dir: PathBuf,
        addr: SocketAddr,
        ui: ServeUi,
        demo_if_empty: bool,
        token: Option<String>,
        role_tokens: Vec<(String, String)>,
        snapshot_every: Option<Duration>,
    },
    Mcp {
        db_dir: PathBuf,
    },
    Stats {
        db_dir: PathBuf,
    },
    Demo {
        db_dir: PathBuf,
    },
    AsOf {
        db_dir: PathBuf,
        commit: u64,
        query: Option<String>,
    },
    Suggest {
        db_dir: PathBuf,
    },
    Algo {
        db_dir: PathBuf,
        subcmd: AlgoSubcmd,
        top: usize,
        dir: AlgoDir,
    },
    Query {
        db_dir: PathBuf,
        cypher: String,
    },
    Snapshot {
        db_dir: PathBuf,
        keep_wal: bool,
        archive_wal: bool,
        retention: Option<u32>,
    },
    SchemaApply {
        db_dir: PathBuf,
        schema_file: PathBuf,
    },
    Migrate {
        db_dir: PathBuf,
    },
    Verify {
        db_dir: PathBuf,
    },
    Backup {
        db_dir: PathBuf,
        dest: PathBuf,
    },
    Export {
        db_dir: PathBuf,
        dest: PathBuf,
        format: ExportFormat,
    },
    Help,
}

Parsed mushroomdb invocation.

Variants

Serve

Fields

db_dir: PathBuf

addr: SocketAddr

ui: ServeUi

demo_if_empty: bool

If the db dir is missing or empty, run run_demo before serving. Docker’s default CMD uses this so a fresh volume is ready on first boot.

token: Option<String>

Bearer token for non-loopback binds. Loopback may omit it.

role_tokens: Vec<(String, String)>

Role-bound tokens from --role-token TOKEN:ROLE flags. Merged with MUSHROOMDB_ROLE_TOKENS env var in main before serving.

snapshot_every: Option<Duration>

Periodic snapshot cadence. None = off (default).

Mcp

Fields

db_dir: PathBuf

Stats

Fields

db_dir: PathBuf

Demo

Fields

db_dir: PathBuf

AsOf

Read-only view of the database at a past commit.

Fields

db_dir: PathBuf

commit: u64

0-based WAL commit index to replay up to (inclusive).

query: Option<String>

Optional Cypher read query to execute against the as-of view.

Suggest

Profile the database and suggest linking rules with estimated edge counts.

Fields

db_dir: PathBuf

Algo

Run a graph algorithm (pagerank / wcc / degree).

Fields

db_dir: PathBuf

subcmd: AlgoSubcmd

top: usize

Print only the top N results (0 = all).

dir: AlgoDir

Edge direction for degree/pagerank (out / in / both). Ignored by wcc, which is always undirected.

Query

Run a Cypher query (read or write).

Fields

db_dir: PathBuf

cypher: String

Positional after dir (remaining args joined), or --query.

Snapshot

Write snapshot.bin (default truncates WAL unless --keep-wal).

Fields

db_dir: PathBuf

keep_wal: bool

archive_wal: bool

Rename WAL to wal.<commit_seq>.archive before writing fresh baseline.

retention: Option<u32>

Keep the newest N archives; prune oldest at snapshot time. None = unlimited. Applies only when archive_wal is true.

SchemaApply

Apply a JSON schema file idempotently (schema apply <db-dir> <schema.json>).

Fields

db_dir: PathBuf

schema_file: PathBuf

Migrate

Migrate an old-format snapshot to the current version and keep .bak.

Fields

db_dir: PathBuf

Verify

Validate CRC32 integrity of every section in the V8 snapshot.

Fields

db_dir: PathBuf

Backup

Create a consistent, verified copy of the database directory.

Fields

db_dir: PathBuf

dest: PathBuf

Export

Export all nodes, edges, and rules to a destination directory.

Fields

db_dir: PathBuf

dest: PathBuf

format: ExportFormat

Help

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Command

impl PartialEq for Command

fn eq(&self, other: &Command) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Command