Statement Class

Query statement parameters.

Definition

Namespace: Aerospike.Client
Assembly: AerospikeClient (in AerospikeClient.dll) Version: 7.0.1
C#
public sealed class Statement
Inheritance
Object    Statement

Constructors

StatementInitializes a new instance of the Statement class

Properties

BinNames Query bin names.
Filter Optional query filter. This filter is applied to the secondary index on query. Query index filters must reference a bin which has a secondary index defined.
FunctionArgs Arguments to pass to function name, if any. Used by aggregate queries only.
FunctionName Aggregation function name. Used by aggregate queries only.
IndexName Optional query index name. If not set, the server will determine the index from the filter's bin name.
MaxRecords Maximum number of records returned (for foreground query) or processed (for background execute query). 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.

Default: 0 (do not limit record count)

Namespace Query namespace.
Operations Operations to be performed on query/execute.
PackageContents String containing lua code that comprises a package. Used by aggregate queries only when aggregation function is defined in a string.
PackageName Server package where user defined function resides. Used by aggregate queries only.
RecordsPerSecond Limit returned records per second (rps) rate for each server. Do not apply rps limit if recordsPerSecond is zero (default). Currently only applicable to a query without a defined filter.
ResourceAssembly Assembly where resource is located. Current assembly can be obtained by: Assembly.GetExecutingAssembly(). Used by aggregate queries only.
ResourcePath Namespace path where Lua resource is located. Example: Aerospike.Client.Resources.mypackage.lua Used by aggregate queries only.
SetName Optional query set name.
TaskId Optional task id.

Methods

SetAggregateFunction(String, String, Value) Set Lua aggregation function parameters for a Lua package located on the filesystem. This function will be called on both the server and client for each selected item.
SetAggregateFunction(String, String, String, Value) Set Lua aggregation function parameters for a Lua package located in a string with lua code. This function will be called on both the server and client for each selected item.
SetAggregateFunction(Assembly, String, String, String, Value) Set Lua aggregation function parameters for a Lua package located in an assembly resource. This function will be called on both the server and client for each selected item.
SetBinNames Set query bin names.
SetFilter Set optional query index filter. This filter is applied to the secondary index on query. Query index filters must reference a bin which has a secondary index defined.
SetIndexName Set optional query index name. If not set, the server will determine the index from the filter's bin name.
SetNamespace Set query namespace.
SetRecordsPerSecond Set returned records per second (rps) rate for each server.
SetSetName Set optional query set name.
SetTaskId Set optional task id.

See Also