dynamo-browse/_site/data/scriptmods/item.yaml
Leon Mika bf879a8a78
Some checks failed
ci / Build (push) Successful in 4m9s
Release / Build (push) Successful in 4m14s
Release / Release MacOS (push) Failing after 25s
Release / Site (push) Successful in 1m30s
Fixed MacOS release (#3)
- Fixed MacOS release and moved UCL site into repository

Reviewed-on: #3
Co-authored-by: Leon Mika <lmika@lmika.org>
Co-committed-by: Leon Mika <lmika@lmika.org>
2025-10-26 00:41:24 +00:00

44 lines
1.3 KiB
YAML

module: item
type: type
docs: |
A single record from a DynamoDB table.
Item values are converted to tamarin types using the following:
| Attribute Type | Tamarin Type |
|:---------------|:-------------|
| S | string |
| N | int, float \[1\] |
| BOOL | bool |
| NULL | nil |
| L | list |
| M | map |
| SS | set, with string values |
| NS | set, with number values |
Notes:
- \[1\]: int will be used if the value can be parsed as an integer, otherwise it will be returned as a float.
- Byte array (B or BS) values are currently not supported.
symbols:
- name: resultset
syntax: item.resultset
docs: |
Returns the result-set this item is a member of.
- name: index
syntax: item.index
docs: |
Returns the index of this item within the result set.
- name: attr
syntax: item.attr(expression)
docs: |
Returns the attribute value from the query expression.
- name: set_attr
syntax: item.set_attr(expression, value)
docs: |
Sets the value of the attribute.
- name: delete_attr
syntax: item.delete_attr(expression)
docs: |
Delete the attribute.