Skip to main content
Loading

Record Storage Data

Returns the value from storage (such as bin data or the records key).

bin_blob

Introduced: 5.2.0.4

bin_blob(name)

Retrieve the bin with the name indicated by name as a blob_bin. Return unknown if the bin does not exist or the bin is a different type.

Arguments:
  • name (string_value)

Returns: (blob_bin)

bin_exists

Introduced: 5.2.0.4

bin_exists(name)

Returns true if a bin exists on the record with the name indicated by name, otherwise returns unknown.

Arguments:
  • name (string_value)

Returns: (boolean_value)

bin_float

Introduced: 5.2.0.4

bin_float(name)

Retrieve the bin with the name indicated by name as a float_bin. Return unknown if the bin does not exist or the bin is a different type.

Arguments:
  • name (string_value)

Returns: (float_bin)

bin_geo

Introduced: 5.2.0.4

bin_geo(name)

Retrieve the bin with the name indicated by name as a geojson_bin. Return unknown if the bin does not exist or the bin is a different type.

Arguments:
  • name (string_value)

Returns: (geojson_bin)

bin_hll

Introduced: 5.2.0.4

bin_hll(name)

Retrieve the bin with the name indicated by name as a hll_bin. Return unknown if the bin does not exist or the bin is a different type.

Arguments:
  • name (string_value)

Returns: (hll_bin)

bin_int

Introduced: 5.2.0.4

bin_int(name)

Retrieve the bin with the name indicated by name as a integer_bin. Return unknown if the bin does not exist or the bin is a different type.

Arguments:
  • name (string_value)

Returns: (integer_bin)

bin_list

Introduced: 5.2.0.4

bin_list(name)

Retrieve the bin with the name indicated by name as a list_bin. Return unknown if the bin does not exist or the bin is a different type.

Arguments:
  • name (string_value)

Returns: (list_bin)

bin_map

Introduced: 5.2.0.4

bin_map(name)

Retrieve the bin with the name indicated by name as a map_bin. Return unknown if the bin does not exist or the bin is a different type.

Arguments:
  • name (string_value)

Returns: (map_bin)

bin_str

Introduced: 5.2.0.4

bin_str(name)

Retrieve the bin with the name indicated by name as a string_bin. Return unknown if the bin does not exist or the bin is a different type.

Arguments:
  • name (string_value)

Returns: (string_bin)

bin_type

Introduced: 5.2.0.4

bin_type(name)

Retrieve the data type of the bin with the name indicated by name in ParticleType format. Return unknown if the bin does not exist.

The following list shows each bin ParticleType and its associated integer value:

NULL: 0

INTEGER: 1

DOUBLE: 2

STRING: 3

BLOB: 4

JBLOB: 7

BOOL: 17

HLL: 18

MAP: 19

LIST: 20

GEOJSON: 23

Arguments:
  • name (string_value)

Returns: (ParticleType)

key_blob

Introduced: 5.2.0.4

key_blob()

Retrieve the key as a blob/bytes. Return unknown if the key does not exist or the key is a different type.

Returns: (blob_value)

key_int

Introduced: 5.2.0.4

key_int()

Retrieve the key as a integer. Return unknown if the key does not exist or the key is a different type.

Returns: (integer_value)

key_str

Introduced: 5.2.0.4

key_str()

Retrieve the key as a string. Return unknown if the key does not exist or the key is a different type.

Returns: (string_value)