rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-10-30 23:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(rust): use LanceDB Arrow re-exports (#3908)

Browse Source 
## Summary

- explain that Rust callers should use the Arrow crates re-exported by `lancedb::arrow`
- update the crate quick-start doctests to build Arrow values from those re-exports
- update the checked-in `simple` example so it cannot drift to an incompatible Arrow crate version

Fixes #1207.

## Validation

- `cargo fmt --all -- --check`
- `cargo metadata --no-deps --format-version 1 --quiet`
- static checks that the documented crates are publicly re-exported and both examples use them
- `git diff --check`
- attempted `cargo check --quiet -p lancedb --example simple`; dependency compilation stopped in the unmodified `lance-encoding` build script because `protoc` is not installed in this environment
This commit is contained in:
medimedi
2026-10-29 08:44:10 +08:00
committed by GitHub
parent 5fbf9fd9f0
commit 088f4d670e
2 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
rust/lancedb/examples/simple.rs
+3 -3
View File
@@ -7,10 +7,10 @@
use std::sync::Arc;
use arrow_array::types::Float32Type;
use arrow_array::{FixedSizeListArray, Int32Array, RecordBatch};
use arrow_schema::{DataType, Field, Schema};
use futures::TryStreamExt;
use lancedb::arrow::arrow_array::types::Float32Type;
use lancedb::arrow::arrow_array::{FixedSizeListArray, Int32Array, RecordBatch};
use lancedb::arrow::arrow_schema::{DataType, Field, Schema};
use lancedb::connection::Connection;
use lancedb::index::Index;
use lancedb::query::{ExecutableQuery, QueryBase};
rust/lancedb/src/lib.rs
+15 -6
View File
@@ -23,6 +23,11 @@
//! cargo add lancedb
//! ```
//!
//! Use the Arrow crates re-exported from [`arrow`] when building schemas, arrays, and
//! record batches for LanceDB. Arrow types from different crate versions are distinct
//! Rust types, so declaring independent `arrow-array` or `arrow-schema` dependencies
//! can cause type errors if their versions do not match LanceDB's dependencies.
//!
//! ## Crate Features
//!
//! - `aws` - Enable AWS S3 object store support.
@@ -91,9 +96,11 @@
//!
//! ```rust
//! # use std::sync::Arc;
//! use arrow_array::{RecordBatch, RecordBatchIterator};
//! use arrow_schema::{DataType, Field, Schema};
//! # use arrow_array::{FixedSizeListArray, Float32Array, Int32Array, types::Float32Type};
//! use lancedb::arrow::arrow_array::{RecordBatch, RecordBatchIterator};
//! use lancedb::arrow::arrow_schema::{DataType, Field, Schema};
//! # use lancedb::arrow::arrow_array::{
//! # FixedSizeListArray, Float32Array, Int32Array, types::Float32Type,
//! # };
//!
//! # tokio::runtime::Runtime::new().unwrap().block_on(async {
//! # let tmpdir = tempfile::tempdir().unwrap();
@@ -138,9 +145,11 @@
//!
//! ```no_run
//! # use std::sync::Arc;
//! # use arrow_array::{FixedSizeListArray, types::Float32Type, RecordBatch,
//! # RecordBatchIterator, Int32Array};
//! # use arrow_schema::{Schema, Field, DataType};
//! # use lancedb::arrow::arrow_array::{
//! # FixedSizeListArray, Int32Array, RecordBatch, RecordBatchIterator,
//! # types::Float32Type,
//! # };
//! # use lancedb::arrow::arrow_schema::{DataType, Field, Schema};
//! use lancedb::index::Index;
//! # tokio::runtime::Runtime::new().unwrap().block_on(async {
//! # let tmpdir = tempfile::tempdir().unwrap();