alexandreyc commented on code in PR #1756: URL: https://github.com/apache/arrow-adbc/pull/1756#discussion_r1579751048
########## rust/core/src/driver_exporter.rs: ########## @@ -0,0 +1,1581 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +use std::collections::{HashMap, HashSet}; +use std::ffi::{CStr, CString}; +use std::hash::Hash; +use std::os::raw::{c_char, c_int, c_void}; + +use arrow::array::StructArray; +use arrow::datatypes::DataType; +use arrow::ffi::{from_ffi, FFI_ArrowArray, FFI_ArrowSchema}; +use arrow::ffi_stream::{ArrowArrayStreamReader, FFI_ArrowArrayStream}; + +use crate::error::{Error, Result, Status}; +use crate::ffi::constants::ADBC_STATUS_OK; +use crate::ffi::{ + types::ErrorPrivateData, FFI_AdbcConnection, FFI_AdbcDatabase, FFI_AdbcDriver, FFI_AdbcError, + FFI_AdbcErrorDetail, FFI_AdbcPartitions, FFI_AdbcStatement, FFI_AdbcStatusCode, +}; +use crate::options::{InfoCode, ObjectDepth, OptionConnection, OptionDatabase, OptionValue}; +use crate::{Connection, Database, Driver, Optionable, Statement}; + +// Invariant: options.is_none() XOR database.is_none() +struct ExportedDatabase<DriverType: Driver + Default> { + options: Option<HashMap<OptionDatabase, OptionValue>>, // Pre-init options + database: Option<DriverType::DatabaseType>, +} + +// Invariant: options.is_none() XOR database.is_none() +struct ExportedConnection<DriverType: Driver + Default> { + options: Option<HashMap<OptionConnection, OptionValue>>, // Pre-init options + connection: Option<<DriverType::DatabaseType as Database>::ConnectionType>, +} + +struct ExportedStatement<DriverType: Driver + Default> { + statement: + <<DriverType::DatabaseType as Database>::ConnectionType as Connection>::StatementType, +} + +pub fn make_ffi_driver<DriverType: Driver + Default + 'static>() -> FFI_AdbcDriver { + FFI_AdbcDriver { + private_data: std::ptr::null_mut(), + private_manager: std::ptr::null(), + release: Some(release_ffi_driver), + DatabaseInit: Some(database_init::<DriverType>), + DatabaseNew: Some(database_new::<DriverType>), + DatabaseSetOption: Some(database_set_option::<DriverType>), + DatabaseRelease: Some(database_release::<DriverType>), + ConnectionCommit: Some(connection_commit::<DriverType>), + ConnectionGetInfo: Some(connection_get_info::<DriverType>), + ConnectionGetObjects: Some(connection_get_objects::<DriverType>), + ConnectionGetTableSchema: Some(connection_get_table_schema::<DriverType>), + ConnectionGetTableTypes: Some(connection_get_table_types::<DriverType>), + ConnectionInit: Some(connection_init::<DriverType>), + ConnectionNew: Some(connection_new::<DriverType>), + ConnectionSetOption: Some(connection_set_option::<DriverType>), + ConnectionReadPartition: Some(connection_read_partition::<DriverType>), + ConnectionRelease: Some(connection_release::<DriverType>), + ConnectionRollback: Some(connection_rollback::<DriverType>), + StatementBind: Some(statement_bind::<DriverType>), + StatementBindStream: Some(statement_bind_stream::<DriverType>), + StatementExecuteQuery: Some(statement_execute_query::<DriverType>), + StatementExecutePartitions: Some(statement_execute_partitions::<DriverType>), + StatementGetParameterSchema: Some(statement_get_parameter_schema::<DriverType>), + StatementNew: Some(statement_new::<DriverType>), + StatementPrepare: Some(statement_prepare::<DriverType>), + StatementRelease: Some(statement_release::<DriverType>), + StatementSetOption: Some(statement_set_option::<DriverType>), + StatementSetSqlQuery: Some(statement_set_sql_query::<DriverType>), + StatementSetSubstraitPlan: Some(statement_set_substrait_plan::<DriverType>), + ErrorGetDetailCount: Some(error_get_detail_count), + ErrorGetDetail: Some(error_get_detail), + ErrorFromArrayStream: None, // TODO(alexandreyc): what to do with this? + DatabaseGetOption: Some(database_get_option::<DriverType>), + DatabaseGetOptionBytes: Some(database_get_option_bytes::<DriverType>), + DatabaseGetOptionDouble: Some(database_get_option_double::<DriverType>), + DatabaseGetOptionInt: Some(database_get_option_int::<DriverType>), + DatabaseSetOptionBytes: Some(database_set_option_bytes::<DriverType>), + DatabaseSetOptionDouble: Some(database_set_option_double::<DriverType>), + DatabaseSetOptionInt: Some(database_set_option_int::<DriverType>), + ConnectionCancel: Some(connection_cancel::<DriverType>), + ConnectionGetOption: Some(connection_get_option::<DriverType>), + ConnectionGetOptionBytes: Some(connection_get_option_bytes::<DriverType>), + ConnectionGetOptionDouble: Some(connection_get_option_double::<DriverType>), + ConnectionGetOptionInt: Some(connection_get_option_int::<DriverType>), + ConnectionGetStatistics: Some(connection_get_statistics::<DriverType>), + ConnectionGetStatisticNames: Some(connection_get_statistic_names::<DriverType>), + ConnectionSetOptionBytes: Some(connection_set_option_bytes::<DriverType>), + ConnectionSetOptionDouble: Some(connection_set_option_double::<DriverType>), + ConnectionSetOptionInt: Some(connection_set_option_int::<DriverType>), + StatementCancel: Some(statement_cancel::<DriverType>), + StatementExecuteSchema: Some(statement_execute_schema::<DriverType>), + StatementGetOption: Some(statement_get_option::<DriverType>), + StatementGetOptionBytes: Some(statement_get_option_bytes::<DriverType>), + StatementGetOptionDouble: Some(statement_get_option_double::<DriverType>), + StatementGetOptionInt: Some(statement_get_option_int::<DriverType>), + StatementSetOptionBytes: Some(statement_set_option_bytes::<DriverType>), + StatementSetOptionDouble: Some(statement_set_option_double::<DriverType>), + StatementSetOptionInt: Some(statement_set_option_int::<DriverType>), + } +} + +/// Export a Rust driver to a C driver. +/// +/// The default name recommended is `AdbcDriverInit` or `<Prefix>DriverInit`. +/// +/// The driver type must implement [Driver] and [Default]. +#[macro_export] +macro_rules! export_driver { + ($func_name:ident, $driver_type:ty) => { + #[no_mangle] + pub unsafe extern "C" fn $func_name( + version: std::os::raw::c_int, + driver: *mut std::os::raw::c_void, + error: *mut $crate::ffi::FFI_AdbcError, + ) -> $crate::ffi::FFI_AdbcStatusCode { + if version != $crate::options::AdbcVersion::V110.into() { Review Comment: I think we should discuss ADBC versioning more generally. Currently: 1. The driver manager is capable of loading ADBC 1.0.0 and 1.1.0 drivers 2. The driver exporter is capable of exporting Rust drivers as ADBC 1.1.0 drivers only 3. Rust drivers are not explictly versioned but we assume 1.1.0 semantics One possible solution: 1. The driver manager should be able to load all ADBC versions 2. The driver exporter always exports to the latest ADBC versions 3. Rust drivers always implement the latest semantics I'm not yet 100% clear about all the implications of these choices though. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
