Struct redisgraph::graph::Graph

pub struct Graph<'c, 'n> { /* fields omitted */ }

Represents a single graph in the database.

Methods

impl<'c, 'n> Graph<'c, 'n>

pub fn open(conn: &'c mut Connection, name: &'n str) -> RedisGraphResult<Self>

Opens the graph with the given name from the database.

If the graph does not already exist, creates a new graph with the given name.

pub fn query<T: FromTable>(&mut self, query: &str) -> RedisGraphResult<T>

Executes the given query and returns its return values.

Only use this for queries with a RETURN statement.

pub fn query_with_statistics<T: FromTable>(
    &mut self,
    query: &str
) -> RedisGraphResult<(T, Statistics)>

Same as query, but also returns statistics about the query along with its return values.

pub fn mutate(&mut self, query: &str) -> RedisGraphResult<()>

Executes the given query while not returning any values.

If you want to mutate the graph and retrieve values from it using one query, use query instead.

pub fn mutate_with_statistics(
    &mut self,
    query: &str
) -> RedisGraphResult<Statistics>

Same as mutate, but returns statistics about the query.

pub fn delete(self) -> RedisGraphResult<()>

Deletes the entire graph from the database.

This action is not easily reversible.

pub fn update_labels(&mut self) -> RedisGraphResult<()>

Updates the internal label names by retrieving them from the database.

There is no real need to call this function manually. This implementation updates the label names automatically when they become outdated.

pub fn update_relationship_types(&mut self) -> RedisGraphResult<()>

Updates the internal relationship type names by retrieving them from the database.

There is no real need to call this function manually. This implementation updates the relationship type names automatically when they become outdated.

pub fn update_property_keys(&mut self) -> RedisGraphResult<()>

Updates the internal property key names by retrieving them from the database.

There is no real need to call this function manually. This implementation updates the property key names automatically when they become outdated.

pub fn name(&self) -> &str

Returns the name of this graph.

pub fn labels(&self) -> &[RedisString]

Returns the graph's internal label names.

pub fn relationship_types(&self) -> &[RedisString]

Returns the graph's internal relationship type names.

pub fn property_keys(&self) -> &[RedisString]

Returns the graph's internal property key names.