Crate odbc_api

About

odbc-api enables you to write applications which utilize ODBC (Open Database Connectivity) standard to access databases. See the guide for more information and code examples.

Re-exports

pub use self::parameter::InputParameter;
pub use self::parameter::Out;
pub use self::parameter::Output;
pub use self::parameter::Parameter;
pub use odbc_sys as sys;

Modules

buffers	This module contains buffers intended to be bound to ODBC statement handles.
guide	Introduction to odbc-api (documentation only)
handles	Provides basic abstraction over valid (i.e. allocated ODBC handles).
parameter	Passing parameters to statement

Structs

Bit	New type wrapping u8 and binding as SQL_BIT.
ColumnDescription	Describes the type and attributes of a column.
Connection	The connection handle references storage of all information about the connection to the data source, including status, transaction state, and error information.
CursorImpl	Cursors are used to process and iterate the result sets returned by executing queries. Created by either a prepared query or direct execution. Usually utilized through the crate::Cursor trait.
CursorRow	An individual row of an result set. See crate::Cursor::next_row.
DataSourceInfo	Holds name and description of a datasource
DriverInfo	Struct holding information available on a driver. Can be obtained via Environment::drivers.
Environment	An ODBC 3.8 environment.
Nullable	Wraps a type T together with an additional indicator. This way the type gains a Null representation, those memory layout is compatible with ODBC.
Preallocated	A preallocated SQL statement handle intended for sequential execution of different queries. See crate::Connection::preallocate.
Prepared	A prepared query. Prepared queries are useful if the similar queries should executed more than once.
RowSetCursor	A row set cursor iterates in blocks over row sets, filling them in buffers, instead of iterating the result set row by row. This is usually much faster.

Enums

DataType	Enumeration over valid SQL Data Types supported by ODBC
DriverCompleteOption	Specifies how the driver and driver manager complete the incoming connection string. See Environment::driver_connect.
Error	Error type used to indicate a low level ODBC call returned with SQL_ERROR.
Nullability	Indication of whether a column is nullable or not.

Traits

Cursor	Cursors are used to process and iterate the result sets returned by executing queries.
IntoParameter	An instance can be consumed and to create a parameter which can be bound to a statement during execution.
ParameterCollection	SQL Parameters used to execute a query.
RowSetBuffer	A Row set buffer binds row, or column wise buffers to a cursor in order to fill them with row sets with each call to fetch.

Functions

escape_attribute_value

You can use this method to escape a password so it is suitable to be appended to an ODBC connection string as the value for the PWD attribute. This method is only of interest for application in need to create their own connection strings.

Type Definitions

U16Str	String slice reference for U16String.
U16String	An owned, mutable “wide” string for FFI that is not nul-aware.