Skip to main content

GraphmindClient

graphmind_sdk::client

Trait GraphmindClient 

Source 
pub trait GraphmindClient: Send + Sync {
    // Required methods
    fn query<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        graph: &'life1 str,
        cypher: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn query_with_params<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        graph: &'life1 str,
        cypher: &'life2 str,
        params: HashMap<String, Value>,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn query_readonly<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        graph: &'life1 str,
        cypher: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn delete_graph<'life0, 'life1, 'async_trait>(
        &'life0 self,
        graph: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn list_graphs<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<Vec<String>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn status<'life0, 'life1, 'async_trait>(
        &'life0 self,
        graph: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<ServerStatus>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn ping<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<String>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn schema<'life0, 'life1, 'async_trait>(
        &'life0 self,
        graph: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<String>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn explain<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        graph: &'life1 str,
        cypher: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn profile<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        graph: &'life1 str,
        cypher: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
}
Expand description

Unified client interface for the Graphmind graph database.

Implemented by:

  • EmbeddedClient — in-process, no network (for examples, tests, embedded use)
  • RemoteClient — connects to a running Graphmind server via HTTP

Required Methods§

Source

fn query<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, graph: &'life1 str, cypher: &'life2 str, ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute a read-write Cypher query

Source

fn query_with_params<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, graph: &'life1 str, cypher: &'life2 str, params: HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute a read-write Cypher query with parameters

Source

fn query_readonly<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, graph: &'life1 str, cypher: &'life2 str, ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute a read-only Cypher query

Source

fn delete_graph<'life0, 'life1, 'async_trait>( &'life0 self, graph: &'life1 str, ) -> Pin<Box<dyn Future<Output = GraphmindResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a graph

Source

fn list_graphs<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = GraphmindResult<Vec<String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List all graphs

Source

fn status<'life0, 'life1, 'async_trait>( &'life0 self, graph: &'life1 str, ) -> Pin<Box<dyn Future<Output = GraphmindResult<ServerStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get server status for a specific graph

Source

fn ping<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = GraphmindResult<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Ping the server

Source

fn schema<'life0, 'life1, 'async_trait>( &'life0 self, graph: &'life1 str, ) -> Pin<Box<dyn Future<Output = GraphmindResult<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return a schema summary (node types, edge types, counts)

Source

fn explain<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, graph: &'life1 str, cypher: &'life2 str, ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Return the EXPLAIN plan for a Cypher query without executing it

Source

fn profile<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, graph: &'life1 str, cypher: &'life2 str, ) -> Pin<Box<dyn Future<Output = GraphmindResult<QueryResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute a Cypher query with PROFILE instrumentation

Implementors§