Enum datafusion::error::DataFusionError

pub enum DataFusionError {
    ArrowError(ArrowError),
    ParquetError(ParquetError),
    ObjectStore(Error),
    IoError(Error),
    SQL(ParserError),
    NotImplemented(String),
    Internal(String),
    Plan(String),
    SchemaError(SchemaError),
    Execution(String),
    ResourcesExhausted(String),
    External(Box<dyn Error + Send + Sync + 'static, Global>),
    Context(String, Box<DataFusionError, Global>),
    Substrait(String),
}

DataFusion error

Variants

ArrowError(ArrowError)

Error returned by arrow.

ParquetError(ParquetError)

Wraps an error from the Parquet crate

ObjectStore(Error)

Wraps an error from the object_store crate

IoError(Error)

Error associated to I/O operations and associated traits.

SQL(ParserError)

Error returned when SQL is syntactically incorrect.

NotImplemented(String)

Error returned on a branch that we know it is possible but to which we still have no implementation for. Often, these errors are tracked in our issue tracker.

Internal(String)

Error returned as a consequence of an error in DataFusion. This error should not happen in normal usage of DataFusion.

Plan(String)

This error happens whenever a plan is not valid. Examples include impossible casts.

SchemaError(SchemaError)

This error happens with schema-related errors, such as schema inference not possible and non-unique column names.

Execution(String)

Error returned during execution of the query. Examples include files not found, errors in parsing certain types.

ResourcesExhausted(String)

This error is thrown when a consumer cannot acquire memory from the Memory Manager we can just cancel the execution of the partition.

External(Box<dyn Error + Send + Sync + 'static, Global>)

Errors originating from outside DataFusion’s core codebase. For example, a custom S3Error from the crate datafusion-objectstore-s3

Context(String, Box<DataFusionError, Global>)

Error with additional context

Substrait(String)

Errors originating from either mapping LogicalPlans to/from Substrait plans or serializing/deserializing protobytes to Substrait plans

Implementations

impl DataFusionError

pub fn find_root(&self) -> &DataFusionError

Get deepest underlying DataFusionError

DataFusionErrors sometimes form a chain, such as DataFusionError::ArrowError() in order to conform to the correct error signature. Thus sometimes there is a chain several layers deep that can obscure the original error. This function finds the lowest level DataFusionError possible.

For example, find_root will returnDataFusionError::ResourceExhausted given the input

DataFusionError::ArrowError
  ArrowError::External
   Box(DataFusionError::Context)
     DataFusionError::ResourceExhausted

This may be the same as self.

pub fn context(self, description: impl Into<String>) -> DataFusionError

wraps self in Self::Context with a description

Trait Implementations

impl Debug for DataFusionError

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

Formats the value using the given formatter.

impl Display for DataFusionError

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

Formats the value using the given formatter.

impl Error for DataFusionError

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

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, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl From<ArrowError> for DataFusionError

fn from(e: ArrowError) -> DataFusionError

Converts to this type from the input type.

impl From<Box<dyn Error + Send + Sync + 'static, Global>> for DataFusionError

fn from(err: Box<dyn Error + Send + Sync + 'static, Global>) -> DataFusionError

Converts to this type from the input type.

impl From<Error> for DataFusionError

fn from(_e: Error) -> DataFusionError

Converts to this type from the input type.

impl From<Error> for DataFusionError

fn from(e: Error) -> DataFusionError

Converts to this type from the input type.

impl From<Error> for DataFusionError

fn from(e: Error) -> DataFusionError

Converts to this type from the input type.

impl From<Error> for DataFusionError

fn from(e: Error) -> DataFusionError

Converts to this type from the input type.

impl From<ParquetError> for DataFusionError

fn from(e: ParquetError) -> DataFusionError

Converts to this type from the input type.

impl From<ParserError> for DataFusionError

fn from(e: ParserError) -> DataFusionError

Converts to this type from the input type.