Enum mz_persist_client::cli::inspect::Command

pub(crate) enum Command {
    State(StateArgs),
    StateRollup(StateRollupArgs),
    StateRollups(StateArgs),
    BlobCount(BlobArgs),
    BlobBatchPart(BlobBatchPartArgs),
    ConsolidatedSize(StateArgs),
    UnreferencedBlobs(StateArgs),
    ShardStats(BlobArgs),
    BlobUsage(StateArgs),
    StateDiff(StateArgs),
}

Individual subcommands of inspect

Variants

State(StateArgs)

Prints latest consensus state as JSON

StateRollup(StateRollupArgs)

Prints latest consensus rollup state as JSON

StateRollups(StateArgs)

Prints consensus rollup state of all known rollups as JSON

BlobCount(BlobArgs)

Prints the count and size of blobs in an environment

BlobBatchPart(BlobBatchPartArgs)

Prints blob batch part contents

ConsolidatedSize(StateArgs)

Prints consolidated and unconsolidated size, in bytes and update count

UnreferencedBlobs(StateArgs)

Prints the unreferenced blobs across all shards

ShardStats(BlobArgs)

Prints various statistics about the latest rollups for all the shards in an environment

BlobUsage(StateArgs)

Prints information about blob usage for a shard

StateDiff(StateArgs)

Prints each consensus state change as JSON. Output includes the full consensus state before and after each state transitions:

{
    "previous": previous_consensus_state,
    "new": new_consensus_state,
}

This is most helpfully consumed using a JSON diff tool like jd. A useful incantation to show only the changed fields between state transitions:

persistcli inspect state-diff --shard-id <shard> --consensus-uri <consensus_uri> |
    while read diff; do
        echo $diff | jq '.new' > temp_new
        echo $diff | jq '.previous' > temp_previous
        echo $diff | jq '.new.seqno'
        jd -color -set temp_previous temp_new
    done

Trait Implementations

impl Debug for Command

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

Formats the value using the given formatter.

impl FromArgMatches for Command

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 Command

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand