com.aerospike.client.policy

Class QueryPolicy

java.lang.Object

com.aerospike.client.policy.Policy

com.aerospike.client.policy.QueryPolicy

public class QueryPolicy
extends Policy

Container object for policy attributes used in query operations.

Field Summary

Fields

Modifier and Type	Field and Description
QueryDuration	expectedDuration Expected query duration.
boolean	failOnClusterChange Terminate query if cluster is in migration state.
boolean	includeBinData Should bin data be retrieved.
int	infoTimeout Timeout in milliseconds for "cluster-stable" info command that is run when failOnClusterChange is true and server version is less than 6.0.
int	maxConcurrentNodes Maximum number of concurrent requests to server nodes at any point in time.
long	maxRecords Deprecated.
int	recordQueueSize Number of records to place in queue before blocking.
boolean	shortQuery Deprecated.

Fields inherited from class com.aerospike.client.policy.Policy

compress, connectTimeout, failOnFilteredOut, filterExp, maxRetries, readModeAP, readModeSC, readTouchTtlPercent, replica, sendKey, sleepBetweenRetries, socketTimeout, timeoutDelay, totalTimeout

Constructor Summary

Constructors

Constructor and Description
QueryPolicy() Default constructor.
QueryPolicy(Policy other) Copy query policy from another policy.
QueryPolicy(QueryPolicy other) Copy query policy from another query policy.

Method Summary

Modifier and Type	Method and Description
void	setExpectedDuration(QueryDuration expectedDuration)
void	setFailOnClusterChange(boolean failOnClusterChange)
void	setIncludeBinData(boolean includeBinData)
void	setInfoTimeout(int infoTimeout)
void	setMaxConcurrentNodes(int maxConcurrentNodes)
void	setMaxRecords(long maxRecords)
void	setRecordQueueSize(int recordQueueSize)
void	setShortQuery(boolean shortQuery)

Methods inherited from class com.aerospike.client.policy.Policy

equals, hashCode, setCompress, setConnectTimeout, setFailOnFilteredOut, setFilterExp, setMaxRetries, setReadModeAP, setReadModeSC, setReadTouchTtlPercent, setReplica, setSendKey, setSleepBetweenRetries, setSocketTimeout, setTimeout, setTimeoutDelay, setTimeouts, setTotalTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

expectedDuration

public QueryDuration expectedDuration

Expected query duration. The server treats the query in different ways depending on the expected duration. This field is ignored for aggregation queries, background queries and server versions < 6.0.

Default: QueryDuration.LONG

maxRecords

@Deprecated
public long maxRecords

Deprecated.

This field is deprecated. Use Statement.setMaxRecords(long) instead.

Approximate number of records to return to client. This number is divided by the number of nodes involved in the query. The actual number of records returned may be less than maxRecords if node record counts are small and unbalanced across nodes.

maxRecords is only supported when query filter is null. maxRecords exists here because query methods will convert into a scan when the query filter is null. maxRecords is ignored when the query contains a filter.

Default: 0 (do not limit record count)

maxConcurrentNodes

public int maxConcurrentNodes

Maximum number of concurrent requests to server nodes at any point in time. If there are 16 nodes in the cluster and maxConcurrentNodes is 8, then queries will be made to 8 nodes in parallel. When a query completes, a new query will be issued until all 16 nodes have been queried.

Default: 0 (issue requests to all server nodes in parallel)

recordQueueSize

public int recordQueueSize

Number of records to place in queue before blocking. Records received from multiple server nodes will be placed in a queue. A separate thread consumes these records in parallel. If the queue is full, the producer threads will block until records are consumed.

Default: 5000

infoTimeout

public int infoTimeout

Timeout in milliseconds for "cluster-stable" info command that is run when failOnClusterChange is true and server version is less than 6.0.

Default: 1000

includeBinData

public boolean includeBinData

Should bin data be retrieved. If false, only record digests (and user keys if stored on the server) are retrieved.

Default: true

failOnClusterChange

public boolean failOnClusterChange

Terminate query if cluster is in migration state. If the server supports partition queries or the query filter is null (scan), this field is ignored.

Default: false

shortQuery

@Deprecated
public boolean shortQuery

Deprecated.

This field is deprecated and will eventually be removed. Use expectedDuration instead.

For backwards compatibility: If shortQuery is true, the query is treated as a short query and expectedDuration is ignored. If shortQuery is false, expectedDuration is used and defaults to QueryDuration.LONG.

Is query expected to return less than 100 records per node. If true, the server will optimize the query for a small record set. This field is ignored for aggregation queries, background queries and server versions < 6.0.

Default: false

Constructor Detail

QueryPolicy

public QueryPolicy(QueryPolicy other)

Copy query policy from another query policy.

QueryPolicy

public QueryPolicy(Policy other)

Copy query policy from another policy.

QueryPolicy

public QueryPolicy()

Default constructor. Disable totalTimeout and set maxRetries.

The latest servers support retries on individual data partitions. This feature is useful when a cluster is migrating and partition(s) are missed or incomplete on the first query attempt.

If the first query attempt misses 2 of 4096 partitions, then only those 2 partitions are retried in the next query attempt from the last key digest received for each respective partition. A higher default maxRetries is used because it's wasteful to invalidate all query results because a single partition was missed.

Method Detail

setExpectedDuration

public void setExpectedDuration(QueryDuration expectedDuration)

setMaxRecords

public void setMaxRecords(long maxRecords)

setMaxConcurrentNodes

public void setMaxConcurrentNodes(int maxConcurrentNodes)

setRecordQueueSize

public void setRecordQueueSize(int recordQueueSize)

setInfoTimeout

public void setInfoTimeout(int infoTimeout)

setIncludeBinData

public void setIncludeBinData(boolean includeBinData)

setFailOnClusterChange

public void setFailOnClusterChange(boolean failOnClusterChange)

setShortQuery

public void setShortQuery(boolean shortQuery)