Enum DataFusionError

pub enum DataFusionError {
    ArrowError(ArrowError, Option<String>),
    IoError(Error),
    SQL(ParserError, Option<String>),
    NotImplemented(String),
    Internal(String),
    Plan(String),
    Configuration(String),
    SchemaError(SchemaError, Box<Option<String>>),
    Execution(String),
    ExecutionJoin(JoinError),
    ResourcesExhausted(String),
    External(GenericError),
    Context(String, Box<DataFusionError>),
    Substrait(String),
}

DataFusion error

Variants

ArrowError(ArrowError, Option<String>)

Error returned by arrow.

2nd argument is for optional backtrace

IoError(Error)

Error when an I/O operation fails

SQL(ParserError, Option<String>)

Error when SQL is syntactically incorrect.

2nd argument is for optional backtrace

NotImplemented(String)

Error when a feature is not yet implemented.

These errors are sometimes returned for features that are still in development and are not entirely complete. Often, these errors are tracked in our issue tracker.

Internal(String)

Error due to bugs in DataFusion

This error should not happen in normal usage of DataFusion. It results from something that wasn’t expected/anticipated by the implementation and that is most likely a bug (the error message even encourages users to open a bug report). A user should not be able to trigger internal errors under normal circumstances by feeding in malformed queries, bad data, etc.

Note that I/O errors (or any error that happens due to external systems) do NOT fall under this category. See other variants such as Self::IoError and Self::External.

DataFusions has internal invariants that the compiler is not always able to check. This error is raised when one of those invariants does not hold for some reason.

Plan(String)

Error during planning of the query.

This error happens when the user provides a bad query or plan, for example the user attempts to call a function that doesn’t exist, or if the types of a function call are not supported.

Configuration(String)

Error for invalid or unsupported configuration options.

SchemaError(SchemaError, Box<Option<String>>)

Error when there is a problem with the query related to schema.

This error can be returned in cases such as when schema inference is not possible and when column names are not unique.

2nd argument is for optional backtrace Boxing the optional backtrace to prevent https://rust-lang.github.io/rust-clippy/master/index.html#/result_large_err

Execution(String)

Error during execution of the query.

This error is returned when an error happens during execution due to a malformed input. For example, the user passed malformed arguments to a SQL method, opened a CSV file that is broken, or tried to divide an integer by zero.

ExecutionJoin(JoinError)

JoinError during execution of the query.

This error can unoccur for unjoined tasks, such as execution shutdown.

ResourcesExhausted(String)

Error when resources (such as memory of scratch disk space) are exhausted.

This error is thrown when a consumer cannot acquire additional memory or other resources needed to execute the query from the Memory Manager.

External(GenericError)

Errors originating from outside DataFusion’s core codebase.

For example, a custom S3Error from the crate datafusion-objectstore-s3

Context(String, Box<DataFusionError>)

Error with additional context

Substrait(String)

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

Implementations

impl DataFusionError

pub const BACK_TRACE_SEP: &'static str = "\n\nbacktrace: "

The separator between the error message and the backtrace

pub fn find_root(&self) -> &Self

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>) -> Self

wraps self in Self::Context with a description

pub fn strip_backtrace(&self) -> String

Strips backtrace out of the error message If backtrace enabled then error has a format “message” Self::BACK_TRACE_SEP “backtrace” The method strips the backtrace and outputs “message”

pub fn get_back_trace() -> String

To enable optional rust backtrace in DataFusion:

• [Setup Env Variables]https://doc.rust-lang.org/std/backtrace/index.html#environment-variables
• Enable backtrace cargo feature

Example: cargo build –features ‘backtrace’ RUST_BACKTRACE=1 ./app

pub fn message(&self) -> Cow<'_, str>

Trait Implementations

impl Debug for DataFusionError

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

Formats the value using the given formatter.

impl Display for DataFusionError

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

Formats the value using the given formatter.

impl Error for DataFusionError

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<ArrowError> for DataFusionError

fn from(e: ArrowError) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error + Sync + Send>> for DataFusionError

fn from(err: GenericError) -> Self

Converts to this type from the input type.

impl From<DataFusionError> for ArrowError

fn from(e: DataFusionError) -> Self

Converts to this type from the input type.

impl From<DataFusionError> for Error

fn from(e: DataFusionError) -> Self

Converts to this type from the input type.

impl From<Error> for DataFusionError

fn from(_e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DataFusionError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<ParserError> for DataFusionError

fn from(e: ParserError) -> Self

Converts to this type from the input type.