Interface Queryable

src/queryable.rs:9–31

A trait for types that can execute raw queries.

/// A trait for types that can execute raw queries.
pub trait Queryable {
    /// The type of a connection to the database.
    type Connection;

    /// The type of a stream containing the query results.
    type QueryStream: Stream<Item = Result<QueryResult, Status>> + Unpin;

    /// Execute a query and return a stream of results.
    ///
    /// The connection is passed by ownership, but must be returned in the output tuple.
    fn query(
        query: String,
        conn: Self::Connection,
    ) -> impl Future<Output = (Self::QueryStream, Self::Connection)> + Send;

    /// Execute a query that does not return rows, but returns the number of rows changed.
    ///
    /// This is used for queries that modify the database.
    fn execute(
        query: String,
        conn: Self::Connection,
    ) -> impl Future<Output = (Result<RowsChanged, Status>, Self::Connection)> + Send;
}