[−][src]Struct seshat::RecoveryDatabase
Database that can be used to reindex the events.
Reindexing the database may be needed if the index schema changes. This may happen occasionally on upgrades or if language settings for the database change.
Implementations
impl RecoveryDatabase
[src]
pub fn new<P: AsRef<Path>>(path: P) -> Result<Self> where
PathBuf: From<P>,
[src]
PathBuf: From<P>,
Open a read-only Seshat database.
Arguments
path
- The directory where the database will be stored in. This should be an empty directory if a new database should be created.
pub fn new_with_config<P: AsRef<Path>>(path: P, config: &Config) -> Result<Self> where
PathBuf: From<P>,
[src]
PathBuf: From<P>,
Open a recovery Seshat database with the provided config.
Arguments
-
path
- The directory where the database will be stored in. This should be an empty directory if a new database should be created. -
config
- Configuration that changes the behaviour of the database.
pub fn delete_the_index(&mut self) -> Result<()>
[src]
Delete the Seshat index, leaving only the events database.
After this operation is done, the index can be rebuilt.
pub fn load_events_deserialized(
&self,
limit: usize,
from_event: Option<&Event>
) -> Result<Vec<Event>>
[src]
&self,
limit: usize,
from_event: Option<&Event>
) -> Result<Vec<Event>>
Load deserialized events from the database.
limit
- The number of events to load.from_event
- The event where to continue loading from.
Events that fail to be deserialized will be filtered out.
pub fn load_events(
&self,
limit: usize,
from_event: Option<&Event>
) -> Result<Vec<String>>
[src]
&self,
limit: usize,
from_event: Option<&Event>
) -> Result<Vec<String>>
Load serialized events from the database.
limit
- The number of events to load.from_event
- The event where to continue loading from.
pub fn open_index(&mut self) -> Result<()>
[src]
Create and open a new index.
Returns ReindexError
if the index wasn't deleted first.
pub fn info(&self) -> &RecoveryInfo
[src]
Get the recovery info for the database.
pub fn get_connection(&self) -> Result<Connection>
[src]
Get a database connection.
Note that this connection should only be used for reading.
pub fn index_events(&mut self, events: &[Event]) -> Result<()>
[src]
Re-index a batch of events.
Arguments
events
- The events that should be reindexed.
Returns ReindexError
if the index wasn't previously deleted and
opened.
pub fn commit(&mut self) -> Result<bool>
[src]
Commit to the index.
Returns true if the commit was forwarded, false if not enough events are queued up.
Returns ReindexError
if the index wasn't previously deleted and
opened.
pub fn commit_and_close(self) -> Result<()>
[src]
Commit the remaining added events and mark the reindex as done.
Returns ReindexError
if the index wasn't previously deleted and
opened.
pub fn shutdown(self) -> Result<()>
[src]
Shut the database down.
This will terminate the writer thread making sure that no writes will happen after this operation.
Auto Trait Implementations
impl !RefUnwindSafe for RecoveryDatabase
impl Send for RecoveryDatabase
impl !Sync for RecoveryDatabase
impl Unpin for RecoveryDatabase
impl !UnwindSafe for RecoveryDatabase
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Downcast for T where
T: Any,
T: Any,
fn into_any(self: Box<T>) -> Box<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> Erased for T
impl<T> From<T> for T
[src]
impl<T> Fruit for T where
T: Send + Downcast,
[src]
T: Send + Downcast,
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,