Struct MssqlConnection 

pub struct MssqlConnection { /* private fields */ }

MSSQL connection backed by an actor thread that owns the ODBC connection.

Implementations

impl MssqlConnection

pub fn connect_blocking(options: &MssqlConnectOptions) -> Result<Self>

Opens a blocking MSSQL ODBC connection with the provided options and spawns an actor thread to own it.

pub fn ping_blocking(&self) -> Result<(), Error>

Executes a minimal connectivity query.

pub fn dbms_name(&self) -> Result<String, Error>

Returns the DBMS name reported by the ODBC driver.

pub fn prepare_blocking(&self, sql: SqlStr) -> Result<MssqlStatement, Error>

Prepares a statement and returns the metadata reported by the ODBC driver.

Trait Implementations

impl<'c> Acquire<'c> for &'c mut MssqlConnection

type Database = Mssql

type Connection = &'c mut <Mssql as Database>::Connection

fn acquire(self) -> BoxFuture<'c, Result<Self::Connection, Error>>

fn begin(self) -> BoxFuture<'c, Result<Transaction<'c, Mssql>, Error>>

impl AnyConnectionBackend for MssqlConnection

Available on crate feature any only.

fn name(&self) -> &str

The backend name.

fn close(self: Box<Self>) -> BoxFuture<'static, Result<()>>

Explicitly close this database connection.

fn ping(&mut self) -> BoxFuture<'_, Result<()>>

Checks if a connection to the database is still valid.

fn begin(&mut self, statement: Option<SqlStr>) -> BoxFuture<'_, Result<()>>

Begin a new transaction or establish a savepoint within the active transaction.

fn commit(&mut self) -> BoxFuture<'_, Result<()>>

fn rollback(&mut self) -> BoxFuture<'_, Result<()>>

fn start_rollback(&mut self)

fn get_transaction_depth(&self) -> usize

Returns the current transaction depth.

fn shrink_buffers(&mut self)

Forward to Connection::shrink_buffers().

fn cached_statements_size(&self) -> usize

The number of statements currently cached in the connection.

fn clear_cached_statements(&mut self) -> BoxFuture<'_, Result<()>>

Removes all statements from the cache, closing them on the server if needed.

fn as_migrate(&mut self) -> Result<&mut (dyn Migrate + Send + 'static)>

Available on crate feature migrate only.

fn fetch_many( &mut self, query: SqlStr, persistent: bool, arguments: Option<AnyArguments>, ) -> BoxStream<'_, Result<Either<AnyQueryResult, AnyRow>>>

fn fetch_optional( &mut self, query: SqlStr, persistent: bool, arguments: Option<AnyArguments>, ) -> BoxFuture<'_, Result<Option<AnyRow>>>

fn prepare_with<'c, 'q: 'c>( &'c mut self, sql: SqlStr, _parameters: &[AnyTypeInfo], ) -> BoxFuture<'c, Result<AnyStatement>>

fn describe(&mut self, sql: SqlStr) -> BoxFuture<'_, Result<Describe<Any>>>

Available on crate feature offline only.

fn is_in_transaction(&self) -> bool

Checks if the connection is currently in a transaction.

impl Connection for MssqlConnection

type Database = Mssql

type Options = MssqlConnectOptions

async fn close(self) -> Result<(), Error>

Explicitly close this database connection.

async fn ping(&mut self) -> Result<(), Error>

Checks if a connection to the database is still valid.

fn begin( &mut self, ) -> impl Future<Output = Result<Transaction<'_, Self::Database>, Error>> + Send + '_

Begin a new transaction or establish a savepoint within the active transaction.

fn shrink_buffers(&mut self)

Restore any buffers in the connection to their default capacity, if possible.

fn cached_statements_size(&self) -> usize

where Self::Database: HasStatementCache,

The number of statements currently cached in the connection.

async fn clear_cached_statements(&mut self) -> Result<(), Error>

where Self::Database: HasStatementCache,

Removes all statements from the cache, closing them on the server if needed.

fn begin_with( &mut self, statement: impl SqlSafeStr, ) -> impl Future<Output = Result<Transaction<'_, Self::Database>, Error>> + Send

where Self: Sized,

Begin a new transaction with a custom statement.

fn is_in_transaction(&self) -> bool

Returns true if the connection is currently in a transaction.

fn transaction<'a, F, R, E>( &'a mut self, callback: F, ) -> impl Future<Output = Result<R, E>> + Send + 'a

where F: for<'c> FnOnce(&'c mut Transaction<'_, Self::Database>) -> Pin<Box<dyn Future<Output = Result<R, E>> + Send + 'c>> + 'a + for<'c> Send + for<'c> Sync, Self: Sized, R: Send, E: From<Error> + Send,

Execute the function inside a transaction.

fn connect( url: &str, ) -> impl Future<Output = Result<Self, Error>> + Send + 'static

where Self: Sized,

Establish a new database connection.

fn connect_with( options: &Self::Options, ) -> impl Future<Output = Result<Self, Error>> + Send

where Self: Sized,

Establish a new database connection with the provided options.

impl Debug for MssqlConnection

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

Formats the value using the given formatter.

impl Drop for MssqlConnection

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'c> Executor<'c> for &'c mut MssqlConnection

type Database = Mssql

fn fetch_many<'e, 'q, E>( self, query: E, ) -> BoxStream<'e, Result<Either<MssqlQueryResult, MssqlRow>, Error>>

where E: Execute<'q, Self::Database> + 'q, 'c: 'e, 'q: 'e,

Execute multiple queries and return the generated results as a stream from each query, in a stream.

fn fetch_optional<'e, 'q, E>( self, query: E, ) -> BoxFuture<'e, Result<Option<MssqlRow>, Error>>

where E: Execute<'q, Self::Database> + 'q, 'c: 'e, 'q: 'e,

Execute the query and returns at most one row.

fn prepare_with<'e>( self, sql: SqlStr, _parameters: &[MssqlTypeInfo], ) -> BoxFuture<'e, Result<MssqlStatement, Error>>

where 'c: 'e,

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row>, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and returns exactly one row.

fn prepare<'e>( self, query: SqlStr, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Statement, Error>> + Send + 'e>>

where 'c: 'e,

Prepare the SQL query to inspect the type information of its parameters and results.

impl Migrate for MssqlConnection

Available on crate feature migrate only.

fn create_schema_if_not_exists<'e>( &'e mut self, schema_name: &'e str, ) -> BoxFuture<'e, Result<(), MigrateError>>

MSSQL does not support CREATE SCHEMA IF NOT EXISTS as a single statement, so we use a conditional T-SQL block.

fn ensure_migrations_table<'e>( &'e mut self, table_name: &'e str, ) -> BoxFuture<'e, Result<(), MigrateError>>

Creates the migrations tracking table if it does not yet exist.

fn dirty_version<'e>( &'e mut self, _table_name: &'e str, ) -> BoxFuture<'e, Result<Option<i64>, MigrateError>>

MSSQL supports transactional DDL, so a dirty (partially applied) migration cannot occur. Always returns None.

fn list_applied_migrations<'e>( &'e mut self, table_name: &'e str, ) -> BoxFuture<'e, Result<Vec<AppliedMigration>, MigrateError>>

Lists all previously applied migrations, ordered by version.

fn lock(&mut self) -> BoxFuture<'_, Result<(), MigrateError>>

Acquires an exclusive application-level lock using sp_getapplock.

fn unlock(&mut self) -> BoxFuture<'_, Result<(), MigrateError>>

Releases the application-level lock using sp_releaseapplock.

fn apply<'e>( &'e mut self, _table_name: &'e str, migration: &'e Migration, ) -> BoxFuture<'e, Result<Duration, MigrateError>>

Applies a migration: executes the SQL, then records the migration in the tracking table.

fn revert<'e>( &'e mut self, _table_name: &'e str, migration: &'e Migration, ) -> BoxFuture<'e, Result<Duration, MigrateError>>

Reverts a migration: executes the down SQL, then removes the tracking record.

fn skip<'e>( &'e mut self, _table_name: &'e str, _migration: &'e Migration, ) -> BoxFuture<'e, Result<(), MigrateError>>

Marks a migration as applied without executing its SQL.