common_recordbatch/

error.rs

// Copyright 2023 Greptime Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Error of record batch.
use std::any::Any;

use common_error::ext::{BoxedError, ErrorExt};
use common_error::status_code::StatusCode;
use common_macro::stack_trace_debug;
use datafusion_common::ScalarValue;
use datatypes::prelude::ConcreteDataType;
use datatypes::schema::SchemaRef;
use snafu::{Location, Snafu};

pub type Result<T> = std::result::Result<T, Error>;

#[derive(Snafu)]
#[snafu(visibility(pub))]
#[stack_trace_debug]
pub enum Error {
    #[snafu(display("Fail to create datafusion record batch"))]
    NewDfRecordBatch {
        #[snafu(source)]
        error: datatypes::arrow::error::ArrowError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Data types error"))]
    DataTypes {
        #[snafu(implicit)]
        location: Location,
        source: datatypes::error::Error,
    },

    #[snafu(display("External error"))]
    External {
        #[snafu(implicit)]
        location: Location,
        source: BoxedError,
    },

    #[snafu(display("Failed to create RecordBatches, reason: {}", reason))]
    CreateRecordBatches {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to convert Arrow schema"))]
    SchemaConversion {
        source: datatypes::error::Error,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display(""))]
    PollStream {
        #[snafu(source)]
        error: datafusion::error::DataFusionError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Create physical expr error"))]
    PhysicalExpr {
        #[snafu(source)]
        error: datafusion::error::DataFusionError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Fail to format record batch"))]
    Format {
        #[snafu(source)]
        error: datatypes::arrow::error::ArrowError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Failed to convert {v:?} to Arrow scalar"))]
    ToArrowScalar {
        v: ScalarValue,
        #[snafu(source)]
        error: datafusion_common::DataFusionError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display(
        "Failed to project Arrow RecordBatch with schema {:?} and projection {:?}",
        schema,
        projection,
    ))]
    ProjectArrowRecordBatch {
        #[snafu(source)]
        error: datatypes::arrow::error::ArrowError,
        #[snafu(implicit)]
        location: Location,
        schema: datatypes::schema::SchemaRef,
        projection: Vec<usize>,
    },

    #[snafu(display("Column {} not exists in table {}", column_name, table_name))]
    ColumnNotExists {
        column_name: String,
        table_name: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display(
        "Failed to cast vector of type '{:?}' to type '{:?}'",
        from_type,
        to_type,
    ))]
    CastVector {
        from_type: ConcreteDataType,
        to_type: ConcreteDataType,
        #[snafu(implicit)]
        location: Location,
        source: datatypes::error::Error,
    },

    #[snafu(display("Error occurs when performing arrow computation"))]
    ArrowCompute {
        #[snafu(source)]
        error: datatypes::arrow::error::ArrowError,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Unsupported operation: {}", reason))]
    UnsupportedOperation {
        reason: String,
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Cannot construct an empty stream"))]
    EmptyStream {
        #[snafu(implicit)]
        location: Location,
    },

    #[snafu(display("Schema not match, left: {:?}, right: {:?}", left, right))]
    SchemaNotMatch {
        left: SchemaRef,
        right: SchemaRef,
        #[snafu(implicit)]
        location: Location,
    },
    #[snafu(display("Stream timeout"))]
    StreamTimeout {
        #[snafu(implicit)]
        location: Location,
        #[snafu(source)]
        error: tokio::time::error::Elapsed,
    },
    #[snafu(display("RecordBatch slice index overflow: {visit_index} > {size}"))]
    RecordBatchSliceIndexOverflow {
        #[snafu(implicit)]
        location: Location,
        size: usize,
        visit_index: usize,
    },
}

impl ErrorExt for Error {
    fn status_code(&self) -> StatusCode {
        match self {
            Error::NewDfRecordBatch { .. }
            | Error::EmptyStream { .. }
            | Error::SchemaNotMatch { .. } => StatusCode::InvalidArguments,

            Error::DataTypes { .. }
            | Error::CreateRecordBatches { .. }
            | Error::Format { .. }
            | Error::ToArrowScalar { .. }
            | Error::ProjectArrowRecordBatch { .. }
            | Error::PhysicalExpr { .. }
            | Error::RecordBatchSliceIndexOverflow { .. } => StatusCode::Internal,

            Error::PollStream { .. } => StatusCode::EngineExecuteQuery,

            Error::ArrowCompute { .. } => StatusCode::IllegalState,

            Error::ColumnNotExists { .. } => StatusCode::TableColumnNotFound,

            Error::External { source, .. } => source.status_code(),

            Error::UnsupportedOperation { .. } => StatusCode::Unsupported,

            Error::SchemaConversion { source, .. } | Error::CastVector { source, .. } => {
                source.status_code()
            }

            Error::StreamTimeout { .. } => StatusCode::Cancelled,
        }
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}