Struct TableStore 

pub struct TableStore { /* private fields */ }

Veilid Table Storage. Database for storing key value pairs persistently and securely across runs.

Implementations

impl TableStore

pub async fn tick(&self, _lag: Option<TimestampDuration>) -> EyreResult<()>

Run the periodic flush and cleanup table maintenance tasks.

No-op before init or after shutdown. Each subtask only runs once its interval has elapsed (60s flush, 600s cleanup), so calling more often is cheap; an actual flush or cleanup run blocks on disk.

impl TableStore

pub fn list_all(&self) -> Vec<(String, String)>

List all known tables

Reads cached names locally without blocking on disk; returns empty before init or after shutdown.

pub async fn delete_all(&self)

Delete all known tables

No-op before init or after shutdown. Blocks on deleting each table on disk and flushing.

pub async fn open( &self, name: &str, column_count: u32, ) -> VeilidAPIResult<TableDB>

Get or create a TableDB database table. If the column count is greater than an existing TableDB’s column count, the database will be upgraded to add the missing columns.

Returns a TableDB handle the caller must drop before the table can be deleted; while any clone is held the table counts as opened. Opening the same name again returns a handle to the same shared database. Blocks on opening the on-disk database.

Same errors as open_pooled.

pub async fn open_pooled( &self, name: &str, column_count: u32, concurrency: usize, ) -> VeilidAPIResult<TableDB>

Get or create a TableDB table, opening a pool of concurrency database connections for it. Like open, upgrades the table if column_count exceeds the existing column count.

Returns a TableDB handle the caller must drop before the table can be deleted; while any clone is held the table counts as opened. Opening the same name again returns a handle to the same shared database. Blocks on opening the on-disk database.

Errors with:

• VeilidAPIError::InvalidArgument if column_count is zero or name contains characters other than alphanumeric, _, or -.
• VeilidAPIError::NotInitialized before init or after shutdown, or when the existing data fails to decrypt (wrong device encryption key) and wipe_on_invalid_device_encryption_key is disabled.
• VeilidAPIError::Generic if the table is already open with a smaller column count than requested (close it first), or if the backing-store open fails (::Internal for filesystem-permission failures).

pub async fn delete(&self, name: &str) -> VeilidAPIResult<bool>

Delete a TableDB table by name

Errors if the table is still opened; the caller must drop all TableDB handles for it first. Blocks on the on-disk delete and flush.

Returns Ok(false) if no table by that name exists. Errors with:

• VeilidAPIError::NotInitialized before init or after shutdown.
• VeilidAPIError::InvalidArgument if name contains characters other than alphanumeric, _, or -.
• VeilidAPIError::Generic if the table is still opened (drop all handles first) or the backing-store delete fails.

pub async fn info(&self, name: &str) -> VeilidAPIResult<Option<TableInfo>>

Get column and key-count information for a table, or None if it does not exist.

Opens the table to read it; blocks on the on-disk open and key-count reads.

Errors with VeilidAPIError::NotInitialized before init or after shutdown, the same errors as open (the table is opened to read it), or VeilidAPIError::Generic if a column-count or key-count read fails.

pub async fn rename( &self, old_name: &str, new_name: &str, ) -> VeilidAPIResult<()>

Rename a TableDB table

Blocks on flushing the renamed name table to disk.

Errors with:

• VeilidAPIError::NotInitialized before init or after shutdown.
• VeilidAPIError::InvalidArgument if old_name or new_name contains characters other than alphanumeric, _, or -.
• VeilidAPIError::Generic if new_name already exists or old_name does not exist.

Trait Implementations

impl Debug for TableStore

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

Formats the value using the given formatter.