org.apache.beam.sdk.io.redis

Class RedisIO

java.lang.Object

org.apache.beam.sdk.io.redis.RedisIO

@Experimental(value=SOURCE_SINK)
public class RedisIO
extends java.lang.Object

An IO to manipulate Redis key/value database.

Reading Redis key/value pairs

read() provides a source which returns a bounded PCollection containing key/value pairs as KV<String, String>.

To configure a Redis source, you have to provide Redis server hostname and port number. Optionally, you can provide a key pattern (to filter the keys). The following example illustrates how to configure a source:

 pipeline.apply(RedisIO.read()
   .withEndpoint("::1", 6379)
   .withKeyPattern("foo*"))

 

It's also possible to specify Redis authentication and connection timeout with the corresponding methods:

 pipeline.apply(RedisIO.read()
   .withEndpoint("::1", 6379)
   .withAuth("authPassword")
   .withTimeout(60000)
   .withKeyPattern("foo*"))

 

readKeyPatterns() can be used to request Redis server using input PCollection elements as key pattern (as String).

 pipeline.apply(...)
    // here we have a PCollection<String> with the key patterns
    .apply(RedisIO.readKeyPatterns().withEndpoint("::1", 6379))
   // here we have a PCollection<KV<String,String>>

 

Writing Redis key/value pairs

write() provides a sink to write key/value pairs represented as KV from an incoming PCollection.

To configure the target Redis server, you have to provide Redis server hostname and port number. The following example illustrates how to configure a sink:

 pipeline.apply(...)
   // here we a have a PCollection<String, String> with key/value pairs
   .apply(RedisIO.write().withEndpoint("::1", 6379))

 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedisIO.Read Implementation of read().
static class	RedisIO.ReadAll Deprecated. This class will be removed soon. Please update you code to depend on RedisIO.ReadKeyPatterns instead.
static class	RedisIO.ReadKeyPatterns Implementation of readKeyPatterns().
static class	RedisIO.Write A PTransform to write to a Redis server.

Method Summary

Modifier and Type	Method and Description
static RedisIO.Read	read() Read data from a Redis server.
static RedisIO.ReadAll	readAll() Deprecated. This method is not consistent with the readAll pattern of other transforms and will be remove soon. Please update you code to use readKeyPatterns() instead.
static RedisIO.ReadKeyPatterns	readKeyPatterns() Like read() but executes multiple instances of the Redis query substituting each element of a PCollection as key pattern.
static RedisIO.Write	write() Write data to a Redis server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

read

public static RedisIO.Read read()

Read data from a Redis server.

readAll

@Deprecated
public static RedisIO.ReadAll readAll()

Deprecated. This method is not consistent with the readAll pattern of other transforms and will be remove soon. Please update you code to use readKeyPatterns() instead.

Like read() but executes multiple instances of the Redis query substituting each element of a PCollection as key pattern.

readKeyPatterns

public static RedisIO.ReadKeyPatterns readKeyPatterns()

Like read() but executes multiple instances of the Redis query substituting each element of a PCollection as key pattern.

write

public static RedisIO.Write write()

Write data to a Redis server.