Struct sqlx::Query

pub struct Query<'q, DB, T = <DB as Database>::Arguments> where
    DB: Database,  { /* fields omitted */ }

Dynamic SQL query with bind parameters. Returned by [query].

The methods on this struct should be passed a reference to crate::Pool or one of the connection types.

Methods

impl<'q, DB, P> Query<'q, DB, P> where
    DB: Database,
    P: IntoArguments<DB> + Send, 

pub async fn execute<E>(self, executor: &'_ mut E) -> Result<u64, Error> where
    E: Executor<Database = DB>, 

Execute the query for its side-effects.

Returns the number of rows affected, or 0 if not applicable.

pub fn fetch<'e, E>(
    self,
    executor: &'e mut E
) -> Pin<Box<dyn Stream<Item = Result<<DB as Database>::Row, Error>> + 'e + Send>> where
    'q: 'e,
    E: Executor<Database = DB>, 

Execute the query, returning the rows as a futures Stream.

Use [fetch_all] if you want a Vec instead.

pub async fn fetch_all<E>(
    self,
    executor: &'_ mut E
) -> Result<Vec<<DB as Database>::Row>, Error> where
    E: Executor<Database = DB>, 

Execute the query and get all rows from the result as a Vec.

pub async fn fetch_optional<E>(
    self,
    executor: &'_ mut E
) -> Result<Option<<DB as Database>::Row>, Error> where
    E: Executor<Database = DB>, 

Execute a query which should return either 0 or 1 rows.

Returns crate::Error::FoundMoreThanOne if more than 1 row is returned. Use .fetch().try_next() if you just want one row.

pub async fn fetch_one<E>(
    self,
    executor: &'_ mut E
) -> Result<<DB as Database>::Row, Error> where
    E: Executor<Database = DB>, 

Execute a query which should return exactly 1 row.

• Returns crate::Error::NotFound if 0 rows are returned.
• Returns crate::Error::FoundMoreThanOne if more than one row is returned.

impl<'q, DB> Query<'q, DB, <DB as Database>::Arguments> where
    DB: Database, 

pub fn bind<T>(self, value: T) -> Query<'q, DB, <DB as Database>::Arguments> where
    DB: HasSqlType<T>,
    T: Encode<DB>, 

Bind a value for use with this SQL query.

Logic Safety

This function should be used with care, as SQLx cannot validate that the value is of the right type nor can it validate that you have passed the correct number of parameters.