Struct AnyConnection 

pub struct AnyConnection { /* private fields */ }

SEE DOCUMENTATION BEFORE USE. Runtime-generic database connection.

The underlying database drivers are chosen at runtime from the list set via install_drivers. Any use of AnyConnection or AnyPool without this will panic.

It is recommended to use install_default_drivers to activate all currently compiled-in drivers.

A connection to any SQLx database.

The database driver used is determined by the scheme of the connection url.

postgres://postgres@localhost/test
sqlite://a.sqlite

Implementations

impl AnyConnection

pub fn backend_name(&self) -> &str

Available on crate feature any only.

Returns the name of the database backend in use (e.g. PostgreSQL, MySQL, SQLite, etc.)

Trait Implementations

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

type Database = Any

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

fn acquire( self, ) -> Pin<Box<dyn Future<Output = Result<<&'c mut AnyConnection as Acquire<'c>>::Connection, Error>> + Send + 'c>>

fn begin( self, ) -> Pin<Box<dyn Future<Output = Result<Transaction<'c, Any>, Error>> + Send + 'c>>

impl Connection for AnyConnection

type Database = Any

type Options = AnyConnectOptions

fn close(self) -> impl Future<Output = Result<(), Error>> + Send + 'static

Explicitly close this database connection.

fn ping(&mut self) -> impl Future<Output = Result<(), Error>> + Send

Checks if a connection to the database is still valid.

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

where AnyConnection: Sized,

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

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

where AnyConnection: Sized,

Begin a new transaction with a custom statement.

fn cached_statements_size(&self) -> usize

The number of statements currently cached in the connection.

fn clear_cached_statements( &mut self, ) -> impl Future<Output = Result<(), Error>> + Send

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

fn shrink_buffers(&mut self)

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

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 AnyConnection

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

Formats the value using the given formatter.

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

type Database = Any

fn fetch_many<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<Either<AnyQueryResult, AnyRow>, Error>> + Send + 'e>>

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

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, ) -> Pin<Box<dyn Future<Output = Result<Option<AnyRow>, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, <&'c mut AnyConnection as Executor<'c>>::Database>,

Execute the query and returns at most one row.

fn prepare_with<'e>( self, sql: SqlStr, parameters: &[AnyTypeInfo], ) -> Pin<Box<dyn Future<Output = Result<AnyStatement, Error>> + Send + 'e>>

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 AnyConnection

fn create_schema_if_not_exists<'e>( &'e mut self, schema_name: &'e str, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + 'e>>

Create a database schema with the given name if it does not already exist.

fn ensure_migrations_table<'e>( &'e mut self, table_name: &'e str, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + 'e>>

fn dirty_version<'e>( &'e mut self, table_name: &'e str, ) -> Pin<Box<dyn Future<Output = Result<Option<i64>, MigrateError>> + Send + 'e>>

fn list_applied_migrations<'e>( &'e mut self, table_name: &'e str, ) -> Pin<Box<dyn Future<Output = Result<Vec<AppliedMigration>, MigrateError>> + Send + 'e>>

fn lock( &mut self, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + '_>>

fn unlock( &mut self, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + '_>>

fn apply<'e>( &'e mut self, table_name: &'e str, migration: &'e Migration, ) -> Pin<Box<dyn Future<Output = Result<Duration, MigrateError>> + Send + 'e>>

fn revert<'e>( &'e mut self, table_name: &'e str, migration: &'e Migration, ) -> Pin<Box<dyn Future<Output = Result<Duration, MigrateError>> + Send + 'e>>

fn skip<'e>( &'e mut self, table_name: &'e str, migration: &'e Migration, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + 'e>>