sqlx-core-oldapi 0.6.53

Core of SQLx, the rust SQL toolkit. Not intended to be used directly.
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
90
91
92
93
94
95
96
97
98
99
100
101
102

//! ODBC database driver (via `odbc-api`).
//!
//! ## Connection Strings
//!
//! When using the `Any` connection type, SQLx accepts standard ODBC connection strings:
//!
//! ```text
//! // DSN-based connection
//! DSN=MyDataSource;UID=myuser;PWD=mypassword
//!
//! // Driver-based connection
//! Driver={ODBC Driver 17 for SQL Server};Server=localhost;Database=test
//!
//! // File DSN
//! FILEDSN=/path/to/myfile.dsn
//! ```
//!
//! The `odbc:` URL scheme prefix is optional but still supported for backward compatibility:
//!
//! ```text
//! odbc:DSN=MyDataSource
//! ```
//!
//! ## Buffer Configuration
//!
//! You can configure buffer settings for performance tuning:
//!
//! ```rust,no_run
//! use std::str::FromStr;
//! use sqlx_core_oldapi::odbc::{OdbcConnectOptions, OdbcBufferSettings};
//!
//! let mut opts = OdbcConnectOptions::from_str("DSN=MyDataSource")?;
//!
//! // Configure for high-throughput buffered mode
//! opts.buffer_settings(OdbcBufferSettings {
//!     batch_size: 256,           // Fetch 256 rows at once
//!     max_column_size: Some(2048), // Limit text columns to 2048 chars
//! });
//!
//! // Configure for unbuffered mode (no truncation, row-by-row processing)
//! opts.buffer_settings(OdbcBufferSettings {
//!     batch_size: 128,           // batch_size ignored in unbuffered mode
//!     max_column_size: None,     // Enable unbuffered mode
//! });
//!
//! // Or configure individual settings
//! opts.batch_size(512)
//!     .max_column_size(Some(1024));
//!
//! // Switch to unbuffered mode
//! opts.max_column_size(None);
//! # Ok::<(), sqlx::Error>(())
//! ```

use crate::executor::Executor;

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

pub use arguments::{OdbcArgumentValue, OdbcArguments};
pub use column::OdbcColumn;
pub use connection::OdbcConnection;
pub use database::Odbc;
pub use options::{OdbcBufferSettings, OdbcConnectOptions};
pub use query_result::OdbcQueryResult;
pub use row::{OdbcBatch, OdbcRow};
pub use statement::{OdbcStatement, OdbcStatementMetadata};
pub use transaction::OdbcTransactionManager;
pub use type_info::{DataTypeExt, OdbcTypeInfo};
pub use value::{ColumnData, OdbcValue, OdbcValueRef, OdbcValueType, OdbcValueVec};

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

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

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

// NOTE: required due to the lack of lazy normalization
impl_into_arguments_for_arguments!(crate::odbc::OdbcArguments);
impl_executor_for_pool_connection!(Odbc, OdbcConnection, OdbcRow);
impl_executor_for_transaction!(Odbc, OdbcRow);
impl_column_index_for_row!(OdbcRow);
impl_column_index_for_statement!(OdbcStatement);
impl_acquire!(Odbc, OdbcConnection);
impl_into_maybe_pool!(Odbc, OdbcConnection);

// custom Option<..> handling implemented in `arguments.rs`