Struct Database 

pub struct Database { /* private fields */ }

An open .ursa database.

Implementations

impl Database

pub fn open(path: impl AsRef<Path>, options: &OpenOptions) -> Result<Self>

Open the database at path, creating it (and its sidecar directory) unless read-only. A writer takes the lock first, waiting up to options.lock_timeout, then reads the catalog.

pub fn name(&self) -> &str

The database as the user named it (club.ursa).

pub fn path(&self) -> &Path

The catalog file, absolute.

pub fn dir(&self) -> &Path

The directory holding the catalog file: stored relative paths are relative to it.

pub fn sidecar_dir(&self) -> &Path

The sidecar directory, club.ursa.d. It exists unless read-only.

pub fn index_dir(&self) -> PathBuf

Where stored graph indexes go (club.ursa.d/indexes), created on the first write.

pub fn index_store(&self) -> Arc<IndexStore>

The database’s stored graph indexes. A read-only database reads them and never writes.

pub fn flush(&self)

Wait for stored-index writes still running.

pub fn is_read_only(&self) -> bool

pub fn statements(&self) -> Vec<String>

The catalog’s statements, in replay order.

pub fn settings(&self) -> BTreeMap<String, String>

The settings the catalog keeps, by full name, as SET takes them.

pub fn index_storage_limit(&self) -> u64

The most bytes of stored indexes this database keeps: its stored ursa.index_storage_limit, or the default. A session’s own SET in a read-only database does not change it.

pub fn save(&self, statements: Vec<String>) -> Result<()>

Replace the catalog’s statements with statements, rewriting the file atomically (temporary file, fsync, rename). Refused when read-only.

pub fn set_setting(&self, name: &str, value: Option<&str>) -> Result<()>

Keep the setting name as value in the catalog (None: remove it, back to the default), rewriting the file. Refused when read-only. value must be valid for the setting.

pub fn stored_location(&self, location: &str, cwd: &Path) -> Option<String>

How the catalog stores location, written in a statement run from cwd: a local path inside the database’s directory becomes relative to it, any other local path becomes absolute. None when the location is stored as written: a URL, a ~/… path, or a path already in its stored form.

pub fn replayed_location(&self, location: &str) -> Option<String>

location from a stored statement as replay runs it: a relative local path resolved against the database’s directory; None for anything else (a URL, an absolute path, ~/…), which runs as stored.

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.

impl Drop for Database

fn drop(&mut self)

Finish writing stored indexes before the lock is released.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.