Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update query API to borrow Arrays instead of consume them #151

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ version = "0.1.0"

[workspace.dependencies]
anyhow = "1.0"
pkg-config = "0.3.30"
proptest = { version = "1.0.0" }
proptest-derive = { version = "0.4.0" }
serde_json = { version = "1.0.114", features = ["float_roundtrip"] }
Expand All @@ -30,4 +31,4 @@ tiledb-proc-macro = { path = "tiledb/proc-macro", version = "0.1.0" }
tiledb-sys = { path = "tiledb/sys", version = "0.1.0" }
tiledb-test-utils = { path = "tiledb/test-utils", version = "0.1.0" }
tiledb-utils = { path = "tiledb/utils", version = "0.1.0" }
pkg-config = "0.3.30"
trybuild = "1"
1 change: 1 addition & 0 deletions tiledb/api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ num-traits = { version = "0.2" }
proptest = { workspace = true }
proptest-derive = { workspace = true }
tiledb-test-utils = { workspace = true }
trybuild = { workspace = true }

[build-dependencies]
pkg-config = { workspace = true }
Expand Down
4 changes: 2 additions & 2 deletions tiledb/api/examples/fragment_info.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,15 +148,15 @@ fn create_array() -> TileDBResult<()> {
fn write_array() -> TileDBResult<()> {
let tdb = tiledb::context::Context::new()?;

let array = tiledb::Array::open(
let mut array = tiledb::Array::open(
&tdb,
FRAGMENT_INFO_ARRAY_URI,
tiledb::array::Mode::Write,
)?;

let data = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];

let query = tiledb::query::WriteBuilder::new(array)?
let query = tiledb::query::WriteBuilder::new(&mut array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.data_typed(FRAGMENT_INFO_ATTRIBUTE_NAME, &data)?
.build();
Expand Down
6 changes: 3 additions & 3 deletions tiledb/api/examples/multi_range_subarray.rs
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ fn main() -> TileDBResult<()> {
}

let array = Array::open(&ctx, ARRAY_URI, tiledb::array::Mode::Read)?;
let mut query = ReadBuilder::new(array)?
let mut query = ReadBuilder::new(&array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.register_constructor::<_, Vec<i32>>("rows", Default::default())?
.register_constructor::<_, Vec<i32>>("cols", Default::default())?
Expand Down Expand Up @@ -117,10 +117,10 @@ fn create_array(ctx: &Context) -> TileDBResult<()> {
fn write_array(ctx: &Context) -> TileDBResult<()> {
let data = vec![1i32, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];

let array =
let mut array =
tiledb::Array::open(ctx, ARRAY_URI, tiledb::array::Mode::Write)?;

let query = WriteBuilder::new(array)?
let query = WriteBuilder::new(&mut array)?
.layout(CellOrder::RowMajor)?
.data_typed("a", &data)?
.build();
Expand Down
6 changes: 3 additions & 3 deletions tiledb/api/examples/query_condition_dense.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ fn main() -> TileDBResult<()> {
/// to stdout.
fn read_array(ctx: &Context, qc: Option<QC>) -> TileDBResult<()> {
let array = tiledb::Array::open(ctx, ARRAY_URI, tiledb::array::Mode::Read)?;
let mut query = ReadBuilder::new(array)?
let mut query = ReadBuilder::new(&array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.register_constructor::<_, Vec<i32>>("index", Default::default())?
.register_constructor::<_, (Vec<i32>, Vec<u8>)>(
Expand Down Expand Up @@ -182,10 +182,10 @@ fn write_array(ctx: &Context) -> TileDBResult<()> {
let c_input = vec![0i32, 0, 0, 0, 0, 0, 1, 2, 3, 4];
let d_input = vec![4.1f32, 3.4, 5.6, 3.7, 2.3, 1.7, 3.8, 4.9, 3.2, 3.1];

let array =
let mut array =
tiledb::Array::open(ctx, ARRAY_URI, tiledb::array::Mode::Write)?;

let query = WriteBuilder::new(array)?
let query = WriteBuilder::new(&mut array)?
.data_typed("a", &a_input)?
.data_typed("b", &b_input)?
.data_typed("c", &c_input)?
Expand Down
6 changes: 3 additions & 3 deletions tiledb/api/examples/query_condition_sparse.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ fn main() -> TileDBResult<()> {
/// to stdout.
fn read_array(ctx: &Context, qc: Option<QC>) -> TileDBResult<()> {
let array = tiledb::Array::open(ctx, ARRAY_URI, tiledb::array::Mode::Read)?;
let mut query = ReadBuilder::new(array)?
let mut query = ReadBuilder::new(&array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.register_constructor::<_, Vec<i32>>("index", Default::default())?
.register_constructor::<_, (Vec<i32>, Vec<u8>)>(
Expand Down Expand Up @@ -184,10 +184,10 @@ fn write_array(ctx: &Context) -> TileDBResult<()> {
let c_input = vec![0i32, 0, 0, 0, 0, 0, 1, 2, 3, 4];
let d_input = vec![4.1f32, 3.4, 5.6, 3.7, 2.3, 1.7, 3.8, 4.9, 3.2, 3.1];

let array =
let mut array =
tiledb::Array::open(ctx, ARRAY_URI, tiledb::array::Mode::Write)?;

let query = WriteBuilder::new(array)?
let query = WriteBuilder::new(&mut array)?
.layout(CellOrder::Unordered)?
.data_typed("index", &index_input)?
.data_typed("a", &a_input)?
Expand Down
6 changes: 3 additions & 3 deletions tiledb/api/examples/quickstart_dense.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@ fn create_array() -> TileDBResult<()> {
fn write_array() -> TileDBResult<()> {
let tdb = tiledb::context::Context::new()?;

let array = tiledb::Array::open(
let mut array = tiledb::Array::open(
&tdb,
QUICKSTART_DENSE_ARRAY_URI,
tiledb::array::Mode::Write,
)?;

let data = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];

let query = tiledb::query::WriteBuilder::new(array)?
let query = tiledb::query::WriteBuilder::new(&mut array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.data_typed(QUICKSTART_ATTRIBUTE_NAME, &data)?
.build();
Expand All @@ -113,7 +113,7 @@ fn read_array() -> TileDBResult<()> {
tiledb::array::Mode::Read,
)?;

let mut query = tiledb::query::ReadBuilder::new(array)?
let mut query = tiledb::query::ReadBuilder::new(&array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.register_constructor::<_, Vec<i32>>(
QUICKSTART_ATTRIBUTE_NAME,
Expand Down
6 changes: 3 additions & 3 deletions tiledb/api/examples/quickstart_sparse_string.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ fn main() -> TileDBResult<()> {
}

let array = Array::open(&ctx, ARRAY_URI, tiledb::array::Mode::Read)?;
let mut query = ReadBuilder::new(array)?
let mut query = ReadBuilder::new(&array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.register_constructor::<_, Vec<String>>("rows", Default::default())?
.register_constructor::<_, Vec<i32>>("cols", Default::default())?
Expand Down Expand Up @@ -95,10 +95,10 @@ fn write_array(ctx: &Context) -> TileDBResult<()> {
let col_data = vec![1, 4, 3];
let a_data = vec![1, 2, 3];

let array =
let mut array =
tiledb::Array::open(ctx, ARRAY_URI, tiledb::array::Mode::Write)?;

let query = WriteBuilder::new(array)?
let query = WriteBuilder::new(&mut array)?
.layout(CellOrder::Unordered)?
.data_typed("rows", &row_data)?
.data_typed("cols", &col_data)?
Expand Down
29 changes: 18 additions & 11 deletions tiledb/api/examples/reading_incomplete.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use std::cell::{Ref, RefCell};
use std::path::PathBuf;

use itertools::izip;
use tiledb::array::{CellOrder, TileOrder};
use tiledb::array::{Array, CellOrder, TileOrder};
use tiledb::query::buffer::{
BufferMut, CellStructureMut, QueryBuffers, QueryBuffersMut,
};
Expand Down Expand Up @@ -103,7 +103,7 @@ fn create_array() -> TileDBResult<()> {
fn write_array() -> TileDBResult<()> {
let tdb = tiledb::Context::new()?;

let array =
let mut array =
tiledb::Array::open(&tdb, ARRAY_NAME, tiledb::array::Mode::Write)?;

let coords_rows = vec![1, 2, 2];
Expand All @@ -112,7 +112,7 @@ fn write_array() -> TileDBResult<()> {
let int32_data = vec![1, 2, 3];
let char_data = vec!["a", "bb", "ccc"];

let query = tiledb::query::WriteBuilder::new(array)?
let query = tiledb::query::WriteBuilder::new(&mut array)?
.layout(tiledb::query::QueryLayout::Global)?
.data_typed("rows", &coords_rows)?
.data_typed("columns", &coords_cols)?
Expand All @@ -128,11 +128,8 @@ fn write_array() -> TileDBResult<()> {
/// from a query. The example wants to print out the query result set.
/// Below are several different ways to implement this functionality.

fn query_builder_start(tdb: &tiledb::Context) -> TileDBResult<ReadBuilder> {
let array =
tiledb::Array::open(tdb, ARRAY_NAME, tiledb::array::Mode::Read)?;

tiledb::query::ReadBuilder::new(array)?
fn query_builder_start(array: &Array) -> TileDBResult<ReadBuilder> {
tiledb::query::ReadBuilder::new(&array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.start_subarray()?
.add_range(0, &[1i32, 4])?
Expand Down Expand Up @@ -187,7 +184,10 @@ fn read_array_step() -> TileDBResult<()> {
validity: None,
});

let mut qq = query_builder_start(&tdb)?
let array =
tiledb::Array::open(&tdb, ARRAY_NAME, tiledb::array::Mode::Read)?;

let mut qq = query_builder_start(&array)?
.register_raw("rows", &rows_output)?
.register_raw("columns", &cols_output)?
.register_raw(INT32_ATTRIBUTE_NAME, &int32_output)?
Expand Down Expand Up @@ -249,7 +249,10 @@ fn read_array_collect() -> TileDBResult<()> {

let tdb = tiledb::context::Context::new()?;

let mut qq = query_builder_start(&tdb)?
let array =
tiledb::Array::open(&tdb, ARRAY_NAME, tiledb::array::Mode::Read)?;

let mut qq = query_builder_start(&array)?
.register_constructor::<_, Vec<i32>>(
"rows",
ScratchStrategy::CustomAllocator(Box::new(NonVarSized {
Expand Down Expand Up @@ -326,7 +329,11 @@ fn read_array_callback() -> TileDBResult<()> {
)),
validity: None,
});
let mut qq = query_builder_start(&tdb)?

let array =
tiledb::Array::open(&tdb, ARRAY_NAME, tiledb::array::Mode::Read)?;

let mut qq = query_builder_start(&array)?
.register_callback4::<FnMutAdapter<(i32, i32, i32, String), _>>(
("rows", ScratchStrategy::RawBuffers(&rows_output)),
("columns", ScratchStrategy::RawBuffers(&cols_output)),
Expand Down
6 changes: 3 additions & 3 deletions tiledb/api/examples/using_tiledb_stats.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ pub fn create_array(
/// [143988000, 143988001 ... 143999999]]
pub fn write_array() -> TileDBResult<()> {
let tdb = tiledb::context::Context::new()?;
let array: Array =
let mut array: Array =
tiledb::Array::open(&tdb, ARRAY_NAME, tiledb::array::Mode::Write)?;
let data: Vec<i32> = Vec::from_iter(0..12000 * 12000);

let query = tiledb::query::WriteBuilder::new(array)?
let query = tiledb::query::WriteBuilder::new(&mut array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.data_typed(ATTRIBUTE_NAME, &data)?
.build();
Expand Down Expand Up @@ -131,7 +131,7 @@ pub fn read_array(json: bool) -> TileDBResult<()> {
let array =
tiledb::Array::open(&tdb, ARRAY_NAME, tiledb::array::Mode::Read)?;

let mut query = tiledb::query::ReadBuilder::new(array)?
let mut query = tiledb::query::ReadBuilder::new(&array)?
.layout(tiledb::query::QueryLayout::RowMajor)?
.register_constructor::<_, Vec<i32>>(
ATTRIBUTE_NAME,
Expand Down
11 changes: 6 additions & 5 deletions tiledb/api/src/array/fragment_info.rs
Original file line number Diff line number Diff line change
Expand Up @@ -975,9 +975,10 @@ pub mod tests {
/// Write another fragment to the test array.
fn write_dense_array(ctx: &Context, array_uri: &str) -> TileDBResult<()> {
let data = vec![1u64, 2, 3, 4, 5, 6, 7, 8, 9, 10];
let array = Array::open(ctx, array_uri, Mode::Write)?;
let query =
WriteBuilder::new(array)?.data_typed("attr", &data)?.build();
let mut array = Array::open(ctx, array_uri, Mode::Write)?;
let query = WriteBuilder::new(&mut array)?
.data_typed("attr", &data)?
.build();
query.submit()?;
Ok(())
}
Expand Down Expand Up @@ -1021,8 +1022,8 @@ pub mod tests {
fn write_sparse_array(ctx: &Context, array_uri: &str) -> TileDBResult<()> {
let id_data = vec![1u32, 2, 3, 4, 5, 6, 7, 8, 9, 10];
let attr_data = vec![1u64, 2, 3, 4, 5, 6, 7, 8, 9, 10];
let array = Array::open(ctx, array_uri, Mode::Write)?;
let query = WriteBuilder::new(array)?
let mut array = Array::open(ctx, array_uri, Mode::Write)?;
let query = WriteBuilder::new(&mut array)?
.data_typed("id", &id_data)?
.data_typed("attr", &attr_data)?
.build();
Expand Down
Loading
Loading