Trait sqlx::Statement

pub trait Statement<'q>: Send + Sync {
    type Database: Database;
    fn to_owned(&self) -> <Self::Database as HasStatement<'static>>::Statement;
    fn sql(&self) -> &str;
    fn parameters(
        &self
    ) -> Option<Either<&[<Self::Database as Database>::TypeInfo], usize>>;
    fn columns(&self) -> &[<Self::Database as Database>::Column];
    fn query(
        &self
    ) -> Query<'_, Self::Database, <Self::Database as HasArguments<'_>>::Arguments>;
    fn query_with<'s, A>(&'s self, arguments: A) -> Query<'s, Self::Database, A>
    where
        A: IntoArguments<'s, Self::Database>;
    fn query_as<O>(
        &self
    ) -> QueryAs<'_, Self::Database, O, <Self::Database as HasArguments<'_>>::Arguments>
    where
        O: for<'r> FromRow<'r, <Self::Database as Database>::Row>;
    fn query_as_with<'s, O, A>(
        &'s self, 
        arguments: A
    ) -> QueryAs<'s, Self::Database, O, A>
    where
        A: IntoArguments<'s, Self::Database>,
        O: for<'r> FromRow<'r, <Self::Database as Database>::Row>;
    fn query_scalar<O>(
        &self
    ) -> QueryScalar<'_, Self::Database, O, <Self::Database as HasArguments<'_>>::Arguments>
    where
        (O,): for<'r> FromRow<'r, <Self::Database as Database>::Row>;
    fn query_scalar_with<'s, O, A>(
        &'s self, 
        arguments: A
    ) -> QueryScalar<'s, Self::Database, O, A>
    where
        A: IntoArguments<'s, Self::Database>,
        (O,): for<'r> FromRow<'r, <Self::Database as Database>::Row>;

    fn column<I>(&self, index: I) -> &<Self::Database as Database>::Column
    where
        I: ColumnIndex<Self>,
    { ... }
    fn try_column<I>(
        &self, 
        index: I
    ) -> Result<&<Self::Database as Database>::Column, Error>
    where
        I: ColumnIndex<Self>,
    { ... }
}

An explicitly prepared statement.

Statements are prepared and cached by default, per connection. This type allows you to look at that cache in-between the statement being prepared and it being executed. This contains the expected columns to be returned and the expected parameter types (if available).

Statements can be re-used with any connection and on first-use it will be re-prepared and cached within the connection.

Associated Types

type Database: Database

Required methods

fn to_owned(&self) -> <Self::Database as HasStatement<'static>>::Statement

Creates an owned statement from this statement reference. This copies the original SQL text.

fn sql(&self) -> &str

Get the original SQL text used to create this statement.

fn parameters(
    &self
) -> Option<Either<&[<Self::Database as Database>::TypeInfo], usize>>

Get the expected parameters for this statement.

The information returned depends on what is available from the driver. SQLite can only tell us the number of parameters. PostgreSQL can give us full type information.

fn columns(&self) -> &[<Self::Database as Database>::Column]

Get the columns expected to be returned by executing this statement.

fn query(
    &self
) -> Query<'_, Self::Database, <Self::Database as HasArguments<'_>>::Arguments>

fn query_with<'s, A>(&'s self, arguments: A) -> Query<'s, Self::Database, A> where
    A: IntoArguments<'s, Self::Database>, 

fn query_as<O>(
    &self
) -> QueryAs<'_, Self::Database, O, <Self::Database as HasArguments<'_>>::Arguments> where
    O: for<'r> FromRow<'r, <Self::Database as Database>::Row>, 

fn query_as_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryAs<'s, Self::Database, O, A> where
    A: IntoArguments<'s, Self::Database>,
    O: for<'r> FromRow<'r, <Self::Database as Database>::Row>, 

fn query_scalar<O>(
    &self
) -> QueryScalar<'_, Self::Database, O, <Self::Database as HasArguments<'_>>::Arguments> where
    (O,): for<'r> FromRow<'r, <Self::Database as Database>::Row>, 

fn query_scalar_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryScalar<'s, Self::Database, O, A> where
    A: IntoArguments<'s, Self::Database>,
    (O,): for<'r> FromRow<'r, <Self::Database as Database>::Row>, 

Provided methods

fn column<I>(&self, index: I) -> &<Self::Database as Database>::Column where
    I: ColumnIndex<Self>, 

Gets the column information at index.

A string index can be used to access a column by name and a usize index can be used to access a column by position.

Panics

Panics if index is out of bounds. See try_column for a non-panicking version.

fn try_column<I>(
    &self,
    index: I
) -> Result<&<Self::Database as Database>::Column, Error> where
    I: ColumnIndex<Self>, 

Gets the column information at index or None if out of bounds.

Implementors

impl<'q> Statement<'q> for AnyStatement<'q>

type Database = Any

pub fn to_owned(&self) -> AnyStatement<'static>

pub fn sql(&self) -> &str

pub fn parameters(&self) -> Option<Either<&[AnyTypeInfo], usize>>

pub fn columns(&self) -> &[AnyColumn]

pub fn query(
    &self
) -> Query<'_, <AnyStatement<'q> as Statement<'q>>::Database, AnyArguments<'_>>

pub fn query_with<'s, A>(
    &'s self,
    arguments: A
) -> Query<'s, <AnyStatement<'q> as Statement<'q>>::Database, A> where
    A: IntoArguments<'s, <AnyStatement<'q> as Statement<'q>>::Database>, 

pub fn query_as<O>(
    &self
) -> QueryAs<'_, <AnyStatement<'q> as Statement<'q>>::Database, O, <<AnyStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    O: for<'r> FromRow<'r, <<AnyStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_as_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryAs<'s, <AnyStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <AnyStatement<'q> as Statement<'q>>::Database>,
    O: for<'r> FromRow<'r, <<AnyStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar<O>(
    &self
) -> QueryScalar<'_, <AnyStatement<'q> as Statement<'q>>::Database, O, <<AnyStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    (O,): for<'r> FromRow<'r, <<AnyStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryScalar<'s, <AnyStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <AnyStatement<'q> as Statement<'q>>::Database>,
    (O,): for<'r> FromRow<'r, <<AnyStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

impl<'q> Statement<'q> for MssqlStatement<'q>

type Database = Mssql

pub fn to_owned(&self) -> MssqlStatement<'static>

pub fn sql(&self) -> &str

pub fn parameters(&self) -> Option<Either<&[MssqlTypeInfo], usize>>

pub fn columns(&self) -> &[MssqlColumn]

pub fn query(
    &self
) -> Query<'_, <MssqlStatement<'q> as Statement<'q>>::Database, MssqlArguments>

pub fn query_with<'s, A>(
    &'s self,
    arguments: A
) -> Query<'s, <MssqlStatement<'q> as Statement<'q>>::Database, A> where
    A: IntoArguments<'s, <MssqlStatement<'q> as Statement<'q>>::Database>, 

pub fn query_as<O>(
    &self
) -> QueryAs<'_, <MssqlStatement<'q> as Statement<'q>>::Database, O, <<MssqlStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    O: for<'r> FromRow<'r, <<MssqlStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_as_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryAs<'s, <MssqlStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <MssqlStatement<'q> as Statement<'q>>::Database>,
    O: for<'r> FromRow<'r, <<MssqlStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar<O>(
    &self
) -> QueryScalar<'_, <MssqlStatement<'q> as Statement<'q>>::Database, O, <<MssqlStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    (O,): for<'r> FromRow<'r, <<MssqlStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryScalar<'s, <MssqlStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <MssqlStatement<'q> as Statement<'q>>::Database>,
    (O,): for<'r> FromRow<'r, <<MssqlStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

impl<'q> Statement<'q> for MySqlStatement<'q>

type Database = MySql

pub fn to_owned(&self) -> MySqlStatement<'static>

pub fn sql(&self) -> &str

pub fn parameters(&self) -> Option<Either<&[MySqlTypeInfo], usize>>

pub fn columns(&self) -> &[MySqlColumn]

pub fn query(
    &self
) -> Query<'_, <MySqlStatement<'q> as Statement<'q>>::Database, MySqlArguments>

pub fn query_with<'s, A>(
    &'s self,
    arguments: A
) -> Query<'s, <MySqlStatement<'q> as Statement<'q>>::Database, A> where
    A: IntoArguments<'s, <MySqlStatement<'q> as Statement<'q>>::Database>, 

pub fn query_as<O>(
    &self
) -> QueryAs<'_, <MySqlStatement<'q> as Statement<'q>>::Database, O, <<MySqlStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    O: for<'r> FromRow<'r, <<MySqlStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_as_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryAs<'s, <MySqlStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <MySqlStatement<'q> as Statement<'q>>::Database>,
    O: for<'r> FromRow<'r, <<MySqlStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar<O>(
    &self
) -> QueryScalar<'_, <MySqlStatement<'q> as Statement<'q>>::Database, O, <<MySqlStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    (O,): for<'r> FromRow<'r, <<MySqlStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryScalar<'s, <MySqlStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <MySqlStatement<'q> as Statement<'q>>::Database>,
    (O,): for<'r> FromRow<'r, <<MySqlStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

impl<'q> Statement<'q> for PgStatement<'q>

type Database = Postgres

pub fn to_owned(&self) -> PgStatement<'static>

pub fn sql(&self) -> &str

pub fn parameters(&self) -> Option<Either<&[PgTypeInfo], usize>>

pub fn columns(&self) -> &[PgColumn]

pub fn query(
    &self
) -> Query<'_, <PgStatement<'q> as Statement<'q>>::Database, PgArguments>

pub fn query_with<'s, A>(
    &'s self,
    arguments: A
) -> Query<'s, <PgStatement<'q> as Statement<'q>>::Database, A> where
    A: IntoArguments<'s, <PgStatement<'q> as Statement<'q>>::Database>, 

pub fn query_as<O>(
    &self
) -> QueryAs<'_, <PgStatement<'q> as Statement<'q>>::Database, O, <<PgStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    O: for<'r> FromRow<'r, <<PgStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_as_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryAs<'s, <PgStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <PgStatement<'q> as Statement<'q>>::Database>,
    O: for<'r> FromRow<'r, <<PgStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar<O>(
    &self
) -> QueryScalar<'_, <PgStatement<'q> as Statement<'q>>::Database, O, <<PgStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    (O,): for<'r> FromRow<'r, <<PgStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryScalar<'s, <PgStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <PgStatement<'q> as Statement<'q>>::Database>,
    (O,): for<'r> FromRow<'r, <<PgStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

impl<'q> Statement<'q> for SqliteStatement<'q>

type Database = Sqlite

pub fn to_owned(&self) -> SqliteStatement<'static>

pub fn sql(&self) -> &str

pub fn parameters(&self) -> Option<Either<&[SqliteTypeInfo], usize>>

pub fn columns(&self) -> &[SqliteColumn]

pub fn query(
    &self
) -> Query<'_, <SqliteStatement<'q> as Statement<'q>>::Database, SqliteArguments<'_>>

pub fn query_with<'s, A>(
    &'s self,
    arguments: A
) -> Query<'s, <SqliteStatement<'q> as Statement<'q>>::Database, A> where
    A: IntoArguments<'s, <SqliteStatement<'q> as Statement<'q>>::Database>, 

pub fn query_as<O>(
    &self
) -> QueryAs<'_, <SqliteStatement<'q> as Statement<'q>>::Database, O, <<SqliteStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    O: for<'r> FromRow<'r, <<SqliteStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_as_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryAs<'s, <SqliteStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <SqliteStatement<'q> as Statement<'q>>::Database>,
    O: for<'r> FromRow<'r, <<SqliteStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar<O>(
    &self
) -> QueryScalar<'_, <SqliteStatement<'q> as Statement<'q>>::Database, O, <<SqliteStatement<'q> as Statement<'q>>::Database as HasArguments<'_>>::Arguments> where
    (O,): for<'r> FromRow<'r, <<SqliteStatement<'q> as Statement<'q>>::Database as Database>::Row>, 

pub fn query_scalar_with<'s, O, A>(
    &'s self,
    arguments: A
) -> QueryScalar<'s, <SqliteStatement<'q> as Statement<'q>>::Database, O, A> where
    A: IntoArguments<'s, <SqliteStatement<'q> as Statement<'q>>::Database>,
    (O,): for<'r> FromRow<'r, <<SqliteStatement<'q> as Statement<'q>>::Database as Database>::Row>,