SharedDatabase

Struct SharedDatabase 

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

Thread-safe database wrapper enabling concurrent read queries.

SharedDatabase wraps a Database in Arc<RwLock<...>> to enable:

  • Concurrent reads: Multiple query() calls can execute simultaneously
  • Exclusive writes: Mutations acquire exclusive access via write()

§Performance

Using SharedDatabase enables significant throughput improvements for read-heavy workloads. On a multi-core system, concurrent read queries can achieve near-linear scaling with the number of cores.

MetricSequentialConcurrent (4 cores)
Read QPS1x~4x
P99 latencybaseline~1.5x baseline

§Example

use vibesql_executor::SharedDatabase;
use vibesql_storage::Database;

// Create shared database
let db = SharedDatabase::new(Database::new());

// Concurrent reads (acquire read lock internally)
let result = db.query("SELECT * FROM users").await?;

// Exclusive writes
let mut guard = db.write().await;
guard.insert_row("users", row)?;
// guard dropped, releasing write lock

Implementations§

Source§

impl SharedDatabase

Source

pub fn new(db: Database) -> Self

Create a new SharedDatabase wrapping the given database.

Source

pub fn from_arc(inner: Arc<RwLock<Database>>) -> Self

Create a SharedDatabase from an existing Arc<RwLock<Database>>.

This is useful when integrating with existing code that already uses the Arc<RwLock> pattern.

Source

pub fn into_inner(self) -> Arc<RwLock<Database>>

Get the inner Arc<RwLock<Database>>.

This is useful when you need to pass the database to code that expects the raw Arc<RwLock<Database>> type.

Source

pub fn as_arc(&self) -> &Arc<RwLock<Database>>

Get a reference to the inner Arc<RwLock<Database>>.

Source

pub async fn read(&self) -> RwLockReadGuard<'_, Database>

Acquire a read lock for concurrent read access.

Multiple readers can hold read locks simultaneously. Use this for SELECT queries or any read-only operations.

Source

pub async fn write(&self) -> RwLockWriteGuard<'_, Database>

Acquire a write lock for exclusive write access.

Only one writer can hold the write lock at a time, and no readers can acquire read locks while a write lock is held.

Source

pub async fn query(&self, sql: &str) -> Result<SelectResult, ReadOnlyError>

Execute a read-only SQL query with automatic read lock management.

This is a convenience method that:

  1. Acquires a read lock on the database
  2. Parses and executes the SQL query
  3. Returns the result, releasing the lock

Only SELECT statements are allowed. Other statement types return ReadOnlyError::NotReadOnly.

§Example
let db = SharedDatabase::new(Database::new());
// ... setup tables and data ...

// Execute concurrent queries from multiple tasks
let result = db.query("SELECT * FROM users WHERE active = true").await?;

Trait Implementations§

Source§

impl Clone for SharedDatabase

Source§

fn clone(&self) -> SharedDatabase

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SharedDatabase

Source§

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

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

impl Default for SharedDatabase

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

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