Interface RedisScanCommands

All Known Implementing Classes:
RedisConnection

public interface RedisScanCommands
Command interface for key/value iteration in Redis.
Author:
Matthew Tropiano
  • Method Details

    • scan

      RedisCursor scan(long cursor)

      From http://redis.io/commands/scan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Incrementally iterates over a collection of elements.

      Parameters:
      cursor - the cursor value.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • scan

      RedisCursor scan(long cursor, String pattern)

      From http://redis.io/commands/scan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Incrementally iterates over a collection of elements.

      Parameters:
      cursor - the cursor value.
      pattern - if not null, return keys that fit a pattern.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • scan

      RedisCursor scan(long cursor, long count)

      From http://redis.io/commands/scan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Incrementally iterates over a collection of elements.

      Parameters:
      cursor - the cursor value.
      count - if not null, cap the iterable keys at a limit.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • scan

      RedisCursor scan(long cursor, String pattern, Long count)

      From http://redis.io/commands/scan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Incrementally iterates over a collection of elements.

      Parameters:
      cursor - the cursor value.
      pattern - if not null, return keys that fit a pattern.
      count - if not null, cap the iterable keys at a limit.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • hscan

      RedisCursor hscan(String key, long cursor)

      From http://redis.io/commands/sscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the hash to scan.
      cursor - the cursor value.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • hscan

      RedisCursor hscan(String key, long cursor, String pattern)

      From http://redis.io/commands/sscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the hash to scan.
      cursor - the cursor value.
      pattern - if not null, return keys that fit a pattern.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • hscan

      RedisCursor hscan(String key, long cursor, long count)

      From http://redis.io/commands/sscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the hash to scan.
      cursor - the cursor value.
      count - if not null, cap the iterable keys at a limit.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • hscan

      RedisCursor hscan(String key, long cursor, String pattern, Long count)

      From http://redis.io/commands/hscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the hash to scan.
      cursor - the cursor value.
      pattern - if not null, return keys that fit a pattern.
      count - if not null, cap the iterable keys at a limit.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • sscan

      RedisCursor sscan(String key, long cursor)

      From http://redis.io/commands/hscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the set to scan.
      cursor - the cursor value.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • sscan

      RedisCursor sscan(String key, long cursor, String pattern)

      From http://redis.io/commands/hscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the set to scan.
      cursor - the cursor value.
      pattern - if not null, return keys that fit a pattern.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • sscan

      RedisCursor sscan(String key, long cursor, long count)

      From http://redis.io/commands/hscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the set to scan.
      cursor - the cursor value.
      count - if not null, cap the iterable keys at a limit.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • sscan

      RedisCursor sscan(String key, String cursor, String pattern, Long count)

      From http://redis.io/commands/sscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the set to scan.
      cursor - the cursor value.
      pattern - if not null, return keys that fit a pattern.
      count - if not null, cap the iterable keys at a limit.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • zscan

      RedisCursor zscan(String key, long cursor)

      From http://redis.io/commands/zscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the sorted set to scan.
      cursor - the cursor value.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • zscan

      RedisCursor zscan(String key, long cursor, String pattern)

      From http://redis.io/commands/zscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the sorted set to scan.
      cursor - the cursor value.
      pattern - if not null, return keys that fit a pattern.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • zscan

      RedisCursor zscan(String key, long cursor, long count)

      From http://redis.io/commands/zscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the sorted set to scan.
      cursor - the cursor value.
      count - if not null, cap the iterable keys at a limit.
      Returns:
      a RedisCursor that represents the result of a SCAN call.
    • zscan

      RedisCursor zscan(String key, long cursor, String pattern, Long count)

      From http://redis.io/commands/zscan:

      Available since 2.8.0.

      Time complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..

      Parameters:
      key - the key of the sorted set to scan.
      cursor - the cursor value.
      pattern - if not null, return keys that fit a pattern.
      count - if not null, cap the iterable keys at a limit.
      Returns:
      a RedisCursor that represents the result of a SCAN call.