Struct mysql_macro::Conn

pub struct Conn { /* private fields */ }

MySql server connection.

Implementations

impl Conn

pub fn id(&self) -> u32

Returns connection identifier.

pub fn last_insert_id(&self) -> Option<u64>

Returns the ID generated by a query (usually INSERT) on a table with a column having the AUTO_INCREMENT attribute. Returns None if there was no previous query on the connection or if the query did not update an AUTO_INCREMENT value.

pub fn affected_rows(&self) -> u64

Returns the number of rows affected by the last INSERT, UPDATE, REPLACE or DELETE query.

pub fn info(&self) -> Cow<'_, str>

Text information, as reported by the server in the last OK packet, or an empty string.

pub fn get_warnings(&self) -> u16

Number of warnings, as reported by the server in the last OK packet, or 0.

pub fn last_ok_packet(&self) -> Option<&OkPacket<'static>>

Returns a reference to the last OK packet.

pub fn reset_connection(&mut self, reset_connection: bool)

Turns on/off automatic connection reset (see crate::PoolOpts::with_reset_connection).

Only makes sense for pooled connections.

pub fn server_version(&self) -> (u16, u16, u16)

Returns server version.

pub fn opts(&self) -> &Opts

Returns connection options.

pub fn set_infile_handler<T>(&mut self, handler: T)

where T: Future<Output = Result<Pin<Box<dyn Stream<Item = Result<Bytes, Error>> + Send>>, Error>> + Send + Sync + 'static,

Setup local LOCAL INFILE handler (see “LOCAL INFILE Handlers” section of the crate-level docs).

It’ll overwrite existing local handler, if any.

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

Disconnects this connection from server.

pub fn new<T>( opts: T ) -> Pin<Box<dyn Future<Output = Result<Conn, Error>> + Send>>

where T: Into<Opts>,

Returns a future that resolves to Conn.

pub async fn from_url<T>(url: T) -> Result<Conn, Error>

where T: AsRef<str>,

Returns a future that resolves to Conn.

pub async fn reset(&mut self) -> Result<bool, Error>

Executes COM_RESET_CONNECTION.

Returns false if command is not supported (requires MySql >5.7.2, MariaDb >10.2.3). For older versions consider using Conn::change_user.

pub async fn change_user(&mut self, opts: ChangeUserOpts) -> Result<(), Error>

Executes COM_CHANGE_USER.

This might be used as an older and slower alternative to COM_RESET_CONNECTION that works on MySql prior to 5.7.3 (MariaDb prior ot 10.2.4).

Note

• Using non-default opts for a pooled connection is discouraging.
• Connection options will be permanently updated.

impl Conn

pub async fn start_transaction( &mut self, options: TxOpts ) -> Result<Transaction<'_>, Error>

Starts a transaction.

Trait Implementations

impl Debug for Conn

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Drop for Conn

fn drop(&mut self)

Executes the destructor for this type.

impl Queryable for Conn

fn ping( &mut self ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

Executes COM_PING.

fn query_iter<'a, Q>( &'a mut self, query: Q ) -> Pin<Box<dyn Future<Output = Result<QueryResult<'a, 'static, TextProtocol>, Error>> + Send + 'a>>

where Q: AsQuery + 'a,

Performs the given query and returns the result.

fn prep<'a, Q>( &'a mut self, query: Q ) -> Pin<Box<dyn Future<Output = Result<Statement, Error>> + Send + 'a>>

where Q: AsQuery + 'a,

Prepares the given statement.

fn close( &mut self, stmt: Statement ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

Closes the given statement.

fn exec_iter<'a, 's, Q, P>( &'a mut self, stmt: Q, params: P ) -> Pin<Box<dyn Future<Output = Result<QueryResult<'a, 'static, BinaryProtocol>, Error>> + Send + 's>>

where 'a: 's, Q: StatementLike + 'a, P: Into<Params>,

Executes the given statement with given params.

fn exec_batch<'a, 'b, S, P, I>( &'a mut self, stmt: S, params_iter: I ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'b>>

where 'a: 'b, S: StatementLike + 'b, I: IntoIterator<Item = P> + Send + 'b, <I as IntoIterator>::IntoIter: Send, P: Into<Params> + Send,

Executes the given statement for each item in the given params iterator.

fn query<'a, T, Q>( &'a mut self, query: Q ) -> Pin<Box<dyn Future<Output = Result<Vec<T>, Error>> + Send + 'a>>

where Q: AsQuery + 'a, T: FromRow + Send + 'static,

Performs the given query and collects the first result set.

fn query_first<'a, T, Q>( &'a mut self, query: Q ) -> Pin<Box<dyn Future<Output = Result<Option<T>, Error>> + Send + 'a>>

where Q: AsQuery + 'a, T: FromRow + Send + 'static,

Performs the given query and returns the first row of the first result set.

fn query_map<'a, T, F, Q, U>( &'a mut self, query: Q, f: F ) -> Pin<Box<dyn Future<Output = Result<Vec<U>, Error>> + Send + 'a>>

where Q: AsQuery + 'a, T: FromRow + Send + 'static, F: FnMut(T) -> U + Send + 'a, U: Send,

Performs the given query and maps each row of the first result set.

fn query_fold<'a, T, F, Q, U>( &'a mut self, query: Q, init: U, f: F ) -> Pin<Box<dyn Future<Output = Result<U, Error>> + Send + 'a>>

where Q: AsQuery + 'a, T: FromRow + Send + 'static, F: FnMut(U, T) -> U + Send + 'a, U: Send + 'a,

Performs the given query and folds the first result set to a single value.

fn query_drop<'a, Q>( &'a mut self, query: Q ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

where Q: AsQuery + 'a,

Performs the given query and drops the query result.

fn exec<'a, 'b, T, S, P>( &'a mut self, stmt: S, params: P ) -> Pin<Box<dyn Future<Output = Result<Vec<T>, Error>> + Send + 'b>>

where 'a: 'b, S: StatementLike + 'b, P: Into<Params> + Send + 'b, T: FromRow + Send + 'static,

Executes the given statement and collects the first result set.

fn exec_first<'a, 'b, T, S, P>( &'a mut self, stmt: S, params: P ) -> Pin<Box<dyn Future<Output = Result<Option<T>, Error>> + Send + 'b>>

where 'a: 'b, S: StatementLike + 'b, P: Into<Params> + Send + 'b, T: FromRow + Send + 'static,

Executes the given statement and returns the first row of the first result set.

fn exec_map<'a, 'b, T, S, P, U, F>( &'a mut self, stmt: S, params: P, f: F ) -> Pin<Box<dyn Future<Output = Result<Vec<U>, Error>> + Send + 'b>>

where 'a: 'b, S: StatementLike + 'b, P: Into<Params> + Send + 'b, T: FromRow + Send + 'static, F: FnMut(T) -> U + Send + 'a, U: Send + 'a,

Executes the given stmt and maps each row of the first result set.

fn exec_fold<'a, 'b, T, S, P, U, F>( &'a mut self, stmt: S, params: P, init: U, f: F ) -> Pin<Box<dyn Future<Output = Result<U, Error>> + Send + 'b>>

where 'a: 'b, S: StatementLike + 'b, P: Into<Params> + Send + 'b, T: FromRow + Send + 'static, F: FnMut(U, T) -> U + Send + 'a, U: Send + 'a,

Executes the given stmt and folds the first result set to a signel value.

fn exec_drop<'a, 'b, S, P>( &'a mut self, stmt: S, params: P ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'b>>

where 'a: 'b, S: StatementLike + 'b, P: Into<Params> + Send + 'b,

Executes the given statement and drops the result.

fn query_stream<'a, T, Q>( &'a mut self, query: Q ) -> Pin<Box<dyn Future<Output = Result<ResultSetStream<'a, 'a, 'static, T, TextProtocol>, Error>> + Send + 'a>>

where T: Unpin + FromRow + Send + 'static, Q: AsQuery + 'a,

Returns a stream over the first result set.

fn exec_stream<'a, 's, T, Q, P>( &'a mut self, stmt: Q, params: P ) -> Pin<Box<dyn Future<Output = Result<ResultSetStream<'a, 'a, 'static, T, BinaryProtocol>, Error>> + Send + 's>>

where 'a: 's, T: Unpin + FromRow + Send + 'static, Q: StatementLike + 'a, P: Into<Params> + Send + 's,

Returns a stream over the first result set.

impl<'a> ToConnection<'a, 'static> for &'a mut Conn

impl ToConnection<'static, 'static> for Conn