Skip to content
Dynamo Document Builder
Search
Ctrl
K
Cancel
GitHub
Quick Start
Getting Started
Defining Entities
Reads and Writes
Guides
Tables
Entities
Commands
Get
Put
Update
Delete
Query
Scan
Advanced
Conditions
Batching
Transactions
Utilities
Attribute Expression Map
Parsers
Examples
Classic To-dos
API Reference
Classes
AttributeExpressionMap
BatchGet
BatchProjectedGet
BatchWrite
ConditionalDelete
ConditionalPut
ConditionalUpdate
ConditionCheck
Delete
DocumentBuilderError
DynamoEntity
DynamoTable
Get
ProjectedGet
ProjectedQuery
ProjectedScan
Put
Query
Scan
TransactGet
TransactWrite
Update
Type Aliases
AddExpression
AddToSetExpression
AppendExpression
AttributeNamePlaceholder
AttributeNames
AttributeValuePlaceholder
AttributeValues
BaseCommand
BaseConfig
BasePaginatable
BaseResult
BatchGetConfig
BatchGetResult
BatchProjectedGetConfig
BatchProjectedGetResult
BatchWriteConfig
BatchWriteResult
BeginsWithExpression
BeginsWithExpressionTemplate
BetweenExpression
BetweenExpressionTemplate
BooleanExpression
ComparisonExpression
ComparisonExpressionTemplate
ComparisonOperator
Condition
ConditionalDeleteConfig
ConditionalDeleteResult
ConditionalPutConfig
ConditionalPutResult
ConditionalUpdateConfig
ConditionalUpdateResult
ConditionCheckConfig
ConditionExpression
ConditionExpressionTemplate
ConditionParserResult
ConditionTemplate
ContainsExpression
ContainsExpressionTemplate
DeleteConfig
DeleteExpression
DeleteResult
DynamoAttributeExpression
DynamoAttributeType
DynamoEntityConfig
DynamoIndexKey
DynamoIndexKeyableValue
DynamoIndexKeyBuilder
DynamoKey
DynamoKeyableValue
DynamoKeyBuilder
DynamoTableConfig
EncodedEntity
EncodedEntitySchema
Entity
EntityKeyInput
EntitySchema
ExistsExpression
ExistsExpressionTemplate
FunctionExpression
GetConfig
GetResult
GlobalSecondaryIndexKeyBuilders
GlobalSecondaryIndexKeyName
IndexName
InExpression
InExpressionTemplate
LocalSecondaryIndexKeyBuilders
LocalSecondaryIndexKeyName
LogicalExpression
LogicalOperator
NamedGlobalSecondaryIndexKeyNames
NamedLocalSecondaryIndexKeyNames
NotExpression
Operand
PrependExpression
ProjectedGetConfig
ProjectedGetResult
ProjectedQueryConfig
ProjectedQueryResult
ProjectedScanConfig
ProjectedScanResult
Projection
ProjectionResult
PutConfig
PutResult
QueryConfig
QueryResult
RemoveExpression
ScanConfig
ScanResult
SizeConditionExpression
SizeConditionExpressionTemplate
SizeExpression
SubtractExpression
TemplateExpression
TransactGetConfig
TransactGetResult
TransactWriteConfig
TransactWriteOperation
TransactWriteResult
TypeCheckExpression
TypeCheckExpressionTemplate
UpdateConfig
UpdateExpression
UpdateParserResult
UpdateResult
UpdateType
UpdateValues
ValueExpression
ValueReference
WriteTransactable
Functions
add
addToSet
and
append
beginsWith
between
contains
equals
exists
greaterThan
greaterThanOrEqual
indexKey
isIn
key
lessThan
lessThanOrEqual
not
notEquals
notExists
or
parseCondition
parseProjection
parseUpdate
prepend
ref
remove
removeFromSet
size
subtract
typeIs
LLMs
GitHub
Projection
type
Projection
=
string
[];
Type representing a DynamoDB projection (list of attribute names).
