Class Context

constructor

• new Context(): Context

• Returns Context

items

addListIndex

• addListIndex(index): Context

• Lookup list by index offset.

  Parameters

  • index: number

    List index

  Returns Context

  Updated CDT context, so calls can be chained.

  Remarks

  If the index is negative, the resolved index starts backwards from end of list. If an index is out of bounds, a parameter error will be returned. Examples:

  • 0: First item.
  • 4: Fifth item.
  • -1: Last item.
  • -3: Third to last item.

addListIndexCreate

• addListIndexCreate(index, order?, pad?): Context

• Lookup list by base list's index offset.

  Parameters

  • index: number

    List index
  • Optionalorder: lists.order

    Sort order used if a list is created
  • Optionalpad: boolean

    Pads list entries between index and the final list entry with zeros.

  Returns Context

  Updated CDT context, so calls can be chained.

  Remarks

  If the list at index offset is not found, create it with the given sort order at that index offset. If pad is true and the index offset is greater than the bounds of the base list, nil entries will be inserted before the newly created list.

addListRank

• addListRank(rank): Context

• Lookup list by rank.

  Parameters

  • rank: number

    List rank

  Returns Context

  Updated CDT context, so calls can be chained.

  Remarks

  Examples:

  • 0 = smallest value
  • N = Nth smallest value
  • -1 = largest value

addListValue

• addListValue(value): Context

• Lookup list by value.

  Parameters

  • value: AerospikeBinValue

    List value

  Returns Context

  Updated CDT context, so calls can be chained.

addMapIndex

• addMapIndex(index): Context

• Lookup map by index offset.

  Parameters

  • index: number

    Map index

  Returns Context

  Updated CDT context, so calls can be chained.

  Remarks

  If the index is negative, the resolved index starts backwards from end of list. If an index is out of bounds, a parameter error will be returned. Examples:

  • 0: First item.
  • 4: Fifth item.
  • -1: Last item.
  • -3: Third to last item.

addMapKey

• addMapKey(key): Context

• Lookup map by key.

  Parameters

  • key: string

    Map key

  Returns Context

  Updated CDT context, so calls can be chained.

addMapKeyCreate

• addMapKeyCreate(key, order?): Context

• Lookup map by base map's key. If the map at key is not found, create it with the given sort order at that key.

  Parameters

  • key: string

    Map key
  • Optionalorder: maps.order

    Sort order used if a map is created

  Returns Context

  Updated CDT context, so calls can be chained.

addMapRank

• addMapRank(rank): Context

• Lookup map by rank.

  Parameters

  • rank: number

    Map rank

  Returns Context

  Updated CDT context, so calls can be chained.

  Remarks

  Examples:

  • 0 = smallest value
  • N = Nth smallest value
  • -1 = largest value

addMapValue

• addMapValue(value): Context

• Lookup map by value.

  Parameters

  • value: AerospikeBinValue

    Map value

  Returns Context

  Updated CDT context, so calls can be chained.

StaticgetContextType

• getContextType(ctx, type):
      | number
      | NIL
      | STR
      | LIST
      | MAP
      | BLOB
      | FLOAT
      | GEOJSON
      | HLL
      | AUTO
      | ERROR

• Retrieve expression type list/map from ctx or from type.

  Parameters

  • ctx: Context

    ctx value object.
  • type: number

    exp.type default expression type.

  Returns
      | number
      | NIL
      | STR
      | LIST
      | MAP
      | BLOB
      | FLOAT
      | GEOJSON
      | HLL
      | AUTO
      | ERROR

  exp.type expression type.