Struct indradb::MemoryDatastore

pub struct MemoryDatastore { /* private fields */ }

An in-memory datastore.

Implementations

impl MemoryDatastore

pub fn read<P: Into<PathBuf>>(
    path: P
) -> StdResult<MemoryDatastore, BincodeError>

👎Deprecated: use read_msgpack, as it supports properties

Reads a persisted image from disk. Calls to sync will overwrite the file at the specified path. For historic reasons, this uses bincode, however bincode cannot serialize properties. If your graph needs persistent properties, use read_msgpack.

Arguments

• path: The path to the persisted image.

pub fn read_msgpack<P: Into<PathBuf>>(
    path: P
) -> StdResult<MemoryDatastore, RmpDecodeError>

Reads a persisted image from disk. Calls to sync will overwrite the file at the specified path. Uses msgpack, which unlike bincode supports properties.

Arguments

• path: The path to the persisted image.

pub fn create<P: Into<PathBuf>>(
    path: P
) -> StdResult<MemoryDatastore, BincodeError>

👎Deprecated: use create_msgpack, as it supports properties

Creates a new datastore. Calls to sync will overwrite the file at the specified path, but as opposed to read, this will not read the file first. For historic reasons, this uses bincode, however bincode cannot serialize properties. If your graph needs persistent properties, use create_msgpack.

Arguments

• path: The path to the persisted image.

pub fn create_msgpack<P: Into<PathBuf>>(
    path: P
) -> StdResult<MemoryDatastore, BincodeError>

Creates a new datastore. Calls to sync will overwrite the file at the specified path, but as opposed to read, this will not read the file first. Uses msgpack, which unlike bincode supports properties.

Arguments

• path: The path to the persisted image.

Trait Implementations

impl Clone for MemoryDatastore

fn clone(&self) -> MemoryDatastore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Datastore for MemoryDatastore

fn sync(&self) -> Result<()>

Syncs persisted content. Depending on the datastore implementation, this has different meanings - including potentially being a no-op.

fn create_vertex(&self, vertex: &Vertex) -> Result<bool>

Creates a new vertex. Returns whether the vertex was successfully created - if this is false, it’s because a vertex with the same UUID already exists.

fn get_vertices(&self, q: VertexQuery) -> Result<Vec<Vertex>>

Gets a range of vertices specified by a query.

fn delete_vertices(&self, q: VertexQuery) -> Result<()>

Deletes existing vertices specified by a query.

fn get_vertex_count(&self) -> Result<u64>

Gets the number of vertices in the datastore.

fn create_edge(&self, key: &EdgeKey) -> Result<bool>

Creates a new edge. If the edge already exists, this will update it with a new update datetime. Returns whether the edge was successfully created - if this is false, it’s because one of the specified vertices is missing.

fn get_edges(&self, q: EdgeQuery) -> Result<Vec<Edge>>

Gets a range of edges specified by a query.

fn delete_edges(&self, q: EdgeQuery) -> Result<()>

Deletes a set of edges specified by a query.

fn get_edge_count(
    &self,
    id: Uuid,
    t: Option<&Identifier>,
    direction: EdgeDirection
) -> Result<u64>

Gets the number of edges associated with a vertex.

fn get_vertex_properties(
    &self,
    q: VertexPropertyQuery
) -> Result<Vec<VertexProperty>>

Gets vertex properties.

fn get_all_vertex_properties(
    &self,
    q: VertexQuery
) -> Result<Vec<VertexProperties>>

Gets all vertex properties.

fn set_vertex_properties(
    &self,
    q: VertexPropertyQuery,
    value: Value
) -> Result<()>

Sets a vertex properties.

fn delete_vertex_properties(&self, q: VertexPropertyQuery) -> Result<()>

Deletes vertex properties.

fn get_edge_properties(&self, q: EdgePropertyQuery) -> Result<Vec<EdgeProperty>>

Gets edge properties.

fn get_all_edge_properties(&self, q: EdgeQuery) -> Result<Vec<EdgeProperties>>

Gets all edge properties.

fn set_edge_properties(&self, q: EdgePropertyQuery, value: Value) -> Result<()>

Sets edge properties.

fn delete_edge_properties(&self, q: EdgePropertyQuery) -> Result<()>

Deletes edge properties.

fn index_property(&self, name: Identifier) -> Result<()>

fn transaction(&self) -> Result<Self>where
    Self: Sized,

Creates a new transaction. Some datastore implementations do not support transactional updates, in which case this will return an error.

fn create_vertex_from_type(&self, t: Identifier) -> Result<Uuid>

Creates a new vertex with just a type specification. As opposed to create_vertex, this is used when you do not want to manually specify the vertex’s UUID. Returns the new vertex’s UUID.

fn bulk_insert(&self, items: Vec<BulkInsertItem>) -> Result<()>

Bulk inserts many vertices, edges, and/or properties.

impl Debug for MemoryDatastore

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

Formats the value using the given formatter.

impl Default for MemoryDatastore

fn default() -> MemoryDatastore

Returns the “default value” for a type.