iridium_core 0.1.0

SQL Server-compatible Rust engine core for Iridium SQL
Documentation
use crate::ast::{IsolationLevel, Statement};
use crate::catalog::CatalogImpl;
use crate::error::DbError;
use crate::parser::parse_sql_with_quoted_ident;
use crate::storage::InMemoryStorage;

use super::super::durability::DurabilitySink;
use super::super::journal::Journal;
use super::super::locks::SessionId;
use super::super::result::QueryResult;
use super::super::session::SessionManager;
use super::super::tooling::{ExecutionTrace, ExplainPlan, SessionOptions};
use super::persistence::DatabaseInner;
use super::{CheckpointManager, SqlAnalyzer, StatementExecutor};
use super::{EngineCatalog, EngineStorage};

pub struct EngineInner<C, S>
where
    C: EngineCatalog,
    S: EngineStorage,
{
    db: DatabaseInner<C, S>,
    pub(crate) default_session: SessionId,
}

impl<C, S> std::fmt::Debug for EngineInner<C, S>
where
    C: EngineCatalog,
    S: EngineStorage,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Engine")
            .field("default_session", &self.default_session)
            .finish()
    }
}

impl Default for EngineInner<CatalogImpl, InMemoryStorage> {
    fn default() -> Self {
        Self::new()
    }
}

impl EngineInner<CatalogImpl, InMemoryStorage> {
    pub fn new() -> Self {
        let db = DatabaseInner::new();
        let default_session = db.session_manager().create_session();
        Self {
            db,
            default_session,
        }
    }

    pub fn from_checkpoint(payload: &str) -> Result<Self, DbError> {
        let db = DatabaseInner::from_checkpoint(payload)?;
        let default_session = db.session_manager().create_session();
        Ok(Self {
            db,
            default_session,
        })
    }

    pub fn reset(&self) {
        self.db.reset();
    }

    pub fn new_with_durability(durability: Box<dyn DurabilitySink<CatalogImpl>>) -> Self {
        let db = DatabaseInner::new_with_durability(durability);
        let default_session = db.session_manager().create_session();
        Self {
            db,
            default_session,
        }
    }

    pub fn database(&self) -> DatabaseInner<CatalogImpl, InMemoryStorage> {
        self.db.clone()
    }

    pub fn execute(&self, stmt: Statement) -> Result<Option<QueryResult>, DbError> {
        self.db
            .executor()
            .execute_session(self.default_session, stmt)
    }

    pub fn exec(&self, sql: &str) -> Result<(), DbError> {
        let quoted_ident = self.session_options().quoted_identifier;
        let stmt = parse_sql_with_quoted_ident(sql, quoted_ident)?;
        let res = self
            .db
            .executor()
            .execute_session(self.default_session, stmt)?;
        if res.is_some() {
            return Err(DbError::Execution(
                "exec() received a query statement; use query()".into(),
            ));
        }
        Ok(())
    }

    pub fn query(&self, sql: &str) -> Result<QueryResult, DbError> {
        let quoted_ident = self.session_options().quoted_identifier;
        let stmt = parse_sql_with_quoted_ident(sql, quoted_ident)?;
        let res = self
            .db
            .executor()
            .execute_session(self.default_session, stmt)?;
        res.ok_or_else(|| DbError::Execution("query() expected a result set".into()))
    }

    pub fn execute_batch(&self, stmts: Vec<Statement>) -> Result<Option<QueryResult>, DbError> {
        self.db
            .executor()
            .execute_session_batch(self.default_session, stmts)
    }

    pub fn execute_session_batch_sql(
        &self,
        session_id: SessionId,
        sql: &str,
    ) -> Result<Option<QueryResult>, DbError> {
        self.db
            .executor()
            .execute_session_batch_sql(session_id, sql)
    }

    pub fn set_journal(&self, journal: Box<dyn Journal>) {
        let _ = self
            .db
            .session_manager()
            .set_session_journal(self.default_session, journal);
    }

    pub fn set_durability_sink(&self, durability: Box<dyn DurabilitySink<CatalogImpl>>) {
        self.db.set_durability_sink(durability);
    }

    pub fn export_checkpoint(&self) -> Result<String, DbError> {
        self.db.checkpoint_manager().export_checkpoint()
    }

    pub fn import_checkpoint(&self, payload: &str) -> Result<(), DbError> {
        self.db.checkpoint_manager().import_checkpoint(payload)
    }

    pub fn session_isolation_level(&self) -> IsolationLevel {
        self.db
            .analyzer()
            .session_isolation_level(self.default_session)
            .unwrap_or(IsolationLevel::ReadCommitted)
    }

    pub fn transaction_is_active(&self) -> bool {
        self.db
            .analyzer()
            .transaction_is_active(self.default_session)
            .unwrap_or(false)
    }

    pub fn session_options(&self) -> SessionOptions {
        self.db
            .analyzer()
            .session_options(self.default_session)
            .unwrap_or_default()
    }

    pub fn explain_sql(&self, sql: &str) -> Result<ExplainPlan, DbError> {
        self.db.analyzer().explain_sql(sql)
    }

    pub fn trace_execute_sql(&self, sql: &str) -> Result<ExecutionTrace, DbError> {
        self.db
            .analyzer()
            .trace_execute_session_sql(self.default_session, sql)
    }

    pub fn print_output(&self) -> Vec<String> {
        self.db.print_output(self.default_session)
    }
}

impl<C, S> EngineInner<C, S>
where
    C: EngineCatalog,
    S: EngineStorage,
{
    pub fn create_session(&self) -> SessionId {
        self.db.session_manager().create_session()
    }

    pub fn close_session(&self, session_id: SessionId) -> Result<(), DbError> {
        self.db.session_manager().close_session(session_id)
    }
}