Skip to main content

OnDiskHashIndex

Struct OnDiskHashIndex 

Source
pub struct OnDiskHashIndex<K: IndexKey> { /* private fields */ }
Expand description

On-disk persistent hash index backed by the BufferManager.

§Type Parameters

  • K: The key type. Must implement IndexKey for serialization.

§Thread Safety

This struct is Send + Sync when wrapped in Arc<Mutex<...>>.

Implementations§

Source§

impl<K: IndexKey + Hash + Eq> OnDiskHashIndex<K>

Source

pub fn new(file_name: &str) -> Self

Create a new on-disk hash index.

If bm is None, operates purely in-memory (L1 cache only). The file_name is used to register the index file with the BufferManager.

Source

pub fn rebuild_from_disk(&mut self, bm: &mut BufferManager) -> Result<()>

Rebuild the L1 cache from on-disk pages.

Call this on database startup after the BufferManager is initialized.

Source

pub fn len(&self) -> usize

Get the number of entries.

Source

pub fn is_empty(&self) -> bool

Source

pub fn lookup_cached(&self, key: &K) -> Option<u64>

Look up a key in the L1 cache (fast path).

For write operations during query execution, this is always used.

Source

pub fn lookup(&self, key: &K, bm: &mut BufferManager) -> Result<Option<u64>>

Look up a key, potentially reading from the on-disk index.

If the key is in L1 cache, returns immediately. Otherwise, scans the on-disk bucket page.

Source

pub fn insert(&mut self, key: K, value: u64)

Insert a key-value pair.

Writes to L1 cache immediately. The on-disk write happens on flush().

Source

pub fn delete(&mut self, key: &K)

Delete a key.

Source

pub fn flush(&mut self, bm: &mut BufferManager) -> Result<()>

Flush all cached entries to the on-disk hash index.

This writes all key-value pairs from L1 cache into the BufferManager page-structured hash table. After this, the index is durably stored.

Source

pub fn iter(&self) -> impl Iterator<Item = (&K, &u64)>

Iterate over all cached entries.

Trait Implementations§

Source§

impl<K: Debug + IndexKey> Debug for OnDiskHashIndex<K>

Source§

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

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

impl<K: IndexKey + Hash + Eq> Default for OnDiskHashIndex<K>

Source§

fn default() -> Self

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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