Package com.yahoo.documentapi
Class VisitorParameters
java.lang.Object
com.yahoo.documentapi.Parameters
com.yahoo.documentapi.VisitorParameters
- Direct Known Subclasses:
DocumentVisitor
Parameters for creating or opening a visitor session
- Author:
- Håkon Humberset
-
Constructor Summary
ConstructorDescriptionVisitorParameters
(VisitorParameters params) Copy constructor.VisitorParameters
(String documentSelection) Creates visitor parameters from a document selection expression, using defaults for other parameters. -
Method Summary
Modifier and TypeMethodDescriptionfieldSet()
void
Set field set to use.Set<com.yahoo.document.BucketId>
boolean
float
long
Deprecated, for removal: This API element is subject to removal in a future version.load types are deprecatedint
long
Deprecated, for removal: This API element is subject to removal in a future version.Use getMaxTotalHits() insteadint
long
com.yahoo.messagebus.routing.Route
getRoute()
long
int
int
long
long
int
boolean
Deprecated.boolean
boolean
void
setBucketSpace
(String bucketSpace) Set which (single) bucket space this visiting will be against.void
setBucketsToVisit
(Set<com.yahoo.document.BucketId> buckets) void
setControlHandler
(VisitorControlHandler controlHandler) Set control handler.void
setDocumentSelection
(String selection) Set the document selection expressionvoid
setDynamicallyIncreaseMaxBucketsPerVisitor
(boolean dynamicallyIncreaseMaxBucketsPerVisitor) Deprecated, for removal: This API element is subject to removal in a future version.deprecated feature, will be removed on Vespa 8void
setDynamicMaxBucketsIncreaseFactor
(float dynamicMaxBucketsIncreaseFactor) Set factor with which max buckets are dynamically increased each timevoid
setFieldSet
(String fieldSet) void
setFromTimestamp
(long timestamp) Set from timestamp in microseconds.void
setLibraryParameter
(String param, byte[] value) Set a visitor library specific parameter.void
setLibraryParameter
(String param, String value) Set a visitor library specific parameter.void
setLibraryParameters
(Map<String, byte[]> params) Set all visitor library specific parameters.void
setLoadType
(LoadType loadType) Deprecated, for removal: This API element is subject to removal in a future version.load types are deprecatedvoid
setLocalDataHandler
(VisitorDataHandler localDataHandler) Set local data handler.void
setMaxBucketsPerVisitor
(int max) void
setMaxFirstPassHits
(long max) Deprecated, for removal: This API element is subject to removal in a future version.use setMaxTotalHits insteadvoid
setMaxPending
(int maxPending) Set maximum pending messages one storage visitor will have pending to this client before stalling, waiting for acks.void
setMaxTotalHits
(long max) Set the maximum number of documents to visit (max documents returned by the visitor)void
setPriority
(DocumentProtocol.Priority priority) void
setRemoteDataHandler
(String remoteDataHandler) Set address for the remote data handler.void
setResumeFileName
(String fileName) Set filename for reading/storing progress token.void
setResumeToken
(ProgressToken token) Set progress token, which can be used to resume visitor.void
setRoute
(com.yahoo.messagebus.routing.Route route) Set the route to visit.void
Set the name of the storage cluster route to visit.void
setSessionTimeoutMs
(long timeoutMs) Sets timeout for the entire visiting session, in milliseconds.void
setTimeoutMs
(long timeoutMs) Set the timeout for each visitor command in milliseconds.void
setToTimestamp
(long timestamp) Set to timestamp in microseconds.void
setTraceLevel
(int traceLevel) void
setVisitHeadersOnly
(boolean headersOnly) Deprecated.this option is ignoredvoid
setVisitInconsistentBuckets
(boolean visitInconsistentBuckets) void
setVisitorLibrary
(String library) Set which visitor library is used for visiting in storage.void
setVisitRemoves
(boolean visitRemoves) boolean
void
skipBucketsOnFatalErrors
(boolean skipBucketsOnFatalErrors) void
slice
(int slices, int sliceId) toString()
boolean
void
visitInconsistentBuckets
(boolean visitInconsistentBuckets) Set whether to visit inconsistent buckets.boolean
void
visitRemoves
(boolean visitRemoves) Set whether to visit remove entries.Methods inherited from class com.yahoo.documentapi.Parameters
getThrottlePolicy, setThrottlePolicy
-
Constructor Details
-
VisitorParameters
Creates visitor parameters from a document selection expression, using defaults for other parameters.- Parameters:
documentSelection
- document selection expression
-
VisitorParameters
Copy constructor.- Parameters:
params
- object to copy
-
-
Method Details
-
getDocumentSelection
- Returns:
- The selection string used for visiting.
-
getBucketSpace
- Returns:
- The bucket space to visit
-
getVisitorLibrary
- Returns:
- What visitor library to use for the visiting. The library in question must be installed on each storage node in the target cluster.
-
getMaxPending
public int getMaxPending()- Returns:
- The maximum number of messages each storage visitor will have pending before waiting for acks from client.
-
getTimeoutMs
public long getTimeoutMs()- Returns:
- The timeout for each sent visitor operation in milliseconds.
-
getSessionTimeoutMs
public long getSessionTimeoutMs()- Returns:
- Session timeout in milliseconds, or -1 if not timeout has been set. -1 implies that session will run to completion without automatically timing out.
-
getFromTimestamp
public long getFromTimestamp()- Returns:
- The minimum timestamp (in microsecs) of documents the visitor will visit.
-
getToTimestamp
public long getToTimestamp()- Returns:
- The maximum timestamp (in microsecs) of documents the visitor will visit.
-
visitRemoves
public boolean visitRemoves()- Returns:
- If this method returns true, the visitor will visit remove entries as well as documents (you can see what documents have been deleted).
-
getVisitRemoves
public boolean getVisitRemoves() -
getVisitHeadersOnly
Deprecated. -
fieldSet
- Returns:
- The field set to use.
-
getFieldSet
-
visitInconsistentBuckets
public boolean visitInconsistentBuckets()- Returns:
- If this method returns true, the visitor will visit inconsistent buckets.
-
getVisitInconsistentBuckets
public boolean getVisitInconsistentBuckets() -
getLibraryParameters
- Returns:
- Returns a map of string → string of arguments that are passed to the visitor library.
-
getResumeToken
- Returns:
- The progress token, which can be used to resume visitor.
-
getResumeFileName
- Returns:
- The filename for reading/storing progress token.
-
getRemoteDataHandler
- Returns:
- Address to the remote data handler.
-
getLocalDataHandler
- Returns:
- The local data handler.
-
getControlHandler
- Returns:
- The control handler.
-
getDynamicallyIncreaseMaxBucketsPerVisitor
public boolean getDynamicallyIncreaseMaxBucketsPerVisitor()- Returns:
- Whether or not max buckets per visitor value should be dynamically increased when using orderdoc and visitors do not return at least half the desired amount of documents
-
getDynamicMaxBucketsIncreaseFactor
public float getDynamicMaxBucketsIncreaseFactor()- Returns:
- Factor with which max buckets are dynamically increased each time
-
getPriority
-
setDocumentSelection
Set the document selection expression -
setBucketSpace
Set which (single) bucket space this visiting will be against. -
setVisitorLibrary
Set which visitor library is used for visiting in storage. DumpVisitor is most common implementation. -
setMaxPending
public void setMaxPending(int maxPending) Set maximum pending messages one storage visitor will have pending to this client before stalling, waiting for acks. -
setTimeoutMs
public void setTimeoutMs(long timeoutMs) Set the timeout for each visitor command in milliseconds. -
setSessionTimeoutMs
public void setSessionTimeoutMs(long timeoutMs) Sets timeout for the entire visiting session, in milliseconds. -1 implies infinity. If the session takes more time than this to complete, it will automatically be failed with CompletionCode.TIMEOUT. If no session timeout has been explicitly set (or it has been set to -1), visiting will continue until it completes or abort()/destroy() is called on the session instance. -
setFromTimestamp
public void setFromTimestamp(long timestamp) Set from timestamp in microseconds. Documents put/updated before this timestamp will not be visited. -
setToTimestamp
public void setToTimestamp(long timestamp) Set to timestamp in microseconds. Documents put/updated after this timestamp will not be visited. -
visitRemoves
public void visitRemoves(boolean visitRemoves) Set whether to visit remove entries. That is, entries saying that some document has been removed. -
setVisitRemoves
public void setVisitRemoves(boolean visitRemoves) -
setVisitHeadersOnly
Deprecated.this option is ignored -
fieldSet
Set field set to use. -
setFieldSet
-
visitInconsistentBuckets
public void visitInconsistentBuckets(boolean visitInconsistentBuckets) Set whether to visit inconsistent buckets. -
setVisitInconsistentBuckets
public void setVisitInconsistentBuckets(boolean visitInconsistentBuckets) -
setLibraryParameter
Set a visitor library specific parameter. -
setLibraryParameter
Set a visitor library specific parameter. -
setLibraryParameters
Set all visitor library specific parameters. -
setResumeToken
Set progress token, which can be used to resume visitor. -
setResumeFileName
Set filename for reading/storing progress token. If the file exists and contains progress data, visitor should resume visiting from this point. -
setRemoteDataHandler
Set address for the remote data handler. -
setLocalDataHandler
Set local data handler. -
setControlHandler
Set control handler. -
setRoute
Set the name of the storage cluster route to visit. Default is "storage/cluster.storage". -
setRoute
public void setRoute(com.yahoo.messagebus.routing.Route route) Set the route to visit. -
getRoute
public com.yahoo.messagebus.routing.Route getRoute()- Returns:
- Returns the name of the storage cluster to visit.
-
setMaxFirstPassHits
Deprecated, for removal: This API element is subject to removal in a future version.use setMaxTotalHits insteadSet the maximum number of documents to visit (max documents returned by the visitor) -
getMaxFirstPassHits
Deprecated, for removal: This API element is subject to removal in a future version.Use getMaxTotalHits() instead- Returns:
- Returns the maximum number of documents to visit (max documents returned by the visitor)
-
setMaxTotalHits
public void setMaxTotalHits(long max) Set the maximum number of documents to visit (max documents returned by the visitor) -
getMaxTotalHits
public long getMaxTotalHits()- Returns:
- Returns the maximum number of documents to visit (max documents returned by the visitor)
-
getBucketsToVisit
-
setBucketsToVisit
-
getMaxBucketsPerVisitor
public int getMaxBucketsPerVisitor() -
setMaxBucketsPerVisitor
public void setMaxBucketsPerVisitor(int max) -
setTraceLevel
public void setTraceLevel(int traceLevel) -
getTraceLevel
public int getTraceLevel() -
setPriority
-
setLoadType
Deprecated, for removal: This API element is subject to removal in a future version.load types are deprecated -
getLoadType
Deprecated, for removal: This API element is subject to removal in a future version.load types are deprecated -
skipBucketsOnFatalErrors
public boolean skipBucketsOnFatalErrors() -
skipBucketsOnFatalErrors
public void skipBucketsOnFatalErrors(boolean skipBucketsOnFatalErrors) -
slice
public void slice(int slices, int sliceId) -
getSlices
public int getSlices() -
getSliceId
public int getSliceId() -
setDynamicallyIncreaseMaxBucketsPerVisitor
@Deprecated(since="7", forRemoval=true) public void setDynamicallyIncreaseMaxBucketsPerVisitor(boolean dynamicallyIncreaseMaxBucketsPerVisitor) Deprecated, for removal: This API element is subject to removal in a future version.deprecated feature, will be removed on Vespa 8Set whether or not max buckets per visitor value should be dynamically increased when using orderdoc and visitors do not return at least half the desired amount of documents- Parameters:
dynamicallyIncreaseMaxBucketsPerVisitor
- whether or not to increase
-
setDynamicMaxBucketsIncreaseFactor
public void setDynamicMaxBucketsIncreaseFactor(float dynamicMaxBucketsIncreaseFactor) Set factor with which max buckets are dynamically increased each time- Parameters:
dynamicMaxBucketsIncreaseFactor
- increase factor (must be 1 or more)
-
toString
-