Package com.redislabs.redisgraph

Interface RedisGraph

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

RedisGraphContext, RedisGraphContextGenerator

All Known Implementing Classes:

AbstractRedisGraph, ContextedRedisGraph, RedisGraph

public interface RedisGraph
extends Closeable

Method Summary

Modifier and Type	Method	Description
ResultSet	callProcedure(String graphId, String procedure)	Invokes stored procedures without arguments
ResultSet	callProcedure(String graphId, String procedure, List<String> args)	Invokes stored procedure with arguments
ResultSet	callProcedure(String graphId, String procedure, List<String> args, Map<String,List<String>> kwargs)	Invoke a stored procedure
void	close()
String	deleteGraph(String graphId)	Deletes the entire graph
ResultSet	query(String graphId, String query)	Execute a Cypher query.
ResultSet	query(String graphId, String query, long timeout)	Execute a Cypher query with timeout.
ResultSet	query(String graphId, String query, Object... args)	Deprecated. use query(String, String, Map) instead.
ResultSet	query(String graphId, String query, Map<String,Object> params)	Executes a cypher query with parameters.
ResultSet	query(String graphId, String query, Map<String,Object> params, long timeout)	Executes a cypher query with parameters and timeout.
ResultSet	readOnlyQuery(String graphId, String query)	Execute a Cypher read-only query.
ResultSet	readOnlyQuery(String graphId, String query, long timeout)	Execute a Cypher read-only query with timeout.
ResultSet	readOnlyQuery(String graphId, String query, Map<String,Object> params)	Executes a cypher read-only query with parameters.
ResultSet	readOnlyQuery(String graphId, String query, Map<String,Object> params, long timeout)	Executes a cypher read-only query with parameters and timeout.

Method Detail

query

ResultSet query(String graphId,
                String query)

Execute a Cypher query.

Parameters:

graphId - a graph to perform the query on

query - Cypher query

Returns:

a result set

readOnlyQuery

ResultSet readOnlyQuery(String graphId,
                        String query)

Execute a Cypher read-only query.

Parameters:

graphId - a graph to perform the query on

query - Cypher query

Returns:

a result set

query

ResultSet query(String graphId,
                String query,
                long timeout)

Execute a Cypher query with timeout.

Parameters:

graphId - a graph to perform the query on

query - Cypher query

timeout -

Returns:

a result set

readOnlyQuery

ResultSet readOnlyQuery(String graphId,
                        String query,
                        long timeout)

Execute a Cypher read-only query with timeout.

Parameters:

graphId - a graph to perform the query on

query - Cypher query

timeout -

Returns:

a result set

query

@Deprecated
ResultSet query(String graphId,
                String query,
                Object... args)

Deprecated.

use query(String, String, Map) instead.

Execute a Cypher query with arguments

Parameters:

graphId - a graph to perform the query on

query - Cypher query

args -

Returns:

a result set

query

ResultSet query(String graphId,
                String query,
                Map<String,Object> params)

Executes a cypher query with parameters.

Parameters:

graphId - a graph to perform the query on.

query - Cypher query.

params - parameters map.

Returns:

a result set.

readOnlyQuery

ResultSet readOnlyQuery(String graphId,
                        String query,
                        Map<String,Object> params)

Executes a cypher read-only query with parameters.

Parameters:

graphId - a graph to perform the query on.

query - Cypher query.

params - parameters map.

Returns:

a result set.

query

ResultSet query(String graphId,
                String query,
                Map<String,Object> params,
                long timeout)

Executes a cypher query with parameters and timeout.

Parameters:

graphId - a graph to perform the query on.

query - Cypher query.

params - parameters map.

timeout -

Returns:

a result set.

readOnlyQuery

ResultSet readOnlyQuery(String graphId,
                        String query,
                        Map<String,Object> params,
                        long timeout)

Executes a cypher read-only query with parameters and timeout.

Parameters:

graphId - a graph to perform the query on.

query - Cypher query.

params - parameters map.

timeout -

Returns:

a result set.

callProcedure

ResultSet callProcedure(String graphId,
                        String procedure)

Invokes stored procedures without arguments

Parameters:

graphId - a graph to perform the query on

procedure - procedure name to invoke

Returns:

result set with the procedure data

callProcedure

ResultSet callProcedure(String graphId,
                        String procedure,
                        List<String> args)

Invokes stored procedure with arguments

Parameters:

graphId - a graph to perform the query on

procedure - procedure name to invoke

args - procedure arguments

Returns:

result set with the procedure data

callProcedure

ResultSet callProcedure(String graphId,
                        String procedure,
                        List<String> args,
                        Map<String,List<String>> kwargs)

Invoke a stored procedure

Parameters:

graphId - a graph to perform the query on

procedure - - procedure to execute

args - - procedure arguments

kwargs - - procedure output arguments

Returns:

result set with the procedure data

deleteGraph

String deleteGraph(String graphId)

Deletes the entire graph

Parameters:

graphId - graph to delete

Returns:

delete running time statistics

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable