sqlx-odbc 0.0.1-alpha

ODBC driver implementation for SQLx.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! ODBC database driver building blocks for SQLx.
//!
//! This crate is being ported as an independent split driver crate. It intentionally depends on
//! published crates from crates.io only; it does not depend on a local SQLx checkout.
//!
//! ## Test Setup
//!
//! Fast tests do not require an ODBC data source:
//!
//! ```sh
//! cargo test
//! ```
//!
//! Integration smoke tests use `ODBC_DATABASE_URL` and skip cleanly when it is absent:
//!
//! ```sh
//! ODBC_DATABASE_URL='DSN=MyDataSource;UID=user;PWD=password' cargo test --test odbc
//! ```
//!
//! To run the same tests locally against a known installed driver:
//!
//! ```sh
//! scripts/test-driver.sh duckdb
//! DUCKDB_ODBC_DRIVER=/absolute/path/to/libduckdb_odbc.so scripts/test-driver.sh duckdb
//! ODBC_DATABASE_URL='DSN=MyDataSource;UID=user;PWD=password' scripts/test-driver.sh custom
//! ```
//!
//! `ODBC_DATABASE_URL` may be a standard ODBC connection string, a bare DSN name, or the legacy
//! `odbc:` form:
//!
//! ```text
//! DSN=MyDataSource
//! Driver={ODBC Driver 17 for SQL Server};Server=localhost;Database=test
//! FILEDSN=/path/to/file.dsn
//! odbc:DSN=MyDataSource
//! MyDataSource
//! ```
//!
//! Native requirements are provided by the operating system:
//!
//! - Unix-like systems need an ODBC driver manager such as `unixODBC`.
//! - A database-specific ODBC driver must be installed and visible to the driver manager.
//! - DSN names must be configured in the driver manager's usual files or registry locations.
//! - Buffered fetching can truncate long text or binary values when `max_column_size` is set.
//! - Enable the `vendored-unix-odbc` feature to statically link the unixODBC driver manager.

#![deny(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]
#![warn(future_incompatible, rust_2018_idioms)]

pub mod any;
mod arguments;
mod column;
mod connection;
mod database;
mod error;
mod options;
mod query_result;
mod row;
mod statement;
mod transaction;
mod type_info;
mod value;

pub use arguments::{OdbcArgumentValue, OdbcArguments, OdbcParameterCollection};
pub use column::OdbcColumn;
pub use connection::OdbcConnection;
pub use database::Odbc;
pub use error::{OdbcDatabaseError, OdbcError, Result};
pub use options::{OdbcBufferSettings, OdbcConnectOptions};
pub use query_result::OdbcQueryResult;
pub use row::OdbcRow;
pub use statement::OdbcStatement;
pub use transaction::OdbcTransactionManager;
pub use type_info::{DataTypeExt, OdbcTypeInfo};
pub use value::{OdbcValue, OdbcValueKind};

/// An alias for [`Pool`][sqlx_core::pool::Pool], specialized for ODBC.
pub type OdbcPool = sqlx_core::pool::Pool<Odbc>;

/// An alias for [`PoolOptions`][sqlx_core::pool::PoolOptions], specialized for ODBC.
pub type OdbcPoolOptions = sqlx_core::pool::PoolOptions<Odbc>;

/// An alias for [`Transaction`][sqlx_core::transaction::Transaction], specialized for ODBC.
pub type OdbcTransaction<'c> = sqlx_core::transaction::Transaction<'c, Odbc>;

/// An alias for [`Executor<'_, Database = Odbc>`][sqlx_core::executor::Executor].
pub trait OdbcExecutor<'c>: sqlx_core::executor::Executor<'c, Database = Odbc> {}
impl<'c, T> OdbcExecutor<'c> for T where T: sqlx_core::executor::Executor<'c, Database = Odbc> {}