Package org.apache.solr.client.solrj.io.stream

Class SolrStream

java.lang.Object

org.apache.solr.client.solrj.io.stream.TupleStream

org.apache.solr.client.solrj.io.stream.SolrStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, org.apache.solr.common.MapWriter, org.apache.solr.common.NavigableObject, org.noggit.JSONWriter.Writable

public class SolrStream
extends TupleStream

Queries a single Solr instance and maps SolrDocs to a Stream of Tuples.

Since:

5.1.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SolrStream.HandledException

Nested classes/interfaces inherited from class org.apache.solr.client.solrj.io.stream.TupleStream

TupleStream.IgnoreException

Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter

org.apache.solr.common.MapWriter.EntryWriter

Constructor Summary

Constructors

Constructor	Description
SolrStream(String baseUrl, String core, String path, org.apache.solr.common.params.SolrParams params)
SolrStream(String collectionOrCoreUrl, String path, org.apache.solr.common.params.SolrParams params)	Deprecated. Use base URL constructor instead.
SolrStream(String collectionOrCoreUrl, org.apache.solr.common.params.SolrParams params)	Deprecated. Use base URL constructor instead.
SolrStream(String baseUrl, org.apache.solr.common.params.SolrParams params, String core)

Method Summary

Modifier and Type	Method	Description
List<TupleStream>	children()
void	close()	Closes the Stream to a single Solr Instance
String	getBaseUrl()
boolean	getDistrib()
StreamComparator	getStreamSort()	There is no known sort applied to a SolrStream
void	open()	Opens the stream to a single Solr instance.
Tuple	read()	Reads a Tuple from the stream.
void	setCheckpoint(long checkpoint)
void	setCredentials(String user, String password)
void	setDistrib(boolean distrib)
void	setFieldMappings(Map<String,String> fieldMappings)
void	setSlice(String slice)
void	setStreamContext(StreamContext context)
void	setTrace(boolean trace)	Setting trace to true will include the "_CORE_" field in each Tuple emitted by the stream.
Explanation	toExplanation(StreamFactory factory)

Methods inherited from class org.apache.solr.client.solrj.io.stream.TupleStream

buildSolrParamsExcept, getCost, getShards, getShards, getStreamNodeId, writeMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.common.MapWriter

jsonStr, write

Methods inherited from interface org.apache.solr.common.NavigableObject

_forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr, _size

Constructor Details

SolrStream

@Deprecated(since="10.1")
public SolrStream(String collectionOrCoreUrl,
 org.apache.solr.common.params.SolrParams params)

Deprecated.

Use base URL constructor instead.

Parameters:

collectionOrCoreUrl - URL of the Solr core or collection to query, typically of the form "http://host:8983/solr/myCore".

params - query-parameters sent with the streaming request

SolrStream

@Deprecated(since="10.1")
public SolrStream(String collectionOrCoreUrl,
 String path,
 org.apache.solr.common.params.SolrParams params)

Deprecated.

Use base URL constructor instead.

Parameters:

collectionOrCoreUrl - URL of the Solr core or collection to query, typically of the form "http://host:8983/solr/myCore".

path - the request handler path to query (e.g. "/export"). If not provided, defaults to "/select".

params - query-parameters sent with the streaming request

SolrStream

public SolrStream(String baseUrl,
 org.apache.solr.common.params.SolrParams params,
 String core)

Parameters:

baseUrl - the Solr node's "base" URL (i.e. no core or collection in the path

params - query-parameters sent with the streaming request

core - the name of the collection or core to query; must be hosted at baseUrl

SolrStream

public SolrStream(String baseUrl,
 String core,
 String path,
 org.apache.solr.common.params.SolrParams params)

Parameters:

baseUrl - the Solr node's "base" URL (i.e. no core or collection in the path

core - the name of the collection or core to query; must be hosted at baseUrl

path - the request handler path to query (e.g. "/export"). If not provided (i.e. null), the handler is instead resolved from a "qt" param embedded in params, or defaults to "/select" if no such param is present.

params - query-parameters sent with the streaming request

Method Details

setFieldMappings

public void setFieldMappings(Map<String,String> fieldMappings)

children

public List<TupleStream> children()

Specified by:

children in class TupleStream

getBaseUrl

public String getBaseUrl()

setStreamContext

public void setStreamContext(StreamContext context)

Specified by:

setStreamContext in class TupleStream

setCredentials

public void setCredentials(String user,
 String password)

open

public void open()
          throws IOException

Opens the stream to a single Solr instance.

Specified by:

open in class TupleStream

Throws:

IOException

setTrace

public void setTrace(boolean trace)

Setting trace to true will include the "_CORE_" field in each Tuple emitted by the stream.

setSlice

public void setSlice(String slice)

setCheckpoint

public void setCheckpoint(long checkpoint)

toExplanation

public Explanation toExplanation(StreamFactory factory)
                          throws IOException

Specified by:

toExplanation in class TupleStream

Throws:

IOException

close

public void close()
           throws IOException

Closes the Stream to a single Solr Instance

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class TupleStream

Throws:

IOException

read

public Tuple read()
           throws IOException

Reads a Tuple from the stream. The Stream is completed when Tuple.EOF == true.

Specified by:

read in class TupleStream

Throws:

IOException

setDistrib

public void setDistrib(boolean distrib)

getDistrib

public boolean getDistrib()

getStreamSort

public StreamComparator getStreamSort()

There is no known sort applied to a SolrStream

Specified by:

getStreamSort in class TupleStream