Documentation

QueryOptions

Table of Contents

timeout() Sets the operation timeout in milliseconds. QueryOptions
consistentWith() Sets the mutation state to achieve consistency with for read your own writes (RYOW). QueryOptions
scanConsistency() Sets the scan consistency. QueryOptions
scanCap() Sets the maximum buffered channel size between the indexer client and the query service for index scans. QueryOptions
pipelineCap() Sets the maximum number of items each execution operator can buffer between various operators. QueryOptions
pipelineBatch() Sets the number of items execution operators can batch for fetch from the KV service. QueryOptions
maxParallelism() Sets the maximum number of index partitions, for computing aggregation in parallel. QueryOptions
profile() Sets the query profile mode to use. QueryOptions
readonly() Sets whether or not this query is readonly. QueryOptions
adhoc() Sets whether or not this query is adhoc. QueryOptions
namedParameters() Sets the named parameters for this query. QueryOptions
positionalParameters() Sets the positional parameters for this query. QueryOptions
raw() Sets any extra query parameters that the SDK does not provide an option for. QueryOptions
clientContextId() Sets the client context id for this query. QueryOptions
metrics() Sets whether or not to return metrics with the query. QueryOptions

Methods

timeout()

Sets the operation timeout in milliseconds.

public timeout( $arg : int ) : QueryOptions
Parameters
$arg : int

the operation timeout to apply

Return values
QueryOptions

scanConsistency()

Sets the scan consistency.

public scanConsistency( $arg : int ) : QueryOptions
Parameters
$arg : int

the scan consistency level

Return values
QueryOptions

scanCap()

Sets the maximum buffered channel size between the indexer client and the query service for index scans.

public scanCap( $arg : int ) : QueryOptions
Parameters
$arg : int

the maximum buffered channel size

Return values
QueryOptions

pipelineCap()

Sets the maximum number of items each execution operator can buffer between various operators.

public pipelineCap( $arg : int ) : QueryOptions
Parameters
$arg : int

the maximum number of items each execution operation can buffer

Return values
QueryOptions

pipelineBatch()

Sets the number of items execution operators can batch for fetch from the KV service.

public pipelineBatch( $arg : int ) : QueryOptions
Parameters
$arg : int

the pipeline batch size

Return values
QueryOptions

maxParallelism()

Sets the maximum number of index partitions, for computing aggregation in parallel.

public maxParallelism( $arg : int ) : QueryOptions
Parameters
$arg : int

the number of index partitions

Return values
QueryOptions

readonly()

Sets whether or not this query is readonly.

public readonly( $arg : bool ) : QueryOptions
Parameters
$arg : bool

whether the query is readonly

Return values
QueryOptions

adhoc()

Sets whether or not this query is adhoc.

public adhoc( $arg : bool ) : QueryOptions
Parameters
$arg : bool

whether the query is adhoc

Return values
QueryOptions

namedParameters()

Sets the named parameters for this query.

public namedParameters( $pairs : array ) : QueryOptions
Parameters
$pairs : array

the associative array of parameters

Return values
QueryOptions

positionalParameters()

Sets the positional parameters for this query.

public positionalParameters( $args : array ) : QueryOptions
Parameters
$args : array

the array of parameters

Return values
QueryOptions

raw()

Sets any extra query parameters that the SDK does not provide an option for.

public raw( $key : string , $value : string ) : QueryOptions
Parameters
$key : string

the name of the parameter

$value : string

the value of the parameter

Return values
QueryOptions

clientContextId()

Sets the client context id for this query.

public clientContextId( $arg : string ) : QueryOptions
Parameters
$arg : string

the client context id

Return values
QueryOptions

metrics()

Sets whether or not to return metrics with the query.

public metrics( $arg : bool ) : QueryOptions
Parameters
$arg : bool

whether to return metrics

Return values
QueryOptions

Search results