Struct PurgeArgs 

pub struct PurgeArgs {
    pub name_positional: Option<String>,
    pub name: Option<String>,
    pub namespace: Option<String>,
    pub retention_days: u32,
    pub older_than_seconds: Option<u64>,
    pub dry_run: bool,
    pub yes: bool,
    pub now: bool,
    pub json: bool,
    pub db: Option<String>,
}

Purge args.

Fields

name_positional: Option<String>

Memory name as a positional argument. Alternative to --name.

GAP-SG-272: matches the spelling delete-entity, reclassify, rename-entity and split-body already accept. The conflict is declared here only, because clap’s conflicts are symmetric and stating it once keeps the two spellings from drifting apart. Both spellings stay optional because omitting the name is what selects the bulk mode driven by --retention-days.

name: Option<String>

Soft-deleted memory to purge, narrowing the run to that single name.

Mutually exclusive with the NAME positional. When neither spelling is supplied, purge runs in bulk mode and removes every soft-deleted memory of the namespace that is older than --retention-days. When one of them is supplied, the retention window still applies: a memory newer than the cutoff is not purged and the command fails as not found.

namespace: Option<String>

Namespace to purge. Defaults to contextual namespace (config / flag / global).

retention_days: u32

Retention days: memories with deleted_at older than (now - retention_days*86400) will be permanently removed. Default: PURGE_RETENTION_DAYS_DEFAULT (90). Use 0 to purge all soft-deleted memories regardless of age. Alias: --max-age-days.

older_than_seconds: Option<u64>

[DEPRECATED in v2.0.0] Legacy alias — use –retention-days instead.

dry_run: bool

Does not execute DELETE: computes and reports what WOULD be purged.

yes: bool

Confirms destructive intent for tools that require explicit acknowledgement. Does NOT override --retention-days: combine with --now or --retention-days 0 to wipe every soft-deleted memory regardless of age.

now: bool

Equivalent to --retention-days 0 (purge all soft-deleted, any age).

json: bool

Emit machine-readable JSON on stdout.

db: Option<String>

Path to the SQLite database file.

Trait Implementations

impl Args for PurgeArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

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

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

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

impl FromArgMatches for PurgeArgs

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.