Re-exports arrow dependency to minimise version maintenance for crate… (#93)

* Re-exports arrow dependency to minimise version maintenance for crate users

* use duckdb::arrow; add more comments

Change-Id: I8d68c1f9da480439a0271d22ff91d442ca3e5ee7

* use duckdb::arrow

Change-Id: I2e2b4e9e9033a5d4cd29fbb9f6aa3e7798eee18d

Co-authored-by: wangfenjin <[email protected]>

Author: Tobias Brandt

README.md

@@ -13,8 +13,17 @@ forked from rusqlite as duckdb also tries to expose a sqlite3 compatible API.
 
 ```rust
 use duckdb::{params, Connection, Result};
-use arrow::record_batch::RecordBatch;
-use arrow::util::pretty::print_batches;
+
+// In your project, we need to keep the arrow version same as the version used in duckdb.
+// Refer to https://github.com/wangfenjin/duckdb-rs/issues/92
+// You can either:
+use duckdb::arrow::record_batch::RecordBatch;
+// Or in your Cargo.toml, use * as the version; features can be toggled according to your needs
+// arrow = { version = "*", default-features = false, features = ["prettyprint"] }
+// Then you can:
+// use arrow::record_batch::RecordBatch;
+
+use duckdb::arrow::util::pretty::print_batches;
 
 #[derive(Debug)]
 struct Person {

examples/basic.rs

@@ -2,8 +2,8 @@
 
 extern crate duckdb;
 
-use arrow::record_batch::RecordBatch;
-use arrow::util::pretty::print_batches;
+use duckdb::arrow::record_batch::RecordBatch;
+use duckdb::arrow::util::pretty::print_batches;
 use duckdb::{params, Connection, Result};
 
 #[derive(Debug)]

examples/parquet.rs

@@ -1,9 +1,8 @@
 extern crate duckdb;
+use duckdb::arrow::record_batch::RecordBatch;
+use duckdb::arrow::util::pretty::print_batches;
 use duckdb::{Connection, Result};
 
-use arrow::record_batch::RecordBatch;
-use arrow::util::pretty::print_batches;
-
 fn main() -> Result<()> {
     let db = Connection::open_in_memory()?;
     db.execute_batch("INSTALL parquet; LOAD parquet;")?;

src/arrow_batch.rs

@@ -1,5 +1,5 @@
+use super::arrow::{datatypes::SchemaRef, record_batch::RecordBatch};
 use super::Statement;
-use arrow::{datatypes::SchemaRef, record_batch::RecordBatch};
 
 /// An handle for the resulting RecordBatch of a query.
 #[must_use = "Arrow is lazy and will do nothing unless consumed"]

src/lib.rs

@@ -3,8 +3,8 @@
 //!
 //! ```rust
 //! use duckdb::{params, Connection, Result};
-//! use arrow::record_batch::RecordBatch;
-//! use arrow::util::pretty::print_batches;
+//! use duckdb::arrow::record_batch::RecordBatch;
+//! use duckdb::arrow::util::pretty::print_batches;
 //!
 //! #[derive(Debug)]
 //! struct Person {
@@ -87,6 +87,9 @@ pub use crate::statement::Statement;
 pub use crate::transaction::{DropBehavior, Savepoint, Transaction, TransactionBehavior};
 pub use crate::types::ToSql;
 
+// re-export dependencies from arrow-rs to minimise version maintenance for crate users
+pub use arrow;
+
 #[macro_use]
 mod error;
 mod appender;