org.apache.solr.handler.component

Class RealTimeGetComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

org.apache.solr.handler.component.RealTimeGetComponent

All Implemented Interfaces:

SolrInfoBean, NamedListInitializedPlugin

public class RealTimeGetComponent
extends SearchComponent

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_NAME
static SolrInputDocument	DELETED

Fields inherited from class org.apache.solr.handler.component.SearchComponent

metricNames, registry, standard_components

Constructor Summary

Constructors

Constructor and Description
RealTimeGetComponent()

Method Summary

Modifier and Type	Method and Description
int	createSubRequests(ResponseBuilder rb)
int	distributedProcess(ResponseBuilder rb) Process for a distributed search.
void	finishStage(ResponseBuilder rb) private void handleRegularResponses(ResponseBuilder rb, ShardRequest sreq) { }
SolrInfoBean.Category	getCategory() Category of this component
String	getDescription() Simple one or two line description
static SolrInputDocument	getInputDocument(SolrCore core, BytesRef idBytes) Obtains the latest document for a given id from the tlog or index (if not found in the tlog).
static SolrInputDocument	getInputDocument(SolrCore core, BytesRef idBytes, AtomicLong versionReturned, boolean avoidRetrievingStoredFields, Set<String> onlyTheseNonStoredDVs, boolean resolveFullDocument) Obtains the latest document for a given id from the tlog or through the realtime searcher (if not found in the tlog).
static SolrInputDocument	getInputDocumentFromTlog(SolrCore core, BytesRef idBytes, AtomicLong versionReturned, Set<String> onlyTheseNonStoredDVs, boolean resolveFullDocument) returns the SolrInputDocument from the current tlog, or DELETED if it has been deleted, or null if there is no record of it in the current update log.
void	prepare(ResponseBuilder rb) Prepare the response.
void	process(ResponseBuilder rb) Process the request for this component
void	processGetFingeprint(ResponseBuilder rb)
void	processGetUpdates(ResponseBuilder rb)
void	processGetVersions(ResponseBuilder rb)
void	processSync(ResponseBuilder rb, int nVersions, String sync)
static SolrDocument	toSolrDoc(SolrInputDocument sdoc, IndexSchema schema) Converts a SolrInputDocument to SolrDocument, using an IndexSchema instance.

Methods inherited from class org.apache.solr.handler.component.SearchComponent

getMetricNames, getMetricRegistry, getName, handleResponses, init, modifyRequest, setName

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.core.SolrInfoBean

getMetricsSnapshot, registerMetricName

Field Detail

COMPONENT_NAME

public static final String COMPONENT_NAME

See Also:

Constant Field Values

DELETED

public static SolrInputDocument DELETED

Constructor Detail

RealTimeGetComponent

public RealTimeGetComponent()

Method Detail

prepare

public void prepare(ResponseBuilder rb)
             throws IOException

Description copied from class: SearchComponent

Prepare the response. Guaranteed to be called before any SearchComponent SearchComponent.process(org.apache.solr.handler.component.ResponseBuilder) method. Called for every incoming request. The place to do initialization that is request dependent.

Specified by:

prepare in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

IOException - If there is a low-level I/O error.

process

public void process(ResponseBuilder rb)
             throws IOException

Description copied from class: SearchComponent

Process the request for this component

Specified by:

process in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

IOException - If there is a low-level I/O error.

getInputDocumentFromTlog

public static SolrInputDocument getInputDocumentFromTlog(SolrCore core,
                                                         BytesRef idBytes,
                                                         AtomicLong versionReturned,
                                                         Set<String> onlyTheseNonStoredDVs,
                                                         boolean resolveFullDocument)

returns the SolrInputDocument from the current tlog, or DELETED if it has been deleted, or null if there is no record of it in the current update log. If null is returned, it could still be in the latest index.

Parameters:

versionReturned - If a non-null AtomicLong is passed in, it is set to the version of the update returned from the TLog.

resolveFullDocument - In case the document is fetched from the tlog, it could only be a partial document if the last update was an in-place update. In that case, should this partial document be resolved to a full document (by following back prevPointer/prevVersion)?

getInputDocument

public static SolrInputDocument getInputDocument(SolrCore core,
                                                 BytesRef idBytes)
                                          throws IOException

Obtains the latest document for a given id from the tlog or index (if not found in the tlog). NOTE: This method uses the effective value for avoidRetrievingStoredFields param as false and for nonStoredDVs as null in the call to @see getInputDocument(SolrCore, BytesRef, AtomicLong, boolean, Set, boolean), so as to retrieve all stored and non-stored DV fields from all documents. Also, it uses the effective value of resolveFullDocument param as true, i.e. it resolves any partial documents (in-place updates), in case the document is fetched from the tlog, to a full document.

Throws:

IOException

getInputDocument

public static SolrInputDocument getInputDocument(SolrCore core,
                                                 BytesRef idBytes,
                                                 AtomicLong versionReturned,
                                                 boolean avoidRetrievingStoredFields,
                                                 Set<String> onlyTheseNonStoredDVs,
                                                 boolean resolveFullDocument)
                                          throws IOException

Obtains the latest document for a given id from the tlog or through the realtime searcher (if not found in the tlog).

Parameters:

versionReturned - If a non-null AtomicLong is passed in, it is set to the version of the update returned from the TLog.

avoidRetrievingStoredFields - Setting this to true avoids fetching stored fields through the realtime searcher, however has no effect on documents obtained from the tlog. Non-stored docValues fields are populated anyway, and are not affected by this parameter. Note that if the id field is a stored field, it will not be populated if this parameter is true and the document is obtained from the index.

onlyTheseNonStoredDVs - If not-null, populate only these DV fields in the document fetched through the realtime searcher. If this is null, decorate all non-stored DVs (that are not targets of copy fields) from the searcher.

resolveFullDocument - In case the document is fetched from the tlog, it could only be a partial document if the last update was an in-place update. In that case, should this partial document be resolved to a full document (by following back prevPointer/prevVersion)?

Throws:

IOException

toSolrDoc

public static SolrDocument toSolrDoc(SolrInputDocument sdoc,
                                     IndexSchema schema)

Converts a SolrInputDocument to SolrDocument, using an IndexSchema instance.

WARNING: This API is experimental and might change in incompatible ways in the next release.

distributedProcess

public int distributedProcess(ResponseBuilder rb)
                       throws IOException

Description copied from class: SearchComponent

Process for a distributed search.

Overrides:

distributedProcess in class SearchComponent

Returns:

the next stage for this component

Throws:

IOException

createSubRequests

public int createSubRequests(ResponseBuilder rb)
                      throws IOException

Throws:

IOException

finishStage

public void finishStage(ResponseBuilder rb)

private void handleRegularResponses(ResponseBuilder rb, ShardRequest sreq) { }

Overrides:

finishStage in class SearchComponent

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class SearchComponent

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

Overrides:

getCategory in class SearchComponent

processGetFingeprint

public void processGetFingeprint(ResponseBuilder rb)
                          throws IOException

Throws:

IOException

processGetVersions

public void processGetVersions(ResponseBuilder rb)
                        throws IOException

Throws:

IOException

processSync

public void processSync(ResponseBuilder rb,
                        int nVersions,
                        String sync)

processGetUpdates

public void processGetUpdates(ResponseBuilder rb)
                       throws IOException

Throws:

IOException