feat: Add ODBC support to the Any database driver

This commit introduces comprehensive support for ODBC in the sqlx-core library. It includes the addition of ODBC-specific types, connection options, and implementations for encoding and decoding various data types. New tests have been added to ensure robust functionality and compatibility with ODBC interactions. The Cargo.toml file has also been updated to include the new ODBC test suite, enhancing overall test coverage.

Author: lovasoa

Cargo.toml

@@ -192,6 +192,11 @@ name = "any-pool"
 path = "tests/any/pool.rs"
 required-features = ["any"]
 
+[[test]]
+name = "any-odbc"
+path = "tests/any/odbc.rs"
+required-features = ["any", "odbc"]
+
 #
 # Migrations
 #

sqlx-core/src/any/arguments.rs

@@ -46,6 +46,12 @@ pub(crate) enum AnyArgumentBufferKind<'q> {
         crate::mssql::MssqlArguments,
         std::marker::PhantomData<&'q ()>,
     ),
+
+    #[cfg(feature = "odbc")]
+    Odbc(
+        crate::odbc::OdbcArguments<'q>,
+        std::marker::PhantomData<&'q ()>,
+    ),
 }
 
 // control flow inferred type bounds would be fun
@@ -131,3 +137,24 @@ impl<'q> From<AnyArguments<'q>> for crate::postgres::PgArguments {
         }
     }
 }
+
+#[cfg(feature = "odbc")]
+#[allow(irrefutable_let_patterns)]
+impl<'q> From<AnyArguments<'q>> for crate::odbc::OdbcArguments<'q> {
+    fn from(args: AnyArguments<'q>) -> Self {
+        let mut buf = AnyArgumentBuffer(AnyArgumentBufferKind::Odbc(
+            Default::default(),
+            std::marker::PhantomData,
+        ));
+
+        for value in args.values {
+            let _ = value.encode_by_ref(&mut buf);
+        }
+
+        if let AnyArgumentBufferKind::Odbc(args, _) = buf.0 {
+            args
+        } else {
+            unreachable!()
+        }
+    }
+}

sqlx-core/src/any/column.rs

@@ -13,6 +13,9 @@ use crate::sqlite::{SqliteColumn, SqliteRow, SqliteStatement};
 #[cfg(feature = "mssql")]
 use crate::mssql::{MssqlColumn, MssqlRow, MssqlStatement};
 
+#[cfg(feature = "odbc")]
+use crate::odbc::{OdbcColumn, OdbcRow, OdbcStatement};
+
 #[derive(Debug, Clone)]
 pub struct AnyColumn {
     pub(crate) kind: AnyColumnKind,
@@ -34,6 +37,9 @@ pub(crate) enum AnyColumnKind {
 
     #[cfg(feature = "mssql")]
     Mssql(MssqlColumn),
+
+    #[cfg(feature = "odbc")]
+    Odbc(OdbcColumn),
 }
 
 impl Column for AnyColumn {
@@ -52,6 +58,9 @@ impl Column for AnyColumn {
 
             #[cfg(feature = "mssql")]
             AnyColumnKind::Mssql(row) => row.ordinal(),
+
+            #[cfg(feature = "odbc")]
+            AnyColumnKind::Odbc(row) => row.ordinal(),
         }
     }
 
@@ -68,6 +77,9 @@ impl Column for AnyColumn {
 
             #[cfg(feature = "mssql")]
             AnyColumnKind::Mssql(row) => row.name(),
+
+            #[cfg(feature = "odbc")]
+            AnyColumnKind::Odbc(row) => row.name(),
         }
     }
 
@@ -441,3 +453,28 @@ impl<I: ?Sized> AnyColumnIndex for I where
     I: ColumnIndex<SqliteRow> + for<'q> ColumnIndex<SqliteStatement<'q>>
 {
 }
+
+#[cfg(all(
+    not(any(
+        feature = "mysql",
+        feature = "mssql",
+        feature = "postgres",
+        feature = "sqlite"
+    )),
+    feature = "odbc"
+))]
+pub trait AnyColumnIndex: ColumnIndex<OdbcRow> + for<'q> ColumnIndex<OdbcStatement<'q>> {}
+
+#[cfg(all(
+    not(any(
+        feature = "mysql",
+        feature = "mssql",
+        feature = "postgres",
+        feature = "sqlite"
+    )),
+    feature = "odbc"
+))]
+impl<I: ?Sized> AnyColumnIndex for I where
+    I: ColumnIndex<OdbcRow> + for<'q> ColumnIndex<OdbcStatement<'q>>
+{
+}

sqlx-core/src/any/connection/establish.rs

@@ -34,6 +34,13 @@ impl AnyConnection {
                     .await
                     .map(AnyConnectionKind::Mssql)
             }
+
+            #[cfg(feature = "odbc")]
+            AnyConnectOptionsKind::Odbc(options) => {
+                crate::odbc::OdbcConnection::connect_with(options)
+                    .await
+                    .map(AnyConnectionKind::Odbc)
+            }
         }
         .map(AnyConnection)
     }

sqlx-core/src/any/connection/executor.rs

@@ -49,6 +49,12 @@ impl<'c> Executor<'c> for &'c mut AnyConnection {
                 .fetch_many((query, arguments.map(Into::into)))
                 .map_ok(|v| v.map_right(Into::into).map_left(Into::into))
                 .boxed(),
+
+            #[cfg(feature = "odbc")]
+            AnyConnectionKind::Odbc(conn) => conn
+                .fetch_many((query, arguments.map(Into::into)))
+                .map_ok(|v| v.map_right(Into::into).map_left(Into::into))
+                .boxed(),
         }
     }
 
@@ -88,6 +94,12 @@ impl<'c> Executor<'c> for &'c mut AnyConnection {
                     .fetch_optional((query, arguments.map(Into::into)))
                     .await?
                     .map(Into::into),
+
+                #[cfg(feature = "odbc")]
+                AnyConnectionKind::Odbc(conn) => conn
+                    .fetch_optional((query, arguments.map(Into::into)))
+                    .await?
+                    .map(Into::into),
             })
         })
     }
@@ -114,6 +126,9 @@ impl<'c> Executor<'c> for &'c mut AnyConnection {
 
                 #[cfg(feature = "mssql")]
                 AnyConnectionKind::Mssql(conn) => conn.prepare(sql).await.map(Into::into)?,
+
+                #[cfg(feature = "odbc")]
+                AnyConnectionKind::Odbc(conn) => conn.prepare(sql).await.map(Into::into)?,
             })
         })
     }
@@ -138,6 +153,9 @@ impl<'c> Executor<'c> for &'c mut AnyConnection {
 
                 #[cfg(feature = "mssql")]
                 AnyConnectionKind::Mssql(conn) => conn.describe(sql).await.map(map_describe)?,
+
+                #[cfg(feature = "odbc")]
+                AnyConnectionKind::Odbc(conn) => conn.describe(sql).await.map(map_describe)?,
             })
         })
     }

sqlx-core/src/any/connection/mod.rs

@@ -15,6 +15,9 @@ use crate::mssql;
 
 #[cfg(feature = "mysql")]
 use crate::mysql;
+
+#[cfg(feature = "odbc")]
+use crate::odbc;
 use crate::transaction::Transaction;
 
 mod establish;
@@ -48,6 +51,9 @@ pub enum AnyConnectionKind {
 
     #[cfg(feature = "sqlite")]
     Sqlite(sqlite::SqliteConnection),
+
+    #[cfg(feature = "odbc")]
+    Odbc(odbc::OdbcConnection),
 }
 
 impl AnyConnectionKind {
@@ -64,6 +70,9 @@ impl AnyConnectionKind {
 
             #[cfg(feature = "mssql")]
             AnyConnectionKind::Mssql(_) => AnyKind::Mssql,
+
+            #[cfg(feature = "odbc")]
+            AnyConnectionKind::Odbc(_) => AnyKind::Odbc,
         }
     }
 }
@@ -94,6 +103,9 @@ macro_rules! delegate_to {
 
             #[cfg(feature = "mssql")]
             AnyConnectionKind::Mssql(conn) => conn.$method($($arg),*),
+
+            #[cfg(feature = "odbc")]
+            AnyConnectionKind::Odbc(conn) => conn.$method($($arg),*),
         }
     };
 }
@@ -112,6 +124,9 @@ macro_rules! delegate_to_mut {
 
             #[cfg(feature = "mssql")]
             AnyConnectionKind::Mssql(conn) => conn.$method($($arg),*),
+
+            #[cfg(feature = "odbc")]
+            AnyConnectionKind::Odbc(conn) => conn.$method($($arg),*),
         }
     };
 }
@@ -134,6 +149,9 @@ impl Connection for AnyConnection {
 
             #[cfg(feature = "mssql")]
             AnyConnectionKind::Mssql(conn) => conn.close(),
+
+            #[cfg(feature = "odbc")]
+            AnyConnectionKind::Odbc(conn) => conn.close(),
         }
     }
 
@@ -150,6 +168,9 @@ impl Connection for AnyConnection {
 
             #[cfg(feature = "mssql")]
             AnyConnectionKind::Mssql(conn) => conn.close_hard(),
+
+            #[cfg(feature = "odbc")]
+            AnyConnectionKind::Odbc(conn) => conn.close_hard(),
         }
     }
 
@@ -178,6 +199,10 @@ impl Connection for AnyConnection {
             // no cache
             #[cfg(feature = "mssql")]
             AnyConnectionKind::Mssql(_) => 0,
+
+            // no cache
+            #[cfg(feature = "odbc")]
+            AnyConnectionKind::Odbc(_) => 0,
         }
     }
 
@@ -195,6 +220,10 @@ impl Connection for AnyConnection {
             // no cache
             #[cfg(feature = "mssql")]
             AnyConnectionKind::Mssql(_) => Box::pin(futures_util::future::ok(())),
+
+            // no cache
+            #[cfg(feature = "odbc")]
+            AnyConnectionKind::Odbc(_) => Box::pin(futures_util::future::ok(())),
         }
     }
 
@@ -236,3 +265,10 @@ impl From<sqlite::SqliteConnection> for AnyConnection {
         AnyConnection(AnyConnectionKind::Sqlite(conn))
     }
 }
+
+#[cfg(feature = "odbc")]
+impl From<odbc::OdbcConnection> for AnyConnection {
+    fn from(conn: odbc::OdbcConnection) -> Self {
+        AnyConnection(AnyConnectionKind::Odbc(conn))
+    }
+}