-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
99 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| use std::{borrow::Cow, ptr::null_mut, slice, str}; | ||
|
|
||
| use arrow_odbc::odbc_api::{escape_attribute_value, Connection, ConnectionOptions, Environment}; | ||
| use log::debug; | ||
|
|
||
| use crate::{try_, ArrowOdbcError, ENV}; | ||
|
|
||
| /// Opaque type to transport connection to an ODBC Datasource over language boundry | ||
| pub struct OdbcConnection(pub Connection<'static>); | ||
|
|
||
| /// Allocate and open an ODBC connection using the specified connection string. In case of an error | ||
| /// this function returns a NULL pointer. | ||
| /// | ||
| /// # Safety | ||
| /// | ||
| /// `connection_string_buf` must point to a valid utf-8 encoded string. `connection_string_len` must | ||
| /// hold the length of text in `connection_string_buf`. | ||
| /// `user` and or `password` are optional and are allowed to be `NULL`. | ||
| #[no_mangle] | ||
| pub unsafe extern "C" fn arrow_odbc_connect_with_connection_string( | ||
| connection_string_buf: *const u8, | ||
| connection_string_len: usize, | ||
| user: *const u8, | ||
| user_len: usize, | ||
| password: *const u8, | ||
| password_len: usize, | ||
| login_timeout_sec_ptr: *const u32, | ||
| packet_size_ptr: *const u32, | ||
| connection_out: *mut *mut OdbcConnection, | ||
| ) -> *mut ArrowOdbcError { | ||
| let env = if let Some(env) = ENV.get() { | ||
| // Use existing environment | ||
| env | ||
| } else { | ||
| // ODBC Environment does not exist yet, create it. | ||
| let env = try_!(Environment::new()); | ||
| ENV.get_or_init(|| env) | ||
| }; | ||
|
|
||
| let connection_string = slice::from_raw_parts(connection_string_buf, connection_string_len); | ||
| let mut connection_string = Cow::Borrowed(str::from_utf8(connection_string).unwrap()); | ||
|
|
||
| append_attribute("UID", &mut connection_string, user, user_len); | ||
| append_attribute("PWD", &mut connection_string, password, password_len); | ||
|
|
||
| let login_timeout_sec = if login_timeout_sec_ptr.is_null() { | ||
| None | ||
| } else { | ||
| Some(*login_timeout_sec_ptr) | ||
| }; | ||
|
|
||
| let packet_size = if packet_size_ptr.is_null() { | ||
| None | ||
| } else { | ||
| Some(*packet_size_ptr) | ||
| }; | ||
|
|
||
| let connection = try_!(env.connect_with_connection_string( | ||
| &connection_string, | ||
| ConnectionOptions { | ||
| login_timeout_sec, | ||
| packet_size | ||
| } | ||
| )); | ||
|
|
||
| // Log dbms name to ease debugging of issues. | ||
| let dbms_name = try_!(connection.database_management_system_name()); | ||
| debug!("Database managment system name as reported by ODBC: {dbms_name}"); | ||
|
|
||
| *connection_out = Box::into_raw(Box::new(OdbcConnection(connection))); | ||
| null_mut() | ||
| } | ||
|
|
||
| /// Append attribute like user and value to connection string | ||
| unsafe fn append_attribute( | ||
| attribute_name: &'static str, | ||
| connection_string: &mut Cow<str>, | ||
| ptr: *const u8, | ||
| len: usize, | ||
| ) { | ||
| // Attribute is optional and not set. Nothing to append. | ||
| if ptr.is_null() { | ||
| return; | ||
| } | ||
|
|
||
| let bytes = slice::from_raw_parts(ptr, len); | ||
| let text = str::from_utf8(bytes).unwrap(); | ||
| let escaped = escape_attribute_value(text); | ||
| *connection_string = format!("{connection_string}{attribute_name}={escaped};").into() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,107 +1,24 @@ | ||
| //! Defines C bindings for `arrow-odbc` to enable using it from Python. | ||
| mod connection; | ||
| mod error; | ||
| mod logging; | ||
| mod parameter; | ||
| mod pool; | ||
| mod reader; | ||
| mod writer; | ||
|
|
||
| use std::{borrow::Cow, ptr::null_mut, slice, str, sync::OnceLock}; | ||
| use std::sync::OnceLock; | ||
|
|
||
| use arrow_odbc::odbc_api::{escape_attribute_value, Connection, ConnectionOptions, Environment}; | ||
| use arrow_odbc::odbc_api::Environment; | ||
|
|
||
| pub use error::{arrow_odbc_error_free, arrow_odbc_error_message, ArrowOdbcError}; | ||
| use log::debug; | ||
| pub use logging::arrow_odbc_log_to_stderr; | ||
| pub use reader::{arrow_odbc_reader_free, arrow_odbc_reader_next, ArrowOdbcReader}; | ||
| pub use writer::{ | ||
| arrow_odbc_writer_free, arrow_odbc_writer_make, arrow_odbc_writer_write_batch, ArrowOdbcWriter, | ||
| pub use self::{ | ||
| connection::{arrow_odbc_connect_with_connection_string, OdbcConnection}, | ||
| error::{arrow_odbc_error_free, arrow_odbc_error_message, ArrowOdbcError}, | ||
| logging::arrow_odbc_log_to_stderr, | ||
| reader::{arrow_odbc_reader_free, arrow_odbc_reader_next, ArrowOdbcReader}, | ||
| writer::{arrow_odbc_writer_free, arrow_odbc_writer_make, arrow_odbc_writer_write_batch, ArrowOdbcWriter}, | ||
| }; | ||
|
|
||
| /// Using an ODBC environment with static lifetime eases our work with concurrent fetching, as we | ||
| /// can work with safe code and without scoped threads. | ||
| static ENV: OnceLock<Environment> = OnceLock::new(); | ||
|
|
||
| /// Opaque type to transport connection to an ODBC Datasource over language boundry | ||
| pub struct OdbcConnection(Connection<'static>); | ||
|
|
||
| /// Allocate and open an ODBC connection using the specified connection string. In case of an error | ||
| /// this function returns a NULL pointer. | ||
| /// | ||
| /// # Safety | ||
| /// | ||
| /// `connection_string_buf` must point to a valid utf-8 encoded string. `connection_string_len` must | ||
| /// hold the length of text in `connection_string_buf`. | ||
| /// `user` and or `password` are optional and are allowed to be `NULL`. | ||
| #[no_mangle] | ||
| pub unsafe extern "C" fn arrow_odbc_connect_with_connection_string( | ||
| connection_string_buf: *const u8, | ||
| connection_string_len: usize, | ||
| user: *const u8, | ||
| user_len: usize, | ||
| password: *const u8, | ||
| password_len: usize, | ||
| login_timeout_sec_ptr: *const u32, | ||
| packet_size_ptr: *const u32, | ||
| connection_out: *mut *mut OdbcConnection, | ||
| ) -> *mut ArrowOdbcError { | ||
| let env = if let Some(env) = ENV.get() { | ||
| // Use existing environment | ||
| env | ||
| } else { | ||
| // ODBC Environment does not exist yet, create it. | ||
| let env = try_!(Environment::new()); | ||
| ENV.get_or_init(|| env) | ||
| }; | ||
|
|
||
| let connection_string = slice::from_raw_parts(connection_string_buf, connection_string_len); | ||
| let mut connection_string = Cow::Borrowed(str::from_utf8(connection_string).unwrap()); | ||
|
|
||
| append_attribute("UID", &mut connection_string, user, user_len); | ||
| append_attribute("PWD", &mut connection_string, password, password_len); | ||
|
|
||
| let login_timeout_sec = if login_timeout_sec_ptr.is_null() { | ||
| None | ||
| } else { | ||
| Some(*login_timeout_sec_ptr) | ||
| }; | ||
|
|
||
| let packet_size = if packet_size_ptr.is_null() { | ||
| None | ||
| } else { | ||
| Some(*packet_size_ptr) | ||
| }; | ||
|
|
||
| let connection = try_!(env.connect_with_connection_string( | ||
| &connection_string, | ||
| ConnectionOptions { | ||
| login_timeout_sec, | ||
| packet_size | ||
| } | ||
| )); | ||
|
|
||
| // Log dbms name to ease debugging of issues. | ||
| let dbms_name = try_!(connection.database_management_system_name()); | ||
| debug!("Database managment system name as reported by ODBC: {dbms_name}"); | ||
|
|
||
| *connection_out = Box::into_raw(Box::new(OdbcConnection(connection))); | ||
| null_mut() | ||
| } | ||
|
|
||
| /// Append attribute like user and value to connection string | ||
| unsafe fn append_attribute( | ||
| attribute_name: &'static str, | ||
| connection_string: &mut Cow<str>, | ||
| ptr: *const u8, | ||
| len: usize, | ||
| ) { | ||
| // Attribute is optional and not set. Nothing to append. | ||
| if ptr.is_null() { | ||
| return; | ||
| } | ||
|
|
||
| let bytes = slice::from_raw_parts(ptr, len); | ||
| let text = str::from_utf8(bytes).unwrap(); | ||
| let escaped = escape_attribute_value(text); | ||
| *connection_string = format!("{connection_string}{attribute_name}={escaped};").into() | ||
| } |