Struct rsfbclient::Connection

pub struct Connection<C: FirebirdClient> { /* private fields */ }

A connection to a firebird database

Implementations

impl<C: FirebirdClient> Connection<C>

pub fn open(
    cli: C,
    conf: &ConnectionConfiguration<C::AttachmentConfig>
) -> Result<Connection<C>, FbError>

Open the client connection.

pub fn create_database(
    cli: C,
    conf: &ConnectionConfiguration<C::AttachmentConfig>,
    page_size: Option<u32>
) -> Result<Connection<C>, FbError>

Create the database and start the client connection.

pub fn drop_database(self) -> Result<(), FbError>

Drop the current database

pub fn close(self) -> Result<(), FbError>

Close the current connection.

pub fn with_transaction<T, F>(&mut self, closure: F) -> Result<T, FbError> where
    F: FnOnce(&mut Transaction<'_, C>) -> Result<T, FbError>, 

Run a closure with a transaction, if the closure returns an error and the default transaction is not active, the transaction will rollback, else it will be committed

pub fn begin_transaction(&mut self) -> Result<(), FbError>

Begins a new transaction, and instructs all the query and execute methods performed in the Connection type to not automatically commit and rollback until commit or rollback are called

pub fn commit(&mut self) -> Result<(), FbError>

Commit the default transaction

pub fn rollback(&mut self) -> Result<(), FbError>

Rollback the default transaction

Trait Implementations

impl<C: FirebirdClient> Drop for Connection<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C> Execute for Connection<C> where
    C: FirebirdClient, 

fn execute<P>(&mut self, sql: &str, params: P) -> Result<usize, FbError> where
    P: IntoParams, 

Execute a query, may or may not commit the changes and returns the affected rows count

fn execute_returnable<P, R>(&mut self, sql: &str, params: P) -> Result<R, FbError> where
    P: IntoParams,
    R: FromRow + 'static, 

Execute a query that will return data, like the ‘insert … returning ..’ or ‘execute procedure’.

impl From<Connection<NativeFbClient<DynLink>>> for SimpleConnection

fn from(conn: Connection<NativeFbClient<DynLink>>) -> Self

Converts to this type from the input type.

impl From<Connection<NativeFbClient<DynLoad>>> for SimpleConnection

fn from(conn: Connection<NativeFbClient<DynLoad>>) -> Self

Converts to this type from the input type.

impl From<Connection<RustFbClient>> for SimpleConnection

fn from(conn: Connection<RustFbClient>) -> Self

Converts to this type from the input type.

impl<C> Queryable for Connection<C> where
    C: FirebirdClient, 

fn query_iter<'a, P, R>(
    &'a mut self,
    sql: &str,
    params: P
) -> Result<Box<dyn Iterator<Item = Result<R, FbError>> + 'a>, FbError> where
    P: IntoParams,
    R: FromRow + 'static, 

Returns the results of the query as an iterator.

fn query<P, R>(&mut self, sql: &str, params: P) -> Result<Vec<R>, FbError> where
    P: IntoParams,
    R: FromRow + 'static, 

Returns the results of the query as a Vec

fn query_first<P, R>(
    &mut self,
    sql: &str,
    params: P
) -> Result<Option<R>, FbError> where
    P: IntoParams,
    R: FromRow + 'static, 

Returns the first result of the query, or None.

impl TryFrom<SimpleConnection> for Connection<NativeFbClient<DynLink>>

type Error = FbError

The type returned in the event of a conversion error.

fn try_from(conn: SimpleConnection) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SimpleConnection> for Connection<NativeFbClient<DynLoad>>

type Error = FbError

The type returned in the event of a conversion error.

fn try_from(conn: SimpleConnection) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SimpleConnection> for Connection<RustFbClient>

type Error = FbError

The type returned in the event of a conversion error.

fn try_from(conn: SimpleConnection) -> Result<Self, Self::Error>

Performs the conversion.