Trait odbc_api::ParameterCollection

pub unsafe trait ParameterCollection {
    fn parameter_set_size(&self) -> u32;
    unsafe fn bind_parameters_to(
        self, 
        stmt: &mut StatementImpl<'_>
    ) -> Result<(), Error>;
}

SQL Parameters used to execute a query.

ODBC allows to place question marks (?) in the statement text as placeholders. For each such placeholder a parameter needs to be bound to the statement before executing it.

Examples

This trait is implemented by single parameters.

use odbc_api::Environment;

let env = unsafe {
    Environment::new()?
};

let mut conn = env.connect("YourDatabase", "SA", "<YourStrong@Passw0rd>")?;
let year = 1980;
if let Some(cursor) = conn.execute("SELECT year, name FROM Birthdays WHERE year > ?;", &year)? {
    // Use cursor to process query results.
}

Tuples of Parameters implement this trait, too.

use odbc_api::Environment;

let env = unsafe {
    Environment::new()?
};

let mut conn = env.connect("YourDatabase", "SA", "<YourStrong@Passw0rd>")?;
let too_old = 1980;
let too_young = 2000;
if let Some(cursor) = conn.execute(
    "SELECT year, name FROM Birthdays WHERE ? < year < ?;",
    (&too_old, &too_young),
)? {
    // Use cursor to congratulate only persons in the right age group...
}

And so do array slices of Parameters.

use odbc_api::Environment;

let env = unsafe {
    Environment::new()?
};

let mut conn = env.connect("YourDatabase", "SA", "<YourStrong@Passw0rd>")?;
let params = [1980, 2000];
if let Some(cursor) = conn.execute(
    "SELECT year, name FROM Birthdays WHERE ? < year < ?;",
    &params[..])?
{
    // Use cursor to process query results.
}

Required methods

fn parameter_set_size(&self) -> u32

Number of values per parameter in the collection. This can be different from the maximum batch size a buffer may be able to hold. Returning 0 will cause the the query not to be executed.

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

Safety

Implementers should take care that the values bound by this method to the statement live at least for the Duration of self. The most straight forward way of achieving this is of course, to bind members.

Loading content...

Implementations on Foreign Types

impl ParameterCollection for ()

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter> ParameterCollection for (A,)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter> ParameterCollection for (A, B)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter, C: Parameter> ParameterCollection for (A, B, C)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter, C: Parameter, D: Parameter> ParameterCollection for (A, B, C, D)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter, C: Parameter, D: Parameter, E: Parameter> ParameterCollection for (A, B, C, D, E)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter, C: Parameter, D: Parameter, E: Parameter, F: Parameter> ParameterCollection for (A, B, C, D, E, F)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter, C: Parameter, D: Parameter, E: Parameter, F: Parameter, G: Parameter> ParameterCollection for (A, B, C, D, E, F, G)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter, C: Parameter, D: Parameter, E: Parameter, F: Parameter, G: Parameter, H: Parameter> ParameterCollection for (A, B, C, D, E, F, G, H)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter, C: Parameter, D: Parameter, E: Parameter, F: Parameter, G: Parameter, H: Parameter, I: Parameter> ParameterCollection for (A, B, C, D, E, F, G, H, I)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<A: Parameter, B: Parameter, C: Parameter, D: Parameter, E: Parameter, F: Parameter, G: Parameter, H: Parameter, I: Parameter, J: Parameter> ParameterCollection for (A, B, C, D, E, F, G, H, I, J)

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<T> ParameterCollection for &[T] where
    T: InputParameter, 

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

Loading content...

Implementors

impl ParameterCollection for &ColumnarRowSet

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl ParameterCollection for &TextRowSet

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

impl<T> ParameterCollection for T where
    T: Parameter, 

fn parameter_set_size(&self) -> u32

unsafe fn bind_parameters_to(
    self,
    stmt: &mut StatementImpl<'_>
) -> Result<(), Error>

Loading content...