Documentation

QueryPolicy
in package

QueryPolicy encapsulates parameters for policy attributes used in query operations.

Table of Contents

Properties

$exit_fast_on_exhausted_connection_pool  : mixed
$expected_duration  : mixed
$filter_expression  : mixed
$max_concurrent_nodes  : mixed
$max_retries  : mixed
$read_mode_ap  : mixed
$read_mode_sc  : mixed
$record_queue_size  : mixed
$send_key  : mixed
$sleep_multiplier  : mixed
$socket_timeout  : mixed
$total_timeout  : mixed
$use_compression  : mixed

Methods

__construct()  : mixed
getExitFastOnExhaustedConnectionPool()  : bool
getExpectedDuration()  : QueryDuration
QueryDuration represents the expected duration for a query operation in the Aerospike database.
getFilterExpression()  : Expression|null
getMaxConcurrentNodes()  : int
*************************************************************************** MultiPolicy Attrs *************************************************************************** Maximum number of concurrent requests to server nodes at any point in time.
getMaxRetries()  : int
*************************************************************************** ReadPolicy Attrs ***************************************************************************
getReadModeAp()  : ReadModeAP
getReadModeSc()  : ReadModeSC
getRecordQueueSize()  : int
Number of records to place in queue before blocking.
getSendKey()  : bool
getSleepMultiplier()  : float
getSocketTimeout()  : int
getTotalTimeout()  : int
getUseCompression()  : bool
setExitFastOnExhaustedConnectionPool()  : mixed
setExpectedDuration()  : mixed
setFilterExpression()  : mixed
setMaxConcurrentNodes()  : mixed
setMaxRetries()  : mixed
setReadModeAp()  : mixed
setReadModeSc()  : mixed
setRecordQueueSize()  : mixed
setSendKey()  : mixed
setSleepMultiplier()  : mixed
setSocketTimeout()  : mixed
setTotalTimeout()  : mixed
setUseCompression()  : mixed

Properties

Methods

getExpectedDuration()

QueryDuration represents the expected duration for a query operation in the Aerospike database.

public getExpectedDuration() : QueryDuration

It provides options for specifying whether a query is expected to return a large number of records per node (Long), a small number of records per node (Short), or a long query with relaxed read consistency for AP namespaces (LongRelaxAP). These options influence how the server optimizes query execution to meet the expected duration requirements.

Return values
QueryDuration

getMaxConcurrentNodes()

*************************************************************************** MultiPolicy Attrs *************************************************************************** Maximum number of concurrent requests to server nodes at any point in time.

public getMaxConcurrentNodes() : int

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) is to issue requests to all server nodes in parallel. 1 will to issue requests to server nodes one by one avoiding parallel queries.

Return values
int

getMaxRetries()

*************************************************************************** ReadPolicy Attrs ***************************************************************************

public getMaxRetries() : int
Return values
int

getRecordQueueSize()

Number of records to place in queue before blocking.

public getRecordQueueSize() : int

Records received from multiple server nodes will be placed in a queue. A separate goroutine consumes these records in parallel. If the queue is full, the producer goroutines will block until records are consumed.

Return values
int

setExitFastOnExhaustedConnectionPool()

public setExitFastOnExhaustedConnectionPool(bool $exit_fast_on_exhausted_connection_pool) : mixed
Parameters
$exit_fast_on_exhausted_connection_pool : bool

setExpectedDuration()

public setExpectedDuration(mixed $expected_duration) : mixed
Parameters
$expected_duration : mixed

setFilterExpression()

public setFilterExpression(mixed $filter_expression) : mixed
Parameters
$filter_expression : mixed

setMaxConcurrentNodes()

public setMaxConcurrentNodes(int $max_concurrent_nodes) : mixed
Parameters
$max_concurrent_nodes : int

        
On this page

Search results