Skip to main content Crate aerospike Copy item path Source errors Error and Result types for the Aerospike client. expressions Functions used for Filter Expressions. This module requires Aerospike Server version >= 5.2 operations Functions used to create database operations used in the client’s operate() method. policy Policy types encapsulate optional parameters for various client operations. query Types and methods used for database queries and scans. task Types and methods used for long running status queries. as_bin Construct a new bin from a name and an optional value (defaults to the empty value nil). as_blob Constructs a new Blob Value from one of the supported native data types. as_contains Deprecated Creates contains filter for queries on a collection index. as_contains_range Deprecated Creates contains range filter for queries on a collection index. as_eq Deprecated Creates equality filter for queries. as_geo Constructs a new GeoJSON Value from one of the supported native data types. as_key Construct a new key given a namespace, a set name and a user key. as_list Constructs a new List Value from a list of one or more native data types. as_map Constructs a Map Value from a list of key/value pairs. as_ord_map Constructs an Ordered Map Value from a list of key/value pairs. as_range Deprecated Creates range filter for queries. as_regions_containing_point Deprecated Creates geo-spatial “regions containing point” filter for queries. as_val Constructs a new Value from one of the supported native data types. as_values Constructs a vector of Values from a list of one or more native data types. as_within_radius Deprecated Creates geo-spatial “points within radius” filter for queries. as_within_region Deprecated Creates geo-spatial “points within region” filter for queries. AdminPolicy Policy attributes used for user administration commands. BasePolicy Common parameters shared by all policy types. BatchDeletePolicy Policy for a single batch delete operation. BatchPolicy BatchPolicy encapsulates parameters for all batch operations.BatchReadPolicy Policy for a single batch read operation. BatchRecord Encapsulates the Batch key and record result. BatchUDFPolicy Policy for a single batch udf operation. BatchWritePolicy Policy for a single batch write operation. Bin Container object for a record bin, comprising a name and a value. Client Instantiate a Client instance to access an Aerospike database cluster and perform database
operations. ClientPolicy ClientPolicy encapsulates parameters for client policy command.DropIndexTask Struct for querying index creation status ExecuteTask Task used to poll for long running query execute job completion. Host Host name/port of database server. IndexTask Struct for querying index creation status Key Unique record identifier. ListPolicy ListPolicyMapPolicy MapPolicyNode The node instance holding connections and node settings.
Exposed for usage in the sync client interface. PartitionFilter PartitionFilter is used in scan/queries. This filter is also used as a cursor.Privilege Privilege determines user access granularity. QueryPolicy QueryPolicy encapsulates parameters for query operations.ReadPolicy ReadPolicy encapsulates parameters for transaction policy attributes
used in all database operation calls.Record Container object for a database record. Recordset Virtual collection of records retrieved through queries and scans. RegisterTask Struct for querying udf register status Role Role allows granular access to database entities for users. Statement Query statement parameters. UdfRemoveTask Struct for querying index creation status User User and assigned roles. Version Holds version numbers. WritePolicy WritePolicy encapsulates parameters for all write operations.AuthMode Determines authentication mode. BatchOperation Represents a batch operation.
Do not directly create the batch operations. Use the helper methods instead. Bins Specify which, if any, bins to return in read operations. CollectionIndexType Secondary index collection type. CommitLevel CommitLevel determines how to handle record writes based on record generation.Concurrency Specifies whether a command, that needs to be executed on multiple cluster nodes, should be
executed sequentially, one node at a time, or in parallel on multiple nodes using the client’s
thread pool. ConsistencyLevel ConsistencyLevel indicates how replicas should be consulted in a read
operation to provide the desired consistency guarantee.Error Aerospike client and protocol errors. Expiration Record expiration, also known as time-to-live (TTL). FloatValue Container for floating point bin values stored in the Aerospike database. GenerationPolicy GenerationPolicy determines how to handle record writes based on record generation.IndexType Underlying data type of secondary index. ListOrderType List storage order. ListReturnType ListReturnTypeListSortFlags ListSortFlagsListWriteFlags Write flags for CDT list operations. MapReturnType Map return type. Type of data to return when selecting or removing items from the map. MapWriteMode Unique key map write type. PrivilegeCode Default privileges defined on the server. QueryDuration QueryDuration defines the expected query duration. The server treats the query in different ways depending on the expected duration.ReadTouchTTL ReadTouchTTLPercent determines how record TTL (time to live) is affected on reads.RecordExistsAction RecordExistsAction determines how to handle record writes based on record generation.RegexFlag Used to change the Regex Mode in Filters ResultCode Database operation error codes. The error codes are defined in the server-side file proto.h. UDFLang User-defined function (UDF) language Value Container for bin values stored in the Aerospike database. EqFilterValue Marker trait for types valid in equality and contains filters. Policy Trait implemented by most policy types; policies that implement this trait typically encompass
an instance of BasePolicy. RangeFilterValue Marker trait for types valid in range filters. Task Base task interface ToHosts A trait for objects which can be converted to one or more Host values. Result