javadoc/2.38.0/org/apache/beam/sdk/io/redis/RedisIO.html - beam-site - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>RedisIO (Apache Beam 2.38.0-SNAPSHOT)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="RedisIO (Apache Beam 2.38.0-SNAPSHOT)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":9,"i1":9,"i2":9,"i3":9};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisConnectionConfiguration.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/redis/RedisIO.html" target="_top">Frames</a></li>
 <li><a href="RedisIO.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.beam.sdk.io.redis</div>
 <h2 title="Class RedisIO" class="title">Class RedisIO</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.beam.sdk.io.redis.RedisIO</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SOURCE_SINK">SOURCE_SINK</a>)
 public class <span class="typeNameLabel">RedisIO</span>
 extends java.lang.Object</pre>
 <div class="block">An IO to manipulate Redis key/value database.

  <h3>Reading Redis key/value pairs</h3>

  <p><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--"><code>read()</code></a> provides a source which returns a bounded <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> containing
  key/value pairs as <code>KV&lt;String, String&gt;</code>.

  <p>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:

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

  </code></pre>

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

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

  </code></pre>

  <p><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#readKeyPatterns--"><code>readKeyPatterns()</code></a> can be used to request Redis server using input PCollection
  elements as key pattern (as String).

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

  </code></pre>

  <h3>Writing Redis key/value pairs</h3>

  <p><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#write--"><code>write()</code></a> provides a sink to write key/value pairs represented as <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> from an
  incoming <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.

  <p>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:

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

  </code></pre>

  <h3>Writing Redis Streams</h3>

  <p><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#writeStreams--"><code>writeStreams()</code></a> appends the entries of a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of key/value pairs
  represented as <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> to the Redis stream at the specified key using the <a
  href='https://redis.io/commands/XADD'>XADD</a> API.

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

  <pre><code>
  pipeline.apply(...)
    // here we have a PCollection&lt;KV&lt;String, Map&lt;String, String&gt;&gt;&gt;
    .apply(RedisIO.writeStreams().withEndpoint("::1", 6379))
  </code></pre>

  <p>Redis Streams optionally can be capped to a specific or exact length (see the documentation
  for the <a href="https://redis.io/commands/xtrim">XTRIM</a> API); <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#writeStreams--"><code>writeStreams()</code></a> lets
  you specify MAXLEN using the <code>withMaxLen()</code> option.

  <p>Trimming a stream to an exact length is noted in the Redis documentation as being inefficient;
  the <code>withApproximateTrim()</code> boolean option will add the <code>~</code> prefix to <code>MAXLEN</code>,
  which tells Redis to use "almost exact" trimming.

  <p>See the <a href="https://redis.io/topics/streams-intro">Redis Streams documentation</a> for a
  deeper discussion of the issues involved.

  <p>The following example illustrates how to configure a sink with trimming:

  <pre><code>
  pipeline.apply(...)
    // here we have a PCollection&lt;KV&lt;String, Map&lt;String, String&gt;&gt;&gt;
    .apply(RedisIO.writeStreams()
      .withEndpoint("::1", 6379)
      .withMaxLen(1024L)
      .withApproximateTrim(true)
     )
  </code></pre></div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="nested.class.summary">
 <!--   -->
 </a>
 <h3>Nested Class Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
 <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Class and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Read</a></span></code>
 <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--"><code>read()</code></a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.ReadKeyPatterns.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.ReadKeyPatterns</a></span></code>
 <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#readKeyPatterns--"><code>readKeyPatterns()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Write</a></span></code>
 <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to write to a Redis server.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.WriteStreams.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.WriteStreams</a></span></code>
 <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to write stream key pairs (https://redis.io/topics/streams-intro) to a
  Redis server.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Read</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--">read</a></span>()</code>
 <div class="block">Read data from a Redis server.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.ReadKeyPatterns.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.ReadKeyPatterns</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#readKeyPatterns--">readKeyPatterns</a></span>()</code>
 <div class="block">Like <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--"><code>read()</code></a> but executes multiple instances of the Redis query substituting each
  element of a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> as key pattern.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Write</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#write--">write</a></span>()</code>
 <div class="block">Write data to a Redis server.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.WriteStreams.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.WriteStreams</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#writeStreams--">writeStreams</a></span>()</code>
 <div class="block">Write stream data to a Redis server.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="read--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>read</h4>
 <pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Read</a>&nbsp;read()</pre>
 <div class="block">Read data from a Redis server.</div>
 </li>
 </ul>
 <a name="readKeyPatterns--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>readKeyPatterns</h4>
 <pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.ReadKeyPatterns.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.ReadKeyPatterns</a>&nbsp;readKeyPatterns()</pre>
 <div class="block">Like <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--"><code>read()</code></a> but executes multiple instances of the Redis query substituting each
  element of a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> as key pattern.</div>
 </li>
 </ul>
 <a name="write--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>write</h4>
 <pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Write</a>&nbsp;write()</pre>
 <div class="block">Write data to a Redis server.</div>
 </li>
 </ul>
 <a name="writeStreams--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>writeStreams</h4>
 <pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.WriteStreams.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.WriteStreams</a>&nbsp;writeStreams()</pre>
 <div class="block">Write stream data to a Redis server.</div>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisConnectionConfiguration.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/redis/RedisIO.html" target="_top">Frames</a></li>
 <li><a href="RedisIO.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>RedisIO (Apache Beam 2.38.0-SNAPSHOT)</title>
	<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
	<script type="text/javascript" src="../../../../../../script.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="RedisIO (Apache Beam 2.38.0-SNAPSHOT)";
	}
	}
	catch(err) {
	}
	//-->
	var methods = {"i0":9,"i1":9,"i2":9,"i3":9};
	var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a name="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a name="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../../../overview-summary.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../../../index-all.html">Index</a></li>
	<li><a href="../../../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisConnectionConfiguration.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/redis/RedisIO.html" target="_top">Frames</a></li>
	<li><a href="RedisIO.html" target="_top">No Frames</a></li>
	</ul>
	<ul class="navList" id="allclasses_navbar_top">
	<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_top");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li><a href="#nested.class.summary">Nested</a> \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a name="skip.navbar.top">
	<!-- -->
	</a></div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	<!-- ======== START OF CLASS DATA ======== -->
	<div class="header">
	<div class="subTitle">org.apache.beam.sdk.io.redis</div>
	<h2 title="Class RedisIO" class="title">Class RedisIO</h2>
	</div>
	<div class="contentContainer">
	<ul class="inheritance">
	<li>java.lang.Object</li>
	<li>
	<ul class="inheritance">
	<li>org.apache.beam.sdk.io.redis.RedisIO</li>
	</ul>
	</li>
	</ul>
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SOURCE_SINK">SOURCE_SINK</a>)
	public class <span class="typeNameLabel">RedisIO</span>
	extends java.lang.Object</pre>
	<div class="block">An IO to manipulate Redis key/value database.

	<h3>Reading Redis key/value pairs</h3>

	<p><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--"><code>read()</code></a> provides a source which returns a bounded <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> containing
	key/value pairs as <code>KV<String, String></code>.

	<p>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:

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

	</code></pre>

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

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

	</code></pre>

	<p><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#readKeyPatterns--"><code>readKeyPatterns()</code></a> can be used to request Redis server using input PCollection
	elements as key pattern (as String).

	<pre><code>
	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>>

	</code></pre>

	<h3>Writing Redis key/value pairs</h3>

	<p><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#write--"><code>write()</code></a> provides a sink to write key/value pairs represented as <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> from an
	incoming <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.

	<p>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:

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

	</code></pre>

	<h3>Writing Redis Streams</h3>

	<p><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#writeStreams--"><code>writeStreams()</code></a> appends the entries of a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of key/value pairs
	represented as <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> to the Redis stream at the specified key using the <a
	href='https://redis.io/commands/XADD'>XADD</a> API.

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

	<pre><code>
	pipeline.apply(...)
	// here we have a PCollection<KV<String, Map<String, String>>>
	.apply(RedisIO.writeStreams().withEndpoint("::1", 6379))
	</code></pre>

	<p>Redis Streams optionally can be capped to a specific or exact length (see the documentation
	for the <a href="https://redis.io/commands/xtrim">XTRIM</a> API); <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#writeStreams--"><code>writeStreams()</code></a> lets
	you specify MAXLEN using the <code>withMaxLen()</code> option.

	<p>Trimming a stream to an exact length is noted in the Redis documentation as being inefficient;
	the <code>withApproximateTrim()</code> boolean option will add the <code>~</code> prefix to <code>MAXLEN</code>,
	which tells Redis to use "almost exact" trimming.

	<p>See the <a href="https://redis.io/topics/streams-intro">Redis Streams documentation</a> for a
	deeper discussion of the issues involved.

	<p>The following example illustrates how to configure a sink with trimming:

	<pre><code>
	pipeline.apply(...)
	// here we have a PCollection<KV<String, Map<String, String>>>
	.apply(RedisIO.writeStreams()
	.withEndpoint("::1", 6379)
	.withMaxLen(1024L)
	.withApproximateTrim(true)
	)
	</code></pre></div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ======== NESTED CLASS SUMMARY ======== -->
	<ul class="blockList">
	<li class="blockList"><a name="nested.class.summary">
	<!-- -->
	</a>
	<h3>Nested Class Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
	<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Class and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>static class </code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Read</a></span></code>
	<div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--"><code>read()</code></a>.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>static class </code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.ReadKeyPatterns.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.ReadKeyPatterns</a></span></code>
	<div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#readKeyPatterns--"><code>readKeyPatterns()</code></a>.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>static class </code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Write</a></span></code>
	<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to write to a Redis server.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>static class </code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.WriteStreams.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.WriteStreams</a></span></code>
	<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to write stream key pairs (https://redis.io/topics/streams-intro) to a
	Redis server.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	<!-- ========== METHOD SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="method.summary">
	<!-- -->
	</a>
	<h3>Method Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
	<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Method and Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Read</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--">read</a></span>()</code>
	<div class="block">Read data from a Redis server.</div>
	</td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.ReadKeyPatterns.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.ReadKeyPatterns</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#readKeyPatterns--">readKeyPatterns</a></span>()</code>
	<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--"><code>read()</code></a> but executes multiple instances of the Redis query substituting each
	element of a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> as key pattern.</div>
	</td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Write</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#write--">write</a></span>()</code>
	<div class="block">Write data to a Redis server.</div>
	</td>
	</tr>
	<tr id="i3" class="rowColor">
	<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.WriteStreams.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.WriteStreams</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#writeStreams--">writeStreams</a></span>()</code>
	<div class="block">Write stream data to a Redis server.</div>
	</td>
	</tr>
	</table>
	<ul class="blockList">
	<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
	<!-- -->
	</a>
	<h3>Methods inherited from class java.lang.Object</h3>
	<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ METHOD DETAIL ========== -->
	<ul class="blockList">
	<li class="blockList"><a name="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a name="read--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>read</h4>
	<pre>public static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Read</a> read()</pre>
	<div class="block">Read data from a Redis server.</div>
	</li>
	</ul>
	<a name="readKeyPatterns--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>readKeyPatterns</h4>
	<pre>public static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.ReadKeyPatterns.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.ReadKeyPatterns</a> readKeyPatterns()</pre>
	<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.html#read--"><code>read()</code></a> but executes multiple instances of the Redis query substituting each
	element of a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> as key pattern.</div>
	</li>
	</ul>
	<a name="write--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>write</h4>
	<pre>public static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Write.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.Write</a> write()</pre>
	<div class="block">Write data to a Redis server.</div>
	</li>
	</ul>
	<a name="writeStreams--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>writeStreams</h4>
	<pre>public static <a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.WriteStreams.html" title="class in org.apache.beam.sdk.io.redis">RedisIO.WriteStreams</a> writeStreams()</pre>
	<div class="block">Write stream data to a Redis server.</div>
	</li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	</div>
	<!-- ========= END OF CLASS DATA ========= -->
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a name="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a name="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../../../overview-summary.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../../../index-all.html">Index</a></li>
	<li><a href="../../../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisConnectionConfiguration.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../../../org/apache/beam/sdk/io/redis/RedisIO.Read.html" title="class in org.apache.beam.sdk.io.redis"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/redis/RedisIO.html" target="_top">Frames</a></li>
	<li><a href="RedisIO.html" target="_top">No Frames</a></li>
	</ul>
	<ul class="navList" id="allclasses_navbar_bottom">
	<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_bottom");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li><a href="#nested.class.summary">Nested</a> \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>