use crate::catalog::services::CatalogSession;
use uqa_sql::{
plan::UnifiedPlan,
result::{ExplainAnalysis, ExplainPhysicalPlan},
semantics::{effects::QueryEffectContext, rules::RuleCatalog},
SQLError, SQLParam, SQLResult,
};
pub mod queries;
pub mod routines;
pub mod schemas;
pub mod session;
pub type PhysicalExplainRenderer = fn(
&UnifiedPlan,
&uqa_sql::explain::ExplainSettings,
Option<&ExplainAnalysis>,
&ExplainPhysicalPlan,
&uqa_core::memory::ProductionControl<'_>,
) -> Result<SQLResult, SQLError>;
pub trait PhysicalExplainPlanning: Sync {
fn plan_explained_statement(&self, body: &UnifiedPlan) -> Result<UnifiedPlan, SQLError>;
fn explained_plan_estimates(
&self,
body: &UnifiedPlan,
params: &[SQLParam],
control: &uqa_core::memory::ProductionControl<'_>,
) -> Result<
uqa_core::memory::Produced<Vec<uqa_sql::result::explain::ExplainNodeEstimate>>,
SQLError,
>;
fn physical_explain_plan(
&self,
body: &UnifiedPlan,
params: &[SQLParam],
costs: bool,
control: &uqa_core::memory::ProductionControl<'_>,
) -> Result<uqa_core::memory::Produced<ExplainPhysicalPlan>, SQLError>;
}
pub trait StatementDiagnostics: Sync {
fn diagnostics_control(
&self,
) -> Result<uqa_storage::read_control::StorageReadControl, SQLError>;
fn diagnostics_scope(
&self,
timing: Option<bool>,
io: uqa_core::io_usage::IOOptions,
) -> Result<crate::query::diagnostics::DiagnosticsScope, SQLError>;
}
pub trait StatementEffects {
fn query_effect_context(&self) -> QueryEffectContext<'_>;
}
#[derive(Clone, Copy)]
pub struct StatementRuntime<'a> {
pub cancellation: &'a uqa_core::CancellationToken,
pub notices: &'a crate::query::NoticeQueue,
}
#[derive(Clone, Copy)]
pub struct StatementValidationContext<'a> {
pub session: &'a dyn CatalogSession,
pub rules: &'a dyn RuleCatalog,
pub effects: &'a dyn StatementEffects,
pub transactions: &'a dyn super::transactions::StatementTransactions,
}
pub trait StatementExecutionInputs<S: Clone + 'static> {
fn io_context(&self) -> uqa_core::io_usage::IOContext {
uqa_core::io_usage::IOContext::current()
}
fn regex_cache(&self) -> Option<std::sync::Arc<uqa_sql::expr::RegexCache>> {
None
}
fn statement_execution_context(&self) -> StatementExecutionContext<'_, S>;
fn transaction_timestamp_micros(&self) -> Option<i64> {
None
}
fn temporal_date_order(&self) -> Option<uqa_core::TemporalDateOrder> {
None
}
fn temporal_interval_style(&self) -> Option<uqa_core::TemporalIntervalStyle> {
None
}
fn statement_timeout(&self) -> Option<std::time::Duration>;
fn parser_settings(&self) -> uqa_sql::parser::ParserSettings {
uqa_sql::parser::ParserSettings::default()
}
fn notification_subscriptions_required(&self) -> bool {
false
}
fn diagnostic_search_path(&self) -> Option<Vec<String>> {
None
}
}
pub(super) fn statement_thread_scope<S: Clone + 'static>(
statements: &dyn StatementExecutionInputs<S>,
cancellation: &uqa_core::CancellationToken,
) -> super::thread_scope::StatementThreadScope {
super::thread_context::StatementThreadContext {
retained_rows: crate::query::sources::retained_source::RetainedRowContext::current(),
io: statements.io_context(),
regex_cache: statements.regex_cache(),
temporal_input: uqa_sql::expr::TemporalInputContext {
transaction_clock_micros: statements
.transaction_timestamp_micros()
.or_else(uqa_sql::expr::transaction_clock_micros),
interval_style: statements
.temporal_interval_style()
.unwrap_or_else(uqa_sql::expr::temporal_interval_style),
date_order: statements
.temporal_date_order()
.unwrap_or_else(uqa_sql::expr::temporal_date_order),
},
cancellation: Some(cancellation.clone()),
}
.enter()
}
pub trait StatementMutationInputs<S: Clone + 'static>:
crate::mutation::returning::ReturningInputs<S>
{
fn mutation_context(&self) -> crate::mutation::entry::MutationEntryContext<'_, S>;
fn mutation_initialization_context(
&self,
) -> crate::mutation::statement::context::MutationStatementContext<'_, S>;
}
#[derive(Clone)]
pub struct StatementExecutionContext<'a, S: Clone + 'static> {
pub diagnostics: &'a dyn StatementDiagnostics,
pub validation: StatementValidationContext<'a>,
pub runtime: StatementRuntime<'a>,
pub queries: &'a dyn queries::StatementQueryContexts<S>,
pub mutations: &'a dyn StatementMutationInputs<S>,
pub schemas: schemas::SchemaStatements<'a, S>,
pub routines: routines::RoutineStatements<'a>,
pub prepared: session::PreparedStatements<'a>,
pub settings: &'a dyn session::StatementSettings,
pub notifications: &'a dyn session::StatementNotifications,
pub controls: &'a dyn session::StatementControl,
pub portals: super::portal::context::PortalExecutionContext<'a, S>,
pub roles: crate::catalog::security::role_lifecycle::context::RoleExecutionContext<'a>,
pub events: crate::schema::events::context::EventLifecycleContext<'a>,
pub foreign: &'a dyn crate::schema::foreign_creation::entry::ForeignCreationTransactions,
pub table_privileges: &'a dyn crate::catalog::security::table_grants::TableGrantInputs,
pub explain: PhysicalExplainRenderer,
pub physical_explain: &'a dyn PhysicalExplainPlanning,
}