Skip to content

Quick reference

Operation summary

Map operations

OperationDescriptionUse case
MapPutOpPut single key-valueUpdate one field
MapPutItemsOpPut multiple key-valuesInitialize or bulk update
MapGetByKeyOpGet value by keyMost common: retrieve value
MapGetByKeyListOpGet multiple valuesBatch retrieval
MapGetByKeyRangeOpGet by key rangeRange queries
MapIncrementOpIncrement valueCounters, scores
MapDecrementOpDecrement valueInventory, counters
MapRemoveByKeyOpRemove by keyDelete field
MapSizeOpGet map sizeCount items

List operations

OperationDescriptionUse case
ListAppendOpAppend itemsAdd to end
ListInsertOpInsert at indexAdd at position
ListGetOpGet by indexRetrieve item
ListGetRangeOpGet rangeGet multiple items
ListPopOpPop itemQueue processing
ListRemoveOpRemove by indexDelete item
ListSizeOpGet list sizeCount items

Return type quick reference

Map return types

  • VALUE: The actual value (most common)
  • KEY: The key itself
  • KEY_VALUE: Both key and value as MapPair
  • INDEX: Index position (ordered maps)
  • RANK: Rank by value
  • COUNT: Number of items (1 or 0)
  • EXISTS: Boolean existence check

List return types

  • VALUE: The actual value
  • INDEX: Index position(s)
  • RANK: Rank by value
  • COUNT: Number of items
  • EXISTS: Boolean existence check

Context helper functions

The following are commonly used context helper functions for navigating nested CDT structures. There are additional helper functions available beyond these basic ones:

  • CtxMapKey(key): Navigate to map by key
  • CtxListIndex(index): Navigate to list by index
  • CtxMapRank(rank): Navigate to map by rank
  • CtxListRank(rank): Navigate to list by rank

For a complete list of all available context helper functions, refer to the API documentation.

Feedback

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?