Module aerospike::expressions

Functions used for Filter Expressions. This module requires Aerospike Server version >= 5.2

Modules

• bitwise
  Bitwise Aerospike Filter Expressions.
• hll
  HLL Aerospike Filter Expressions.
• lists
  List Cdt Aerospike Filter Expressions.
• maps
  Map Cdt Aerospike Filter Expressions.
• regex_flag
  Regex Bit Flags

Structs

• FilterExpression
  Filter expression, which can be applied to most commands, to control which records are affected by the command. Filter expression are created using the functions in the expressions module and its submodules.

Enums

• ExpType
  Expression Data Types for usage in some FilterExpressions on for example Map and List

Functions

• and
  Create “and” (&&) operator that applies to a variable number of expressions.
• bin_exists
  Create function that returns if bin of specified name exists.
• bin_type
  Create function that returns bin’s integer particle type.
• blob_bin
  Create blob bin expression.
• blob_val
  Creates Blob bin value
• bool_val
  Creates a Boolean value
• cond
  Conditionally select an expression from a variable number of expression pairs followed by default expression action. Requires server version 5.6.0+.
• def
  Assign variable to an expression that can be accessed later. Requires server version 5.6.0+.
• device_size
  Create function that returns record size on disk. If server storage-engine is memory, then zero is returned.
• digest_modulo
  Create function that returns record digest modulo as integer.
• eq
  Create equal (==) expression.
• exp_let
  Define variables and expressions in scope. Requires server version 5.6.0+.
• float_bin
  Create 64 bit float bin expression.
• float_val
  Creates 64 bit float bin value
• ge
  Create greater than or equal (>=) operation.
• geo_bin
  Create geo bin expression.
• geo_compare
  Create compare geospatial operation.
• geo_val
  Create geospatial json string value.
• gt
  Create greater than (>) operation.
• hll_bin
  Create a HLL bin expression
• int_and
  Create integer “and” (&) operator that is applied to two or more integers. All arguments must resolve to integers. Requires server version 5.6.0+.
• int_arshift
  Create integer “arithmetic right shift” (>>) operator. The sign bit is preserved and not shifted. Requires server version 5.6.0+.
• int_bin
  Create 64 bit int bin expression.
• int_count
  Create expression that returns count of integer bits that are set to 1. Requires server version 5.6.0+.
• int_lscan
  Create expression that scans integer bits from left (most significant bit) to right (least significant bit), looking for a search bit value. When the search value is found, the index of that bit (where the most significant bit is index 0) is returned. If “search” is true, the scan will search for the bit value 1. If “search” is false it will search for bit value 0. Requires server version 5.6.0+.
• int_lshift
  Create integer “left shift” (<<) operator. Requires server version 5.6.0+.
• int_not
  Create integer “not” (~) operator. Requires server version 5.6.0+.
• int_rscan
  Create expression that scans integer bits from right (least significant bit) to left (most significant bit), looking for a search bit value. When the search value is found, the index of that bit (where the most significant bit is index 0) is returned. If “search” is true, the scan will search for the bit value 1. If “search” is false it will search for bit value 0. Requires server version 5.6.0+.
• int_rshift
  Create integer “logical right shift” (>>>) operator. Requires server version 5.6.0+.
• int_val
  Creates 64 bit integer value
• int_xor
  Create integer “xor” (^) operator that is applied to two or more integers. All arguments must resolve to integers. Requires server version 5.6.0+.
• is_tombstone
  Create expression that returns if record has been deleted and is still in tombstone state. This expression usually evaluates quickly because record meta data is cached in memory.
• key
  Create a record key expression of specified type.
• key_exists
  Create function that returns if the primary key is stored in the record meta data as a boolean expression. This would occur when send_key is true on record write.
• last_update
  Create function that returns record last update time expressed as 64 bit integer nanoseconds since 1970-01-01 epoch.
• le
  Create less than or equals (<=) operation.
• list_bin
  Create list bin expression.
• list_val
  Create List bin Value
• lt
  Create less than (<) operation.
• map_bin
  Create map bin expression.
• map_val
  Create Map bin Value
• max
  Create expression that returns the maximum value in a variable number of expressions. All arguments must be the same type (integer or float). Requires server version 5.6.0+.
• min
  Create expression that returns the minimum value in a variable number of expressions. All arguments must be the same type (integer or float). Requires server version 5.6.0+.
• ne
  Create not equal (!=) expression
• nil
  Create a Nil Value
• not
  Create “not” operator expression.
• num_abs
  Create operator that returns absolute value of a number. All arguments must resolve to integer or float. Requires server version 5.6.0+.
• num_add
  Create “add” (+) operator that applies to a variable number of expressions. Return sum of all FilterExpressions given. All arguments must resolve to the same type (integer or float). Requires server version 5.6.0+.
• num_ceil
  Create expression that rounds a floating point number up to the closest integer value. The return type is float. Requires server version 5.6.0+.
• num_div
  Create “divide” (/) operator that applies to a variable number of expressions. If there is only one FilterExpressions, returns the reciprocal for that FilterExpressions. Otherwise, return the first FilterExpressions divided by the product of the rest. All FilterExpressions must resolve to the same type (integer or float). Requires server version 5.6.0+.
• num_floor
  Create expression that rounds a floating point number down to the closest integer value. The return type is float.
• num_log
  Create “log” operator for logarithm of “num” with base “base”. All arguments must resolve to floats. Requires server version 5.6.0+.
• num_mod
  Create “modulo” (%) operator that determines the remainder of “numerator” divided by “denominator”. All arguments must resolve to integers. Requires server version 5.6.0+.
• num_mul
  Create “multiply” (*) operator that applies to a variable number of expressions. Return the product of all FilterExpressions. If only one FilterExpressions is supplied, return that FilterExpressions. All FilterExpressions must resolve to the same type (integer or float). Requires server version 5.6.0+.
• num_pow
  Create “power” operator that raises a “base” to the “exponent” power. All arguments must resolve to floats. Requires server version 5.6.0+.
• num_sub
  Create “subtract” (-) operator that applies to a variable number of expressions. If only one FilterExpressions is provided, return the negation of that argument. Otherwise, return the sum of the 2nd to Nth FilterExpressions subtracted from the 1st FilterExpressions. All FilterExpressions must resolve to the same type (integer or float). Requires server version 5.6.0+.
• or
  Create “or” (||) operator that applies to a variable number of expressions.
• regex_compare
  Create function like regular expression string operation.
• set_name
  Create function that returns record set name string.
• since_update
  Create expression that returns milliseconds since the record was last updated. This expression usually evaluates quickly because record meta data is cached in memory.
• string_bin
  Create string bin expression.
• string_val
  Creates String bin value
• to_float
  Create expression that converts a float to an integer. Requires server version 5.6.0+.
• to_int
  Create expression that converts an integer to a float. Requires server version 5.6.0+.
• ttl
  Create function that returns record expiration time (time to live) in integer seconds.
• unknown
  Create unknown value. Used to intentionally fail an expression. The failure can be ignored with ExpWriteFlags EVAL_NO_FAIL or ExpReadFlags EVAL_NO_FAIL. Requires server version 5.6.0+.
• var
  Retrieve expression value from a variable. Requires server version 5.6.0+.
• void_time
  Create function that returns record expiration time expressed as 64 bit integer nanoseconds since 1970-01-01 epoch.