Struct tocco_s3::state::Db

pub struct Db { /* private fields */ }

SQLite DB state database

Obtain via crate::fs::Archive::state_db().

Implementations

impl Db

pub fn insert_last_seen_times<I, H>(&mut self, hashes: I) -> Result<()>

where I: IntoIterator<Item = H>, H: Borrow<Hash>,

Insert last seen timestamp for given objects.

Unlike Self::update_last_seen_times(), times are only inserted for objects not in the state DB yet. Objects already in the DB are ignored.

pub fn update_last_seen_times<I, H>(&mut self, hashes: I) -> Result<()>

where I: IntoIterator<Item = H>, H: Borrow<Hash>,

Update last seen timestamp for given objects.

If an object is missing in state DB, it is inserted.

pub fn set_last_seen_time( &mut self, hash: &Hash, ts: DateTime<Local>, ) -> Result<()>

Set last seen time

This is mostly useful for testing. Consider using Self::update_last_seen_times() instead.

pub fn last_seen_time(&mut self, hash: &Hash) -> Result<Option<DateTime<Local>>>

Get last seen time

pub fn next_objects_older_than<'pager>( &mut self, pager: &'pager mut ObjectsOlderThanPager, ) -> Result<Option<&'pager [Hash]>>

Obtain all objects older than duration

Create an ObjectsOlderThanPager first and then pass it to this function.

Returns the next page (Some(&[Hash])) or None if there is no more matching objects.

use chrono::Duration;
use tocco_s3::state::ObjectsOlderThanPager;
use tocco_s3::Archive;

let archive_path = tempfile::tempdir().unwrap();
let archive_path = archive_path.path().join("archive");
let archive = Archive::init(&archive_path).unwrap();
let mut state_db = archive.state_db().unwrap();
let objects_returned_per_page = 1024;
let older_than = Duration::days(90);
let mut pager = ObjectsOlderThanPager::new(older_than, objects_returned_per_page);
assert!(state_db
    .next_objects_older_than(&mut pager)
    .unwrap()
    .is_none());

pub fn delete_objects<I, H>(&mut self, hashes: I) -> Result<()>

where I: IntoIterator<Item = H>, H: Borrow<Hash>,

Delete object matching given hashes.

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

Update time when DB was last scanned for live objects.

This time indicates when last a list of all objects was fetched from the DB server and the last_seen times updated.

pub fn last_db_scan_time(&self) -> Result<DateTime<Local>>

Get time when DB was last scanned for live objects.

See Self::update_last_db_scan_time

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

Update time when archive was last scanned for live objects.

This time indicates when last a list of all objects in the archive (on disk) was fetched and records created for objects that were missing in the DB.

pub fn last_archive_scan_time(&self) -> Result<DateTime<Local>>

Get time when archive was last scanned for live objects.

See Self::update_last_db_scan_time

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

Update time when S3 objects were last backed up to the archive.

This is the last time a backup was created successfully.

pub fn last_s3_backup_time(&self) -> Result<DateTime<Local>>

Get time when S3 objects were last backed up to the archive.

See [Self::update_last_s3_time]

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

Vacuum database

https://www.sqlite.org/lang_vacuum.html

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

Optimize database

Executed automatically when DB is Dropped as recommended by upstream.

https://www.sqlite.org/pragma.html#pragma_optimize

Trait Implementations

impl Drop for Db

fn drop(&mut self)

Executes the destructor for this type.