Enum CliError 

pub enum CliError {
    Project(ProjectError),
    Config(ConfigError),
    Connection(ConnectionError),
    DeploymentSnapshot(DeploymentSnapshotError),
    Dependency(DependencyError),
    Validation(DatabaseValidationError),
    Types(TypesError),
    DeploymentConflict {
        conflicts: Vec<ConflictRecord>,
    },
    GitShaFailed,
    GitDirty,
    NoSchemas,
    ProductionOverwriteNotAllowed {
        objects: Vec<(String, String, String)>,
    },
    DevTargetsProductionCluster {
        cluster: ProductionClusterRecord,
    },
    SetupRequired {
        missing: Vec<MissingObject>,
    },
    SetupNotDatabaseOwner {
        owner: String,
        current_role: String,
    },
    SetupRequiresSuperuser {
        current_role: String,
    },
    InvalidUnitTestTarget {
        test_name: String,
        object_id: String,
        reason: String,
    },
    DeploymentTableCreationFailed {
        source: ConnectionError,
    },
    SqlExecutionFailed {
        statement: String,
        source: ConnectionError,
    },
    SinkRepointFailed {
        sink: String,
        reason: String,
    },
    DeploymentStateWriteFailed {
        source: ConnectionError,
    },
    InvalidEnvironmentName {
        name: String,
    },
    SchemaNotFound {
        database: String,
        schema: String,
    },
    ClusterNotFound {
        name: String,
    },
    TestsFailed {
        failed: usize,
        passed: usize,
    },
    TestsFilterMissed {
        filter: String,
    },
    TestValidationFailed(TestValidationError),
    TypeCheckFailed(TypeCheckError),
    ReadyTimeout {
        name: String,
        seconds: u64,
    },
    Io(Error),
    ClustersHydrating,
    DeploymentFailing {
        name: String,
    },
    NewObjectInExistingStableSchema {
        database: String,
        schema: String,
        objects: Vec<String>,
    },
    SecretResolution {
        secret_name: String,
        source: SecretResolveError,
    },
    ClusterNotReady {
        cluster: String,
        reason: String,
    },
    NoMzDeployRole,
    MultipleMzDeployRoles {
        roles: Vec<String>,
    },
    RoleNotAuthorized {
        current_role: String,
        required_role: String,
    },
    MissingCreatedb {
        role: String,
        overlay_db: String,
    },
    InvalidProjectDirectory {
        path: String,
    },
    UndeclaredDependencies {
        undeclared: Vec<ObjectId>,
    },
    DeclaredDependenciesMissing {
        missing: Vec<ObjectId>,
    },
    Message(String),
}

Top-level error type for CLI operations.

This wraps errors from project loading, database operations, and adds CLI-specific error variants.

Variants

Project(ProjectError)

Error during project compilation/loading

Config(ConfigError)

Configuration loading error

Connection(ConnectionError)

Database connection error

DeploymentSnapshot(DeploymentSnapshotError)

Deployment snapshot operation error

Dependency(DependencyError)

Dependency analysis error

Validation(DatabaseValidationError)

Validation error (missing databases, schemas, clusters)

Types(TypesError)

Types lock file error

DeploymentConflict

Deployment conflict detected - schemas were updated after deployment started

Fields

conflicts: Vec<ConflictRecord>

GitShaFailed

Failed to determine git SHA

GitDirty

Git repository has uncommitted changes

NoSchemas

No schemas to deploy

ProductionOverwriteNotAllowed

Attempting to overwrite production objects without proper safety flags

Fields

objects: Vec<(String, String, String)>

DevTargetsProductionCluster

dev would deploy to a cluster that hosts a promoted deployment.

Fields

cluster: ProductionClusterRecord

SetupRequired

Required mz-deploy infrastructure is missing or partially installed. Emitted by every non-setup command when setup::verify fails.

Fields

missing: Vec<MissingObject>

SetupNotDatabaseOwner

setup was invoked by a role that is not the owner of the existing _mz_deploy database. Only the owner can re-run setup.

Fields

owner: String

current_role: String

SetupRequiresSuperuser

setup was invoked by a non-superuser. Setup issues GRANT ... ON SYSTEM statements that only superusers can execute.

Fields

current_role: String

InvalidUnitTestTarget

A unit test targets an object that isn’t a view or materialized view. Unlike assertion mismatches, this is a project-definition error: the test run aborts rather than reporting it as a failed test.

Fields

test_name: String

object_id: String

reason: String

DeploymentTableCreationFailed

Failed to create deployment table

Fields

source: ConnectionError

SqlExecutionFailed

Failed to execute SQL during deployment

Fields

statement: String

source: ConnectionError

SinkRepointFailed

Failed to repoint a sink to a new upstream object

Fields

sink: String

reason: String

DeploymentStateWriteFailed

Failed to write deployment state

Fields

source: ConnectionError

InvalidEnvironmentName

Invalid staging environment name

Fields

name: String

SchemaNotFound

Schema does not exist in database

Fields

database: String

schema: String

ClusterNotFound

Cluster does not exist

Fields

name: String

TestsFailed

Tests failed during execution

Fields

failed: usize

passed: usize

TestsFilterMissed

Tests filter did not match anythinh

Fields

filter: String

TestValidationFailed(TestValidationError)

Test validation failed (schema mismatch, missing mocks)

TypeCheckFailed(TypeCheckError)

Type check failed

ReadyTimeout

Timeout waiting for deployment to be ready

Fields

name: String

seconds: u64

Io(Error)

I/O error

ClustersHydrating

Clusters are not yet hydrated

DeploymentFailing

Deployment is failing due to cluster health issues

Fields

name: String

NewObjectInExistingStableSchema

Cannot add new objects to an existing stable schema during incremental deployment

Fields

database: String

schema: String

objects: Vec<String>

SecretResolution

Secret resolution failed

Fields

secret_name: String

source: SecretResolveError

ClusterNotReady

Cluster is not ready for mz-deploy operations

Fields

cluster: String

reason: String

NoMzDeployRole

Current role has no mz-deploy role membership

MultipleMzDeployRoles

Current role has multiple mz-deploy role memberships

Fields

roles: Vec<String>

RoleNotAuthorized

Current role is not authorized for this operation

Fields

current_role: String

required_role: String

MissingCreatedb

Current role lacks CREATEDB privilege required to create overlay databases

Fields

role: String

overlay_db: String

InvalidProjectDirectory

Project directory has no basename usable as a project identifier (e.g. root or .).

Fields

path: String

UndeclaredDependencies

Project references external objects not declared in project.toml

Fields

undeclared: Vec<ObjectId>

DeclaredDependenciesMissing

Declared dependencies not found in the target database during lock

Fields

missing: Vec<ObjectId>

Message(String)

Generic error message

Implementations

impl CliError

pub fn hint(&self) -> Option<String>

Get contextual hint for resolving this error.

Returns None for errors that wrap other error types (they provide their own hints).

Trait Implementations

impl Debug for CliError

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

Formats the value using the given formatter.

impl Display for CliError

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

Formats the value using the given formatter.

impl Error for CliError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ConfigError> for CliError

fn from(source: ConfigError) -> Self

Converts to this type from the input type.

impl From<ConnectionError> for CliError

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.

impl From<DatabaseValidationError> for CliError

fn from(error: DatabaseValidationError) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<String> for CliError

fn from(msg: String) -> Self

Converts to this type from the input type.