Quick reference
Operation summary
Map operations
| Operation | Description | Use case |
|---|---|---|
MapPutOp | Put single key-value | Update one field |
MapPutItemsOp | Put multiple key-values | Initialize or bulk update |
MapGetByKeyOp | Get value by key | Most common: retrieve value |
MapGetByKeyListOp | Get multiple values | Batch retrieval |
MapGetByKeyRangeOp | Get by key range | Range queries |
MapIncrementOp | Increment value | Counters, scores |
MapDecrementOp | Decrement value | Inventory, counters |
MapRemoveByKeyOp | Remove by key | Delete field |
MapSizeOp | Get map size | Count items |
List operations
| Operation | Description | Use case |
|---|---|---|
ListAppendOp | Append items | Add to end |
ListInsertOp | Insert at index | Add at position |
ListGetOp | Get by index | Retrieve item |
ListGetRangeOp | Get range | Get multiple items |
ListPopOp | Pop item | Queue processing |
ListRemoveOp | Remove by index | Delete item |
ListSizeOp | Get list size | Count items |
Return type quick reference
Map return types
VALUE: The actual value (most common)KEY: The key itselfKEY_VALUE: Both key and value as MapPairINDEX: Index position (ordered maps)RANK: Rank by valueCOUNT: Number of items (1 or 0)EXISTS: Boolean existence check
List return types
VALUE: The actual valueINDEX: Index position(s)RANK: Rank by valueCOUNT: Number of itemsEXISTS: 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 keyCtxListIndex(index): Navigate to list by indexCtxMapRank(rank): Navigate to map by rankCtxListRank(rank): Navigate to list by rank
For a complete list of all available context helper functions, refer to the API documentation.