DirectoryNamespace

Struct DirectoryNamespace 

Source
pub struct DirectoryNamespace { /* private fields */ }
Expand description

Directory-based implementation of Lance Namespace.

This implementation stores tables as Lance datasets in a directory structure. It supports local filesystems and cloud storage backends through Lance’s object store.

§Manifest-based Listing

When manifest_enabled=true, the namespace uses a special __manifest Lance table to track tables instead of scanning the filesystem. This provides:

  • Better performance for listing operations
  • Ability to track table metadata
  • Foundation for future features like namespaces and table renaming

When dir_listing_enabled=true, the namespace falls back to directory scanning for tables not found in the manifest, enabling gradual migration.

Implementations§

Source§

impl DirectoryNamespace

Source

pub async fn migrate(&self) -> Result<usize>

Migrate directory-based tables to the manifest.

This is a one-time migration operation that:

  1. Scans the directory for existing .lance tables
  2. Registers any unmigrated tables in the manifest
  3. Returns the count of tables that were migrated

This method is safe to run multiple times - it will skip tables that are already registered in the manifest.

§Usage

After creating tables in directory-only mode or dual mode, you can migrate them to the manifest to enable manifest-only mode:

// Create namespace with dual mode (manifest + directory listing)
let namespace = DirectoryNamespaceBuilder::new("/path/to/data")
    .manifest_enabled(true)
    .dir_listing_enabled(true)
    .build()
    .await?;

// ... tables are created and used ...

// Migrate existing directory tables to manifest
let migrated_count = namespace.migrate().await?;
println!("Migrated {} tables", migrated_count);

// Now you can disable directory listing for better performance:
// (requires rebuilding the namespace)
let namespace = DirectoryNamespaceBuilder::new("/path/to/data")
    .manifest_enabled(true)
    .dir_listing_enabled(false)  // All tables now in manifest
    .build()
    .await?;
§Returns

Returns the number of tables that were migrated to the manifest.

§Errors

Returns an error if:

  • Manifest is not enabled
  • Directory listing fails
  • Manifest registration fails

Trait Implementations§

Source§

impl Debug for DirectoryNamespace

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for DirectoryNamespace

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl LanceNamespace for DirectoryNamespace

Source§

fn list_namespaces<'life0, 'async_trait>( &'life0 self, request: ListNamespacesRequest, ) -> Pin<Box<dyn Future<Output = Result<ListNamespacesResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List namespaces.
Source§

fn describe_namespace<'life0, 'async_trait>( &'life0 self, request: DescribeNamespaceRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeNamespaceResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Describe a namespace.
Source§

fn create_namespace<'life0, 'async_trait>( &'life0 self, request: CreateNamespaceRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateNamespaceResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Create a new namespace.
Source§

fn drop_namespace<'life0, 'async_trait>( &'life0 self, request: DropNamespaceRequest, ) -> Pin<Box<dyn Future<Output = Result<DropNamespaceResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Drop a namespace.
Source§

fn namespace_exists<'life0, 'async_trait>( &'life0 self, request: NamespaceExistsRequest, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Check if a namespace exists.
Source§

fn list_tables<'life0, 'async_trait>( &'life0 self, request: ListTablesRequest, ) -> Pin<Box<dyn Future<Output = Result<ListTablesResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List tables in a namespace.
Source§

fn describe_table<'life0, 'async_trait>( &'life0 self, request: DescribeTableRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeTableResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Describe a table.
Source§

fn table_exists<'life0, 'async_trait>( &'life0 self, request: TableExistsRequest, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Check if a table exists.
Source§

fn drop_table<'life0, 'async_trait>( &'life0 self, request: DropTableRequest, ) -> Pin<Box<dyn Future<Output = Result<DropTableResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Drop a table.
Source§

fn create_table<'life0, 'async_trait>( &'life0 self, request: CreateTableRequest, request_data: Bytes, ) -> Pin<Box<dyn Future<Output = Result<CreateTableResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Create a new table with data from Arrow IPC stream.
Source§

fn create_empty_table<'life0, 'async_trait>( &'life0 self, request: CreateEmptyTableRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateEmptyTableResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Create an empty table (metadata only operation).
Source§

fn register_table<'life0, 'async_trait>( &'life0 self, request: RegisterTableRequest, ) -> Pin<Box<dyn Future<Output = Result<RegisterTableResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Register a table.
Source§

fn deregister_table<'life0, 'async_trait>( &'life0 self, request: DeregisterTableRequest, ) -> Pin<Box<dyn Future<Output = Result<DeregisterTableResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Deregister a table.
Source§

fn namespace_id(&self) -> String

Return a human-readable unique identifier for this namespace instance. Read more
Source§

fn count_table_rows<'life0, 'async_trait>( &'life0 self, _request: CountTableRowsRequest, ) -> Pin<Box<dyn Future<Output = Result<i64, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Count rows in a table.
Source§

fn insert_into_table<'life0, 'async_trait>( &'life0 self, _request: InsertIntoTableRequest, _request_data: Bytes, ) -> Pin<Box<dyn Future<Output = Result<InsertIntoTableResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Insert data into a table.
Source§

fn merge_insert_into_table<'life0, 'async_trait>( &'life0 self, _request: MergeInsertIntoTableRequest, _request_data: Bytes, ) -> Pin<Box<dyn Future<Output = Result<MergeInsertIntoTableResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Merge insert data into a table.
Source§

fn update_table<'life0, 'async_trait>( &'life0 self, _request: UpdateTableRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateTableResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Update a table.
Source§

fn delete_from_table<'life0, 'async_trait>( &'life0 self, _request: DeleteFromTableRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteFromTableResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Delete from a table.
Source§

fn query_table<'life0, 'async_trait>( &'life0 self, _request: QueryTableRequest, ) -> Pin<Box<dyn Future<Output = Result<Bytes, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Query a table.
Source§

fn create_table_index<'life0, 'async_trait>( &'life0 self, _request: CreateTableIndexRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateTableIndexResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Create a table index.
Source§

fn list_table_indices<'life0, 'async_trait>( &'life0 self, _request: ListTableIndicesRequest, ) -> Pin<Box<dyn Future<Output = Result<ListTableIndicesResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

List table indices.
Source§

fn describe_table_index_stats<'life0, 'async_trait>( &'life0 self, _request: DescribeTableIndexStatsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeTableIndexStatsResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Describe table index statistics.
Source§

fn describe_transaction<'life0, 'async_trait>( &'life0 self, _request: DescribeTransactionRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeTransactionResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Describe a transaction.
Source§

fn alter_transaction<'life0, 'async_trait>( &'life0 self, _request: AlterTransactionRequest, ) -> Pin<Box<dyn Future<Output = Result<AlterTransactionResponse, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Alter a transaction.

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> ToString for T
where T: Display + ?Sized,

§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool

Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<T> MaybeSend for T
where T: Send,