Struct odbc_api::handles::Connection

pub struct Connection<'c> { /* fields omitted */ }

The connection handle references storage of all information about the connection to the data source, including status, transaction state, and error information.

Implementations

impl<'c> Connection<'c>

pub unsafe fn new(handle: HDbc) -> Self

Safety

Call this method only with a valid (successfully allocated) ODBC connection handle.

pub fn connect(
    &mut self,
    data_source_name: &U16Str,
    user: &U16Str,
    pwd: &U16Str
) -> Result<(), Error>

Establishes connections to a driver and a data source.

• See [Connecting with SQLConnect][1]
• See [SQLConnectFunction][2]

Arguments

• data_source_name - Data source name. The data might be located on the same computer as the program, or on another computer somewhere on a network.
• user - User identifier.
• pwd - Authentication string (typically the password). [1]: https://docs.microsoft.com/sql/odbc/reference/syntax/sqlconnect-function [2]: https://docs.microsoft.com/sql/odbc/reference/syntax/sqlconnect-function

pub fn connect_with_connection_string(
    &mut self,
    connection_string: &U16Str
) -> Result<(), Error>

An alternative to connect. It supports data sources that require more connection information than the three arguments in connect and data sources that are not defined in the system information.

pub fn disconnect(&mut self) -> Result<(), Error>

Disconnect from an ODBC data source.

pub fn allocate_statement(&self) -> Result<Statement<'_>, Error>

Allocate a new statement handle. The Statement must not outlive the Connection.

pub fn set_autocommit(&mut self, enabled: bool) -> Result<(), Error>

Specify the transaction mode. By default, ODBC transactions are in auto-commit mode (unless SQLSetConnectAttr and SQLSetConnectOption are not supported, which is unlikely). Switching from manual-commit mode to auto-commit mode automatically commits any open transaction on the connection.

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

To commit a transaction in manual-commit mode.

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

Roll back a transaction in manual-commit mode.

Trait Implementations

impl<'c> AsHandle for Connection<'c>

fn as_handle(&self) -> Handle

The raw underlying ODBC handle used to talk to the ODBC C API. The handle must be valid.

fn handle_type(&self) -> HandleType

The type of the ODBC handle returned by as_handle.

impl<'c> Drop for Connection<'c>

fn drop(&mut self)

Executes the destructor for this type.