com.redislabs.redisgraph

Interface RedisGraphPipeline

All Superinterfaces:

AutoCloseable, redis.clients.jedis.commands.BasicRedisPipeline, redis.clients.jedis.commands.BinaryRedisPipeline, redis.clients.jedis.commands.BinaryScriptingCommandsPipeline, Closeable, redis.clients.jedis.commands.ClusterPipeline, redis.clients.jedis.commands.MultiKeyBinaryRedisPipeline, redis.clients.jedis.commands.MultiKeyCommandsPipeline, redis.clients.jedis.commands.RedisPipeline, redis.clients.jedis.commands.ScriptingCommandsPipeline

All Known Implementing Classes:

RedisGraphPipeline

public interface RedisGraphPipeline
extends redis.clients.jedis.commands.MultiKeyBinaryRedisPipeline, redis.clients.jedis.commands.MultiKeyCommandsPipeline, redis.clients.jedis.commands.ClusterPipeline, redis.clients.jedis.commands.BinaryScriptingCommandsPipeline, redis.clients.jedis.commands.ScriptingCommandsPipeline, redis.clients.jedis.commands.BasicRedisPipeline, redis.clients.jedis.commands.BinaryRedisPipeline, redis.clients.jedis.commands.RedisPipeline, Closeable

An interface which aligned to Jedis Pipeline interface

Method Summary

Modifier and Type	Method and Description
redis.clients.jedis.Response<ResultSet>	callProcedure(String graphId, String procedure) Invokes stored procedures without arguments
redis.clients.jedis.Response<ResultSet>	callProcedure(String graphId, String procedure, List<String> args) Invokes stored procedure with arguments
redis.clients.jedis.Response<ResultSet>	callProcedure(String graphId, String procedure, List<String> args, Map<String,List<String>> kwargs) Invoke a stored procedure
redis.clients.jedis.Response<String>	deleteGraph(String graphId) Deletes the entire graph
redis.clients.jedis.Response<ResultSet>	query(String graphId, String query) Execute a Cypher query.
redis.clients.jedis.Response<ResultSet>	query(String graphId, String query, long timeout) Execute a Cypher query with timeout.
redis.clients.jedis.Response<ResultSet>	query(String graphId, String query, Map<String,Object> params) Executes a cypher query with parameters.
redis.clients.jedis.Response<ResultSet>	query(String graphId, String query, Map<String,Object> params, long timeout) Executes a cypher query with parameters and timeout.
redis.clients.jedis.Response<ResultSet>	query(String graphId, String query, Object... args) Deprecated. use query(String, String, Map) instead.
redis.clients.jedis.Response<ResultSet>	readOnlyQuery(String graphId, String query) Execute a Cypher read-only query.
redis.clients.jedis.Response<ResultSet>	readOnlyQuery(String graphId, String query, long timeout) Execute a Cypher read-only query with timeout.
redis.clients.jedis.Response<ResultSet>	readOnlyQuery(String graphId, String query, Map<String,Object> params) Executes a cypher read-only query with parameters.
redis.clients.jedis.Response<ResultSet>	readOnlyQuery(String graphId, String query, Map<String,Object> params, long timeout) Executes a cypher read-only query with parameters and timeout.
void	sync() Synchronize pipeline by reading all responses.
List<Object>	syncAndReturnAll() Synchronize pipeline by reading all responses.

Methods inherited from interface redis.clients.jedis.commands.MultiKeyBinaryRedisPipeline

bitop, blmove, blpop, blpop, brpop, brpop, brpoplpush, bzpopmax, bzpopmin, copy, copy, del, exists, georadiusByMemberStore, georadiusStore, keys, lmove, mget, migrate, mset, msetnx, pfcount, pfmerge, publish, randomKeyBinary, rename, renamenx, rpoplpush, sdiff, sdiffstore, sinter, sinterstore, smove, sort, sort, sunion, sunionstore, touch, unlink, unwatch, watch, xread, xread, xreadGroup, xreadGroup, zdiff, zdiffStore, zdiffWithScores, zinter, zinterstore, zinterstore, zinterWithScores, zunion, zunionstore, zunionstore, zunionWithScores

Methods inherited from interface redis.clients.jedis.commands.MultiKeyCommandsPipeline

bitop, blmove, blpop, blpop, blpop, brpop, brpop, brpop, brpoplpush, bzpopmax, bzpopmin, copy, copy, del, exists, georadiusByMemberStore, georadiusStore, keys, lmove, mget, migrate, mset, msetnx, pfcount, pfmerge, publish, randomKey, rename, renamenx, rpoplpush, sdiff, sdiffstore, sinter, sinterstore, smove, sort, sort, sunion, sunionstore, touch, unlink, unwatch, watch, xread, xread, xreadGroup, xreadGroup, zdiff, zdiffStore, zdiffWithScores, zinter, zinterstore, zinterstore, zinterWithScores, zunion, zunionstore, zunionstore, zunionWithScores

Methods inherited from interface redis.clients.jedis.commands.ClusterPipeline

clusterAddSlots, clusterDelSlots, clusterGetKeysInSlot, clusterInfo, clusterMeet, clusterNodes, clusterSetSlotImporting, clusterSetSlotMigrating, clusterSetSlotNode

Methods inherited from interface redis.clients.jedis.commands.BinaryScriptingCommandsPipeline

eval, eval, eval, eval, evalsha, evalsha, evalsha

Methods inherited from interface redis.clients.jedis.commands.ScriptingCommandsPipeline

eval, eval, eval, evalsha, evalsha, evalsha

Methods inherited from interface redis.clients.jedis.commands.BasicRedisPipeline

bgrewriteaof, bgsave, configGet, configResetStat, configSet, dbSize, flushAll, flushAll, flushDB, flushDB, info, lastsave, migrate, moduleList, moduleLoad, moduleUnload, ping, save, select, shutdown, swapDB, time

Methods inherited from interface redis.clients.jedis.commands.BinaryRedisPipeline

append, bitcount, bitcount, bitfield, bitfieldReadonly, bitpos, bitpos, blpop, brpop, decr, decrBy, del, dump, echo, exists, expire, expire, expireAt, geoadd, geoadd, geoadd, geodist, geodist, geohash, geopos, georadius, georadius, georadiusByMember, georadiusByMember, georadiusByMemberReadonly, georadiusByMemberReadonly, georadiusReadonly, georadiusReadonly, get, getbit, getDel, getEx, getrange, getSet, hdel, hexists, hget, hgetAll, hincrBy, hincrByFloat, hkeys, hlen, hmget, hmset, hrandfield, hrandfield, hrandfieldWithValues, hset, hset, hsetnx, hstrlen, hvals, incr, incrBy, incrByFloat, lindex, linsert, llen, lpop, lpop, lpos, lpos, lpos, lpush, lpushx, lrange, lrem, lset, ltrim, migrate, move, objectEncoding, objectFreq, objectIdletime, objectRefcount, persist, pexpire, pexpireAt, pfadd, pfcount, psetex, pttl, restore, restore, restore, restoreReplace, restoreReplace, rpop, rpop, rpush, rpushx, sadd, scard, set, set, setbit, setex, setex, setnx, setrange, setrange, sismember, smembers, smismember, sort, sort, spop, spop, srandmember, srandmember, srem, strlen, substr, touch, ttl, type, unlink, xack, xadd, xadd, xadd, xclaim, xclaim, xclaimJustId, xdel, xgroupCreate, xgroupDelConsumer, xgroupDestroy, xgroupSetID, xlen, xpending, xpending, xpending, xpendingBinary, xrange, xrange, xrevrange, xrevrange, xtrim, xtrim, zadd, zadd, zadd, zadd, zaddIncr, zcard, zcount, zcount, zincrby, zincrby, zlexcount, zmscore, zpopmax, zpopmax, zpopmin, zpopmin, zrandmember, zrandmember, zrandmemberWithScores, zrange, zrangeByLex, zrangeByLex, zrangeByScore, zrangeByScore, zrangeByScore, zrangeByScore, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeWithScores, zrank, zrem, zremrangeByLex, zremrangeByRank, zremrangeByScore, zremrangeByScore, zrevrange, zrevrangeByLex, zrevrangeByLex, zrevrangeByScore, zrevrangeByScore, zrevrangeByScore, zrevrangeByScore, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeWithScores, zrevrank, zscore

Methods inherited from interface redis.clients.jedis.commands.RedisPipeline

append, bitcount, bitcount, bitfield, bitfieldReadonly, bitpos, bitpos, blpop, brpop, decr, decrBy, del, dump, echo, exists, expire, expire, expireAt, geoadd, geoadd, geoadd, geodist, geodist, geohash, geopos, georadius, georadius, georadiusByMember, georadiusByMember, georadiusByMemberReadonly, georadiusByMemberReadonly, georadiusReadonly, georadiusReadonly, get, getbit, getDel, getEx, getrange, getSet, hdel, hexists, hget, hgetAll, hincrBy, hincrByFloat, hkeys, hlen, hmget, hmset, hrandfield, hrandfield, hrandfieldWithValues, hset, hset, hsetnx, hstrlen, hvals, incr, incrBy, incrByFloat, lindex, linsert, llen, lpop, lpop, lpos, lpos, lpos, lpush, lpushx, lrange, lrem, lset, ltrim, migrate, move, objectEncoding, objectFreq, objectIdletime, objectRefcount, persist, pexpire, pexpireAt, pfadd, pfcount, psetex, pttl, restore, restore, restore, restoreReplace, restoreReplace, rpop, rpop, rpush, rpushx, sadd, scard, set, set, setbit, setex, setex, setnx, setrange, sismember, smembers, smismember, sort, sort, spop, spop, srandmember, srandmember, srem, strlen, substr, touch, ttl, type, unlink, xack, xadd, xadd, xadd, xclaim, xclaim, xclaimJustId, xdel, xgroupCreate, xgroupDelConsumer, xgroupDestroy, xgroupSetID, xlen, xpending, xpending, xpending, xrange, xrange, xrevrange, xrevrange, xtrim, xtrim, zadd, zadd, zadd, zadd, zaddIncr, zcard, zcount, zcount, zincrby, zincrby, zlexcount, zmscore, zpopmax, zpopmax, zpopmin, zpopmin, zrandmember, zrandmember, zrandmemberWithScores, zrange, zrangeByLex, zrangeByLex, zrangeByScore, zrangeByScore, zrangeByScore, zrangeByScore, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeByScoreWithScores, zrangeWithScores, zrank, zrem, zremrangeByLex, zremrangeByRank, zremrangeByScore, zremrangeByScore, zrevrange, zrevrangeByLex, zrevrangeByLex, zrevrangeByScore, zrevrangeByScore, zrevrangeByScore, zrevrangeByScore, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeByScoreWithScores, zrevrangeWithScores, zrevrank, zscore

Methods inherited from interface java.io.Closeable

close

Method Detail

query

redis.clients.jedis.Response<ResultSet> query(String graphId,
                                              String query)

Execute a Cypher query.

Parameters:

graphId - a graph to perform the query on

query - Cypher query

Returns:

a response which builds the result set with the query answer.

readOnlyQuery

redis.clients.jedis.Response<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 response which builds the result set with the query answer.

query

redis.clients.jedis.Response<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 response which builds the result set with the query answer.

readOnlyQuery

redis.clients.jedis.Response<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 response which builds the result set with the query answer.

query

@Deprecated
redis.clients.jedis.Response<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 response which builds the result set with the query answer.

query

redis.clients.jedis.Response<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 response which builds the result set with the query answer.

readOnlyQuery

redis.clients.jedis.Response<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 response which builds the result set with the query answer.

query

redis.clients.jedis.Response<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 response which builds the result set with the query answer.

readOnlyQuery

redis.clients.jedis.Response<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 response which builds the result set with the query answer.

callProcedure

redis.clients.jedis.Response<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:

a response which builds result set with the procedure data

callProcedure

redis.clients.jedis.Response<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:

a response which builds result set with the procedure data

callProcedure

redis.clients.jedis.Response<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:

a response which builds result set with the procedure data

deleteGraph

redis.clients.jedis.Response<String> deleteGraph(String graphId)

Deletes the entire graph

Parameters:

graphId - graph to delete

Returns:

a response which builds the delete running time statistics

syncAndReturnAll

List<Object> syncAndReturnAll()

Synchronize pipeline by reading all responses. This operation close the pipeline. Whenever possible try to avoid using this version and use Pipeline.sync() as it won't go through all the responses and generate the right response type (usually it is a waste of time).

Returns:

A list of all the responses in the order you executed them.

sync

void sync()

Synchronize pipeline by reading all responses. This operation close the pipeline. In order to get return values from pipelined commands, capture the different Response<?> of the commands you execute.