Struct SqlSession 

pub struct SqlSession { /* private fields */ }

One SQL environment over a fixed immutable database view.

Implementations

impl SqlSession

pub fn new(db: &Db) -> Result<Self, SqlError>

Builds the SQL catalog for db.

Current, as-of, and since views get namespace-derived wide tables in corium; every view gets normalized relations in corium_sys.

Errors

Returns SqlError when the database schema cannot be projected.

pub const fn basis_t(&self) -> u64

Transaction basis captured by this session.

pub const fn view(&self) -> DbView

Corium time view captured by this session.

pub fn tables(&self) -> Vec<String>

Registered Corium relations as schema.table names.

pub async fn query(&self, sql: &str) -> Result<SqlQuery, SqlError>

Plans and starts a read-only SQL query.

DDL, DML, and session-mutating statements are rejected by this method; use Self::mutation to plan supported DML. Dropping the returned stream cancels unfinished execution.

Errors

Returns SqlError for SQL parsing, planning, or execution failure.

pub async fn query_params( &self, sql: &str, params: &[SqlValue], ) -> Result<SqlQuery, SqlError>

Plans and starts a read-only query with PostgreSQL-style $1 parameters bound as typed values.

Errors

Returns SqlError for parameter binding, planning, or execution failure.

pub async fn mutation(&self, sql: &str) -> Result<Option<SqlMutation>, SqlError>

Plans one supported INSERT, UPDATE, or DELETE into Corium transaction forms. Returns None for read-only statements.

The returned mutation is fenced to this session’s basis. Its forms must be submitted through the normal transactor path and then SqlMutation::finish called with the committed database value and tempid map to produce any RETURNING rows.

Errors

Returns SqlError for malformed or unsupported mutation shapes.

pub async fn mutation_params( &self, sql: &str, params: &[SqlValue], ) -> Result<Option<SqlMutation>, SqlError>

Plans one supported mutation with PostgreSQL-style $1 parameters.

Errors

Returns SqlError for malformed, unbound, or unsupported mutation shapes.

pub async fn mutation_columns( &self, sql: &str, params: &[SqlValue], ) -> Result<Option<Vec<SqlColumn>>, SqlError>

Describes the columns produced by a mutation’s RETURNING clause without evaluating its rows or planning transaction forms.

Returns None for a non-mutation and an empty vector for a mutation without RETURNING.

Errors

Returns SqlError for malformed mutation syntax or an invalid returning projection.