Exp Class

Aerospike
Expression generator.
Inheritance Hierarchy

SystemObject
  Aerospike.ClientExp

Namespace:  Aerospike.Client
Assembly:  AerospikeClient (in AerospikeClient.dll) Version: 5.1.1.0 (5.1.1)
Syntax

C#
public abstract class Exp

The Exp type exposes the following members.

Methods

  NameDescription
Public methodStatic memberCode exampleAbs
Create operator that returns absolute value of a number. All arguments must resolve to integer or float. Requires server version 5.6.0+.
Public methodStatic memberCode exampleAdd
Create "add" (+) operator that applies to a variable number of expressions. Return sum of all arguments. All arguments must resolve to the same type (integer or float). Requires server version 5.6.0+.
Public methodStatic memberCode exampleAnd
Create "and" operator that applies to a variable number of expressions.
Public methodStatic memberCode exampleARshift
Create integer "arithmetic right shift" (>>) operator. Requires server version 5.6.0+.
Public methodStatic memberCode exampleBin
Create bin expression of specified type.
Public methodStatic memberCode exampleBinExists
Create expression that returns if bin of specified name exists.
Public methodStatic memberCode exampleBinType
Create expression that returns bin's integer particle type. See ParticleType.
Public methodStatic memberCode exampleBlobBin
Create byte[] bin expression.
Public methodStatic memberCode exampleBoolBin
Create boolean bin expression.
Public methodStatic memberBuild
Create final expression that contains packed byte instructions used in the wire protocol.
Public methodStatic memberCode exampleCeil
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+.
Public methodStatic memberCode exampleCond
Conditionally select an expression from a variable number of expression pairs followed by default expression action. Requires server version 5.6.0+.
Public methodStatic memberCode exampleCount
Create expression that returns count of integer bits that are set to 1. Requires server version 5.6.0+.
Public methodStatic memberCode exampleDef
Public methodStatic memberCode exampleDeviceSize
Create expression that returns record size on disk. If server storage-engine is memory, then zero is returned. This expression usually evaluates quickly because record meta data is cached in memory.
Public methodStatic memberCode exampleDigestModulo
Create expression that returns record digest modulo as integer. This expression usually evaluates quickly because record meta data is cached in memory.
Public methodStatic memberCode exampleDiv
Create "divide" (/) operator that applies to a variable number of expressions. If there is only one argument, returns the reciprocal for that argument. Otherwise, return the first argument divided by the product of the rest. All arguments must resolve to the same type (integer or float). Requires server version 5.6.0+.
Public methodStatic memberCode exampleEQ
Create "equals" expression.
Public methodStatic memberCode exampleExclusive
Create expression that returns true if only one of the expressions are true. Requires server version 5.6.0+.
Public methodStatic memberCode exampleExpr
Merge precompiled expression into a new expression tree. Useful for storing common precompiled expressions and then reusing these expressions as part of a greater expression.
Public methodStatic memberCode exampleFloatBin
Create 64 bit float bin expression.
Public methodStatic memberCode exampleFloor
Create expression that rounds a floating point number down to the closest integer value. The return type is float. Requires server version 5.6.0+.
Public methodStatic memberCode exampleGE
Create "greater than or equal" operation.
Public methodStatic memberGeo
Create geospatial json string value.
Public methodStatic memberCode exampleGeoBin
Create geospatial bin expression.
Public methodStatic memberCode exampleGeoCompare
Create compare geospatial operation.
Public methodStatic memberCode exampleGT
Create "greater than" operation.
Public methodStatic memberCode exampleHLLBin
Create hll bin expression.
Public methodStatic memberCode exampleIntAnd
Create integer "and" (&) operator that is applied to two or more integers. All arguments must resolve to integers. Requires server version 5.6.0+.
Public methodStatic memberCode exampleIntBin
Create 64 bit integer bin expression.
Public methodStatic memberCode exampleIntNot
Create integer "not" (~) operator. Requires server version 5.6.0+.
Public methodStatic memberCode exampleIntOr
Create integer "or" (|) operator that is applied to two or more integers. All arguments must resolve to integers. Requires server version 5.6.0+.
Public methodStatic memberCode exampleIntXor
Create integer "xor" (^) operator that is applied to two or more integers. All arguments must resolve to integers. Requires server version 5.6.0+.
Public methodStatic memberCode exampleIsTombstone
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.
Public methodStatic memberCode exampleKey
Create record key expression of specified type.
Public methodStatic memberCode exampleKeyExists
Create expression that returns if the primary key is stored in the record meta data as a boolean expression. This would occur when sendKey is true on record write. This expression usually evaluates quickly because record meta data is cached in memory.
Public methodStatic memberCode exampleLastUpdate
Create expression that returns record last update time expressed as 64 bit integer nanoseconds since 1970-01-01 epoch. This expression usually evaluates quickly because record meta data is cached in memory.
Public methodStatic memberCode exampleLE
Create "less than or equal" operation.
Public methodStatic memberCode exampleLet
Define variables and expressions in scope. Requires server version 5.6.0+.
Public methodStatic memberCode exampleListBin
Create list bin expression.
Public methodStatic memberCode exampleLog
Create "log" operator for logarithm of "num" with base "base". All arguments must resolve to floats. Requires server version 5.6.0+.
Public methodStatic memberCode exampleLscan
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+.
Public methodStatic memberCode exampleLshift
Create integer "left shift" (<<) operator. Requires server version 5.6.0+.
Public methodStatic memberCode exampleLT
Create "less than" operation.
Public methodStatic memberCode exampleMapBin
Create map bin expression.
Public methodStatic memberCode exampleMax
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+.
Public methodStatic memberCode exampleMemorySize
Create expression that returns record size in memory. If server storage-engine is not memory nor data-in-memory, then zero is returned. This expression usually evaluates quickly because record meta data is cached in memory.

Requires server version 5.3.0+

Public methodStatic memberCode exampleMin
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+.
Public methodStatic memberCode exampleMod
Create "modulo" (%) operator that determines the remainder of "numerator" divided by "denominator". All arguments must resolve to integers. Requires server version 5.6.0+.
Public methodStatic memberCode exampleMul
Create "multiply" (*) operator that applies to a variable number of expressions. Return the product of all arguments. If only one argument is supplied, return that argument. All arguments must resolve to the same type (integer or float). Requires server version 5.6.0+.
Public methodStatic memberCode exampleNE
Create "not equal" expression
Public methodStatic memberNil
Create nil value.
Public methodStatic memberCode exampleNot
Create "not" operator expression.
Public methodStatic memberCode exampleOr
Create "or" operator that applies to a variable number of expressions.
Public methodPack
Public methodStatic memberCode examplePow
Create "power" operator that raises a "base" to the "exponent" power. All arguments must resolve to floats. Requires server version 5.6.0+.
Public methodStatic memberCode exampleRegexCompare
Create expression that performs a regex match on a string bin or string value expression.
Public methodStatic memberCode exampleRscan
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+.
Public methodStatic memberCode exampleRshift
Create integer "logical right shift" (>>>) operator. Requires server version 5.6.0+.
Public methodStatic memberCode exampleSetName
Create expression that returns record set name string. This expression usually evaluates quickly because record meta data is cached in memory.
Public methodStatic memberCode exampleSinceUpdate
Create expression that returns milliseconds since the record was last updated. This expression usually evaluates quickly because record meta data is cached in memory.
Public methodStatic memberCode exampleStringBin
Create string bin expression.
Public methodStatic memberCode exampleSub
Create "subtract" (-) operator that applies to a variable number of expressions. If only one argument is provided, return the negation of that argument. Otherwise, return the sum of the 2nd to Nth argument subtracted from the 1st argument. All arguments must resolve to the same type (integer or float). Requires server version 5.6.0+.
Public methodStatic memberCode exampleToFloat
Create expression that converts an integer to a float. Requires server version 5.6.0+.
Public methodStatic memberCode exampleToInt
Create expression that converts a float to an integer. Requires server version 5.6.0+.
Public methodStatic memberCode exampleTTL
Create expression that returns record expiration time (time to live) in integer seconds. This expression usually evaluates quickly because record meta data is cached in memory.
Public methodStatic memberCode exampleUnknown
Create unknown value. Used to intentionally fail an expression. The failure can be ignored with EVAL_NO_FAIL or EVAL_NO_FAIL Requires server version 5.6.0+.
Public methodStatic memberVal(Boolean)
Create boolean value.
Public methodStatic memberVal(Byte)
Create blob byte[] value.
Public methodStatic memberVal(DateTime)
Create Calendar value expressed in nanoseconds since 1970-01-01 epoch as 64 bit integer.
Public methodStatic memberVal(Double)
Create 64 bit floating point value.
Public methodStatic memberVal(IDictionary)
Create map value.
Public methodStatic memberVal(IList)
Create list value.
Public methodStatic memberVal(Int64)
Create 64 bit integer value.
Public methodStatic memberVal(String)
Create string value.
Public methodStatic memberVal(UInt64)
Create 64 bit unsigned integer value.
Public methodStatic memberCode exampleVar
Retrieve expression value from a variable. Requires server version 5.6.0+.
Public methodStatic memberCode exampleVoidTime
Create expression that returns record expiration time expressed as 64 bit integer nanoseconds since 1970-01-01 epoch. This expression usually evaluates quickly because record meta data is cached in memory.
Top
Fields

  NameDescription
Public fieldStatic memberMODIFY
Top
See Also

Reference