Struct StructuredDb 

pub struct StructuredDb { /* private fields */ }

Implementations

impl StructuredDb

pub fn open( config: Config, bucket_ranges: Vec<RangeInclusive<u16>>, ) -> Result<Self>

pub fn open_from_snapshot( config: Config, snapshot_id: u64, db_id: impl Into<String>, ) -> Result<Self>

pub fn open_from_snapshot_with_resolver( config: Config, snapshot_id: u64, db_id: impl Into<String>, resolver: Option<Arc<dyn MergeOperatorResolver>>, ) -> Result<Self>

pub fn open_from_snapshot_with_recovery_mode( config: Config, snapshot_id: u64, db_id: impl Into<String>, recovery_mode: RecoveryMode, ) -> Result<Self>

Open a selected snapshot using the requested WAL recovery behavior.

pub fn open_new_with_snapshot( config: Config, snapshot_id: u64, db_id: impl Into<String>, ) -> Result<Self>

pub fn open_new_with_snapshot_with_resolver( config: Config, snapshot_id: u64, db_id: impl Into<String>, resolver: Option<Arc<dyn MergeOperatorResolver>>, ) -> Result<Self>

pub fn open_new_with_manifest_path( config: Config, manifest_path: impl Into<String>, ) -> Result<Self>

pub fn open_new_with_manifest_path_with_resolver( config: Config, manifest_path: impl Into<String>, resolver: Option<Arc<dyn MergeOperatorResolver>>, ) -> Result<Self>

pub fn resume(config: Config, db_id: impl Into<String>) -> Result<Self>

pub fn resume_with_resolver( config: Config, db_id: impl Into<String>, resolver: Option<Arc<dyn MergeOperatorResolver>>, ) -> Result<Self>

pub fn resume_with_recovery_mode( config: Config, db_id: impl Into<String>, recovery_mode: RecoveryMode, ) -> Result<Self>

Resume the latest snapshot using the requested WAL recovery behavior.

pub fn resume_from_snapshot( config: Config, snapshot_id: u64, db_id: impl Into<String>, ) -> Result<Self>

Resume an exact historical snapshot without replaying WAL.

pub fn resume_from_snapshot_with_resolver( config: Config, snapshot_id: u64, db_id: impl Into<String>, resolver: Option<Arc<dyn MergeOperatorResolver>>, ) -> Result<Self>

Resume an exact historical snapshot with a custom merge-operator resolver.

pub fn resume_from_snapshot_with_recovery_mode( config: Config, snapshot_id: u64, db_id: impl Into<String>, recovery_mode: RecoveryMode, ) -> Result<Self>

Resume a selected snapshot using the requested WAL recovery behavior.

pub fn expand_bucket( &self, source_db_id: impl Into<String>, snapshot_id: Option<u64>, ranges: Option<Vec<RangeInclusive<u16>>>, ) -> Result<u64>

pub fn expand_bucket_with_storage_mode( &self, source_db_id: impl Into<String>, snapshot_id: Option<u64>, ranges: Option<Vec<RangeInclusive<u16>>>, storage_mode: ExpandStorageMode, ) -> Result<u64>

pub fn wait_for_expand_adoption(&self, timeout: Duration) -> Result<()>

pub fn shrink_bucket(&self, ranges: Vec<RangeInclusive<u16>>) -> Result<u64>

pub fn id(&self) -> &str

pub fn metrics(&self) -> Vec<MetricSample>

Returns the native Cobble metric samples for this structured database.

pub fn current_schema(&self) -> StructuredSchema

pub fn register_schema_transform<F, T>( &self, transform_type: impl Into<String>, factory: F, ) -> Result<()>

where F: Fn(&[u8]) -> Result<T> + Send + Sync + 'static, T: Fn(Option<Bytes>) -> Result<Option<Bytes>> + Send + Sync + 'static,

Register a factory for raw single-column transform specifications.

pub fn update_schema(&mut self) -> StructuredSchemaBuilder<'_, Self>

pub fn new_priority_queue<'a>( &'a mut self, name: impl Into<String>, ) -> Result<PriorityQueue<'a>>

pub fn get_priority_queue<'a>( &'a self, name: impl Into<String>, ) -> Result<PriorityQueue<'a>>

pub fn get_or_new_priority_queue<'a>( &'a mut self, name: impl Into<String>, ) -> Result<PriorityQueue<'a>>

pub fn reload_schema(&mut self) -> Result<()>

pub fn apply_schema( &mut self, structured_schema: StructuredSchema, ) -> Result<StructuredSchema>

pub fn put<K, V>( &self, bucket: u16, key: K, column: u16, value: V, ) -> Result<()>

where K: AsRef<[u8]>, V: Into<StructuredColumnValue>,

pub fn put_with_options<K, V>( &self, bucket: u16, key: K, column: u16, value: V, options: &StructuredWriteOptions, ) -> Result<()>

where K: AsRef<[u8]>, V: Into<StructuredColumnValue>,

pub fn merge<K, V>( &self, bucket: u16, key: K, column: u16, value: V, ) -> Result<()>

where K: AsRef<[u8]>, V: Into<StructuredColumnValue>,

pub fn merge_with_options<K, V>( &self, bucket: u16, key: K, column: u16, value: V, options: &StructuredWriteOptions, ) -> Result<()>

where K: AsRef<[u8]>, V: Into<StructuredColumnValue>,

pub fn delete<K>(&self, bucket: u16, key: K, column: u16) -> Result<()>

where K: AsRef<[u8]>,

pub fn delete_with_options<K>( &self, bucket: u16, key: K, column: u16, options: &StructuredWriteOptions, ) -> Result<()>

where K: AsRef<[u8]>,

pub fn new_write_batch(&self) -> StructuredWriteBatch

pub fn write_batch(&self, batch: StructuredWriteBatch) -> Result<()>

pub fn write_batch_with_options( &self, batch: StructuredWriteBatch, options: &StructuredWriteOptions, ) -> Result<()>

pub fn get<K>( &self, bucket: u16, key: K, ) -> Result<Option<Vec<Option<StructuredColumnValue>>>>

where K: AsRef<[u8]>,

pub fn multi_get<K>( &self, keys: &[(u16, K)], ) -> Result<Vec<Option<Vec<Option<StructuredColumnValue>>>>>

where K: AsRef<[u8]>,

pub fn multi_get_with_options<K>( &self, keys: &[(u16, K)], options: &StructuredReadOptions, ) -> Result<Vec<Option<Vec<Option<StructuredColumnValue>>>>>

where K: AsRef<[u8]>,

pub fn get_with_options<K>( &self, bucket: u16, key: K, options: &StructuredReadOptions, ) -> Result<Option<Vec<Option<StructuredColumnValue>>>>

where K: AsRef<[u8]>,

pub fn scan( &self, bucket: u16, range: Range<&[u8]>, ) -> Result<StructuredDbIterator>

pub fn scan_with_options( &self, bucket: u16, range: Range<&[u8]>, options: &StructuredScanOptions, ) -> Result<StructuredDbIterator>

pub fn scan_bounds( &self, bucket: u16, start_key_inclusive: Option<&[u8]>, end_key_exclusive: Option<&[u8]>, ) -> Result<StructuredDbIterator>

pub fn scan_with_options_bounds( &self, bucket: u16, start_key_inclusive: Option<&[u8]>, end_key_exclusive: Option<&[u8]>, options: &StructuredScanOptions, ) -> Result<StructuredDbIterator>

pub fn snapshot(&self) -> Result<u64>

pub fn switch_to_snapshot(&mut self, snapshot_id: u64) -> Result<()>

Switch this running handle to an exact historical snapshot.

pub fn switch_memtable_type( &self, memtable_type: MemtableType, flush_current: bool, ) -> Result<()>

Change the memtable implementation for future rotations.

flush_current = false leaves the active memtable untouched; true rotates a non-empty active memtable now through the normal flush path.

pub fn load_readonly_files_to_primary(&self) -> Result<usize>

Mark all currently referenced READONLY files for asynchronous loading into primary storage.

pub fn snapshot_with_callback<F>(&self, callback: F) -> Result<u64>

where F: Fn(Result<ShardSnapshotMetadata>) + Send + Sync + 'static,

pub fn cancel_snapshot(&self, snapshot_id: u64) -> Result<bool>

pub fn expire_snapshot(&self, snapshot_id: u64) -> Result<bool>

pub fn retain_snapshot(&self, snapshot_id: u64) -> bool

pub fn shard_snapshot_metadata( &self, snapshot_id: u64, ) -> Result<ShardSnapshotMetadata>

pub fn set_time(&self, next: u32)

pub fn now_seconds(&self) -> u32

pub fn close(&self) -> Result<()>