Struct DataSnapshotParams 

pub struct DataSnapshotParams {
    pub table: Option<String>,
    pub scope: Option<String>,
    pub dry_run: Option<bool>,
    pub upload: Option<bool>,
}

Parameters for the data_snapshot MCP tool.

All fields are optional; None means “all” (tables / scopes). The dry_run flag, when true, returns inspection metadata without touching any file or database state (Crux: dry_run zero-write guarantee).

Fields

table: Option<String>

Target a single table by name. When None, all mounted tables in the given scope (or all scopes) are snapshotted.

scope: Option<String>

Restrict operation to "project" or "user" scope. When None, all scopes are considered.

dry_run: Option<bool>

When true, returns affects metadata (target tables, row counts, would-purge counts) without creating, modifying, or deleting any file or database state (Crux: dry_run zero-write guarantee).

upload: Option<bool>

When true, each written snapshot is additionally uploaded to the S3-compatible destination configured via MINI_APP_S3_* environment variables (requires the s3-upload cargo feature).

Configuration is validated before any snapshot is written: a build without the feature or incomplete env returns UPLOAD_NOT_CONFIGURED immediately. Individual upload failures are non-fatal — local snapshot and purge results stand, and failures are reported in the upload_errors[] response field. Combined with dry_run=true, the configuration is still validated but no upload is attempted.

Trait Implementations

impl Debug for DataSnapshotParams

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

Formats the value using the given formatter.

impl Default for DataSnapshotParams

fn default() -> DataSnapshotParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DataSnapshotParams

where DataSnapshotParams: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for DataSnapshotParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.