Clarify docs in session accessors

Signed-off-by: Nicholas Gates <[email protected]>

Author: gatesn

vortex-array/src/arrays/chunked/vtable/mod.rs

@@ -6,14 +6,16 @@ use vortex_buffer::BufferHandle;
 use vortex_dtype::DType;
 use vortex_dtype::Nullability;
 use vortex_dtype::PType;
+use vortex_error::VortexResult;
 use vortex_error::vortex_bail;
 use vortex_error::vortex_err;
-use vortex_error::VortexResult;
 use vortex_mask::Mask;
 use vortex_vector::Vector;
 use vortex_vector::VectorMut;
 use vortex_vector::VectorMutOps;
 
+use crate::EmptyMetadata;
+use crate::ToCanonical;
 use crate::arrays::ChunkedArray;
 use crate::arrays::PrimitiveArray;
 use crate::kernel::BindCtx;
@@ -28,8 +30,6 @@ use crate::vtable::ArrayVTable;
 use crate::vtable::ArrayVTableExt;
 use crate::vtable::NotSupported;
 use crate::vtable::VTable;
-use crate::EmptyMetadata;
-use crate::ToCanonical;
 
 mod array;
 mod canonical;

vortex-array/src/arrays/filter/vtable.rs

@@ -7,15 +7,24 @@ use std::ops::Range;
 use vortex_buffer::BufferHandle;
 use vortex_compute::filter::Filter;
 use vortex_dtype::DType;
-use vortex_error::vortex_bail;
 use vortex_error::VortexExpect;
 use vortex_error::VortexResult;
+use vortex_error::vortex_bail;
 use vortex_mask::Mask;
 use vortex_scalar::Scalar;
 
+use crate::Array;
+use crate::ArrayBufferVisitor;
+use crate::ArrayChildVisitor;
+use crate::ArrayEq;
+use crate::ArrayHash;
+use crate::ArrayRef;
+use crate::Canonical;
+use crate::IntoArray;
+use crate::Precision;
+use crate::arrays::LEGACY_SESSION;
 use crate::arrays::filter::array::FilterArray;
 use crate::arrays::filter::kernel::FilterKernel;
-use crate::arrays::LEGACY_SESSION;
 use crate::kernel::BindCtx;
 use crate::kernel::KernelRef;
 use crate::kernel::PushDownResult;
@@ -33,15 +42,6 @@ use crate::vtable::OperationsVTable;
 use crate::vtable::VTable;
 use crate::vtable::ValidityVTable;
 use crate::vtable::VisitorVTable;
-use crate::Array;
-use crate::ArrayBufferVisitor;
-use crate::ArrayChildVisitor;
-use crate::ArrayEq;
-use crate::ArrayHash;
-use crate::ArrayRef;
-use crate::Canonical;
-use crate::IntoArray;
-use crate::Precision;
 
 vtable!(Filter);
 
@@ -83,14 +83,15 @@ impl VTable for FilterVTable {
         &self,
         dtype: &DType,
         len: usize,
-        metadata: &Self::Metadata,
+        selection_mask: &Mask,
         _buffers: &[BufferHandle],
         children: &dyn ArrayChildren,
     ) -> VortexResult<Self::Array> {
-        let child = children.get(0, dtype, len)?;
+        assert_eq!(len, selection_mask.true_count());
+        let child = children.get(0, dtype, selection_mask.len())?;
         Ok(FilterArray {
             child,
-            mask: metadata.clone(),
+            mask: selection_mask.clone(),
             stats: Default::default(),
         })
     }

vortex-array/src/arrays/scalar_fn/vtable/canonical.rs

@@ -4,15 +4,15 @@
 use itertools::Itertools;
 use vortex_error::VortexExpect;
 
+use crate::Array;
+use crate::Canonical;
+use crate::arrays::LEGACY_SESSION;
 use crate::arrays::scalar_fn::array::ScalarFnArray;
 use crate::arrays::scalar_fn::vtable::ScalarFnVTable;
-use crate::arrays::LEGACY_SESSION;
 use crate::executor::VectorExecutor;
 use crate::expr::ExecutionArgs;
 use crate::vectors::VectorIntoArray;
 use crate::vtable::CanonicalVTable;
-use crate::Array;
-use crate::Canonical;
 
 impl CanonicalVTable<ScalarFnVTable> for ScalarFnVTable {
     fn canonicalize(array: &ScalarFnArray) -> Canonical {

vortex-array/src/arrays/scalar_fn/vtable/mod.rs

@@ -13,15 +13,18 @@ use std::ops::Deref;
 use itertools::Itertools;
 use vortex_buffer::BufferHandle;
 use vortex_dtype::DType;
+use vortex_error::VortexResult;
 use vortex_error::vortex_bail;
 use vortex_error::vortex_ensure;
-use vortex_error::VortexResult;
 
+use crate::Array;
+use crate::ArrayRef;
+use crate::IntoArray;
+use crate::arrays::ConstantVTable;
 use crate::arrays::scalar_fn::array::ScalarFnArray;
 use crate::arrays::scalar_fn::kernel::KernelInput;
 use crate::arrays::scalar_fn::kernel::ScalarFnKernel;
 use crate::arrays::scalar_fn::metadata::ScalarFnMetadata;
-use crate::arrays::ConstantVTable;
 use crate::expr;
 use crate::expr::ExprVTable;
 use crate::expr::ScalarFn;
@@ -36,9 +39,6 @@ use crate::vtable::ArrayVTable;
 use crate::vtable::ArrayVTableExt;
 use crate::vtable::NotSupported;
 use crate::vtable::VTable;
-use crate::Array;
-use crate::ArrayRef;
-use crate::IntoArray;
 
 vtable!(ScalarFn);
 

vortex-array/src/arrays/struct_/mod.rs

@@ -7,7 +7,7 @@ mod compute;
 mod rules;
 
 mod vtable;
-pub use rules::*;
+pub(crate) use rules::*;
 pub use vtable::StructVTable;
 
 #[cfg(test)]

vortex-array/src/arrays/struct_/rules.rs

@@ -3,6 +3,9 @@
 
 use vortex_error::VortexResult;
 
+use crate::Array;
+use crate::ArrayRef;
+use crate::IntoArray;
 use crate::arrays::ConstantArray;
 use crate::arrays::ExactScalarFn;
 use crate::arrays::ScalarFnArrayExt;
@@ -16,9 +19,6 @@ use crate::optimizer::rules::ArrayParentReduceRule;
 use crate::optimizer::rules::Exact;
 use crate::validity::Validity;
 use crate::vtable::ValidityHelper;
-use crate::Array;
-use crate::ArrayRef;
-use crate::IntoArray;
 
 #[derive(Debug)]
 pub(crate) struct StructGetItemRule;

vortex-array/src/executor.rs

@@ -1,18 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: Copyright the Vortex contributors
 
-use vortex_error::vortex_ensure;
 use vortex_error::VortexResult;
+use vortex_error::vortex_ensure;
 use vortex_session::VortexSession;
 use vortex_vector::Datum;
 use vortex_vector::Vector;
 use vortex_vector::VectorOps;
 
+use crate::Array;
+use crate::ArrayRef;
 use crate::arrays::ConstantVTable;
 use crate::kernel::BindCtx;
 use crate::session::ArraySessionExt;
-use crate::Array;
-use crate::ArrayRef;
 
 /// Executor for exporting a Vortex [`Vector`] or [`Datum`] from an [`ArrayRef`].
 pub trait VectorExecutor {

vortex-array/src/expr/exprs/binary.rs

@@ -8,14 +8,15 @@ use prost::Message;
 use vortex_compute::arrow::IntoArrow;
 use vortex_compute::arrow::IntoVector;
 use vortex_dtype::DType;
-use vortex_error::vortex_bail;
-use vortex_error::vortex_err;
 use vortex_error::VortexExpect;
 use vortex_error::VortexResult;
+use vortex_error::vortex_bail;
+use vortex_error::vortex_err;
 use vortex_proto::expr as pb;
 use vortex_vector::Datum;
 use vortex_vector::VectorOps;
 
+use crate::ArrayRef;
 use crate::compute;
 use crate::compute::add;
 use crate::compute::and_kleene;
@@ -24,18 +25,17 @@ use crate::compute::div;
 use crate::compute::mul;
 use crate::compute::or_kleene;
 use crate::compute::sub;
-use crate::expr::expression::Expression;
-use crate::expr::exprs::literal::lit;
-use crate::expr::exprs::operators::Operator;
-use crate::expr::stats::Stat;
 use crate::expr::Arity;
 use crate::expr::ChildName;
 use crate::expr::ExecutionArgs;
 use crate::expr::ExprId;
 use crate::expr::StatsCatalog;
 use crate::expr::VTable;
 use crate::expr::VTableExt;
-use crate::ArrayRef;
+use crate::expr::expression::Expression;
+use crate::expr::exprs::literal::lit;
+use crate::expr::exprs::operators::Operator;
+use crate::expr::stats::Stat;
 
 pub struct Binary;
 
@@ -589,10 +589,10 @@ mod tests {
     use super::lt_eq;
     use super::not_eq;
     use super::or;
+    use crate::expr::Expression;
     use crate::expr::exprs::get_item::col;
     use crate::expr::exprs::literal::lit;
     use crate::expr::test_harness;
-    use crate::expr::Expression;
 
     #[test]
     fn and_collect_left_assoc() {

vortex-array/src/expr/exprs/get_item.rs

@@ -9,18 +9,18 @@ use vortex_dtype::DType;
 use vortex_dtype::FieldName;
 use vortex_dtype::FieldPath;
 use vortex_dtype::Nullability;
-use vortex_error::vortex_err;
 use vortex_error::VortexExpect;
 use vortex_error::VortexResult;
+use vortex_error::vortex_err;
 use vortex_mask::Mask;
 use vortex_proto::expr as pb;
 use vortex_vector::Datum;
 use vortex_vector::ScalarOps;
 use vortex_vector::VectorOps;
 
+use crate::ArrayRef;
+use crate::ToCanonical;
 use crate::compute::mask;
-use crate::expr::exprs::root::root;
-use crate::expr::stats::Stat;
 use crate::expr::Arity;
 use crate::expr::ChildName;
 use crate::expr::ExecutionArgs;
@@ -31,8 +31,8 @@ use crate::expr::SimplifyCtx;
 use crate::expr::StatsCatalog;
 use crate::expr::VTable;
 use crate::expr::VTableExt;
-use crate::ArrayRef;
-use crate::ToCanonical;
+use crate::expr::exprs::root::root;
+use crate::expr::stats::Stat;
 
 pub struct GetItem;
 
@@ -232,15 +232,15 @@ mod tests {
     use vortex_dtype::StructFields;
     use vortex_scalar::Scalar;
 
+    use crate::Array;
+    use crate::IntoArray;
     use crate::arrays::StructArray;
     use crate::expr::exprs::binary::checked_add;
     use crate::expr::exprs::get_item::get_item;
     use crate::expr::exprs::literal::lit;
     use crate::expr::exprs::pack::pack;
     use crate::expr::exprs::root::root;
     use crate::validity::Validity;
-    use crate::Array;
-    use crate::IntoArray;
 
     fn test_array() -> StructArray {
         StructArray::from_fields(&[

vortex-array/src/expr/exprs/like.rs

@@ -12,6 +12,7 @@ use vortex_error::vortex_bail;
 use vortex_error::vortex_err;
 use vortex_proto::expr as pb;
 use vortex_vector::Datum;
+use vortex_vector::VectorOps;
 
 use crate::ArrayRef;
 use crate::compute::LikeOptions;
@@ -128,6 +129,12 @@ impl VTable for Like {
             (true, true) => arrow_string::like::nilike(child.as_ref(), pattern.as_ref()),
         }?;
 
+        let vector = array.into_vector()?;
+        if vector.len() == 1 && args.row_count != 1 {
+            // Arrow returns a scalar datum result
+            return Ok(Datum::Scalar(vector.scalar_at(0).into()));
+        }
+
         Ok(Datum::Vector(array.into_vector()?.into()))
     }