org.apache.beam.sdk.io.solr

Class SolrIO

java.lang.Object

org.apache.beam.sdk.io.solr.SolrIO

public class SolrIO
extends java.lang.Object

Transforms for reading and writing data from/to Solr.

Reading from Solr

SolrIO.read() returns a bounded PCollection<SolrDocument> representing Solr documents.

To configure the read(), you have to provide a connection configuration containing the Zookeeper address of the Solr cluster, and the collection name. The following example illustrates options for configuring the source:

 SolrIO.ConnectionConfiguration conn = SolrIO.ConnectionConfiguration.create("127.0.0.1:9983");
 // Optionally: .withBasicCredentials(username, password)

 PCollection<SolrDocument> docs = p.apply(
     SolrIO.read().from("my-collection").withConnectionConfiguration(conn));

 

You can specify a query on the read() using withQuery().

Writing to Solr

To write documents to Solr, use SolrIO.write(), which writes Solr documents from a PCollection<SolrInputDocument> (which can be bounded or unbounded).

To configure SolrIO.write(), similar to the read, you have to provide a connection configuration, and a collection name. For instance:

 PCollection<SolrInputDocument> inputDocs = ...;
 inputDocs.apply(SolrIO.write().to("my-collection").withConnectionConfiguration(conn));

 

When writing it is possible to customize the retry behavior if an error is encountered. By default this is disabled and only one attempt will be made.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrIO.ConnectionConfiguration A POJO describing a connection configuration to Solr.
static class	SolrIO.Read A PTransform reading data from Solr.
static class	SolrIO.ReadAll
static class	SolrIO.ReplicaInfo A POJO describing a replica of Solr.
static class	SolrIO.RetryConfiguration A POJO encapsulating a configuration for retry behavior when issuing requests to Solr.
static class	SolrIO.Write A PTransform writing data to Solr.

Method Summary

Modifier and Type	Method and Description
static SolrIO.Read	read()
static SolrIO.ReadAll	readAll()
static SolrIO.Write	write()

Methods inherited from class java.lang.Object

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

Method Detail

read

public static SolrIO.Read read()

readAll

public static SolrIO.ReadAll readAll()

write

public static SolrIO.Write write()