ReadOnlyConnection

Struct ReadOnlyConnection 

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

Read-only database connection

This connection type enforces read-only access at the API level. All write methods (put, delete, etc.) are not available on this type.

§Use Case

Use this when you need concurrent read access while another process is writing to the database (e.g., Flowtrace App reading while a background script writes).

§Example

use sochdb::ReadOnlyConnection;

// Open read-only connection (acquires shared lock)
let reader = ReadOnlyConnection::open("./data")?;

// Read operations work
let value = reader.get(b"key")?;
let items = reader.scan(b"prefix")?;

// Write operations are not available - compile error!
// reader.put(b"key", b"value"); // Error: no method named `put`

Implementations§

Source§

impl ReadOnlyConnection

Source

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open a read-only connection to the database.

Multiple read-only connections can be open simultaneously. Write operations are not available on this connection type.

Source

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

Begin a read transaction for consistent snapshot reads

Source

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

End the read transaction

Source

pub fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Get a value by key

Source

pub fn scan(&self, prefix: &[u8]) -> Result<Vec<(Vec<u8>, Vec<u8>)>>

Scan keys with a prefix

Source

pub fn get_path(&self, path: &str) -> Result<Option<Vec<u8>>>

Get a value by path

Source

pub fn scan_path(&self, prefix: &str) -> Result<Vec<(String, Vec<u8>)>>

Scan by path prefix

Source

pub fn resolve(&self, path: &str) -> Result<PathResolution>

Resolve a path (O(|path|) lookup)

Source

pub fn queries_executed(&self) -> u64

Get query statistics

Trait Implementations§

Source§

impl ReadableConnection for ReadOnlyConnection

Source§

fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Get a value by key
Source§

fn scan(&self, prefix: &[u8]) -> Result<Vec<(Vec<u8>, Vec<u8>)>>

Scan keys with a prefix
Source§

fn get_path(&self, path: &str) -> Result<Option<Vec<u8>>>

Get a value by path
Source§

fn scan_path(&self, prefix: &str) -> Result<Vec<(String, Vec<u8>)>>

Scan by path prefix

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

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<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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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