Class UpdateExpression

An object representing a DynamoDB update expression.

Hierarchy

UpdateExpression

Implements

AttributeBearingExpression

Index

Properties

Methods

Properties

toAdd

toAdd: Map<AttributePath, any> = new Map<AttributePath, any>()

toDelete

toDelete: Map<AttributePath, any> = new Map<AttributePath, any>()

toRemove

toRemove: Set<AttributePath> = new Set<AttributePath>()

toSet

toSet: Map<AttributePath, any> = new Map<AttributePath, any>()

Methods

add

add(path: AttributePath | string, value: any): void

- Defined in UpdateExpression.ts:20
Add a directive to the expression's add clause.

Parameters
- path: AttributePath | string
- value: any
Returns void

delete

delete(path: AttributePath | string, value: any): void

- Defined in UpdateExpression.ts:30
Add a directive to the expression's delete clause.

Parameters
- path: AttributePath | string
- value: any
Returns void

remove

remove(path: AttributePath | string): void

- Defined in UpdateExpression.ts:40
Add a directive to the expression's remove clause.

Parameters
- path: AttributePath | string
Returns void

serialize

serialize(attributes: ExpressionAttributes): string

Implementation of AttributeBearingExpression.serialize
- Defined in UpdateExpression.ts:59
Parameters
- attributes: ExpressionAttributes
Returns string

set

set(path: AttributePath | string, value: AttributeValue | FunctionExpression | MathematicalExpression | any): void

- Defined in UpdateExpression.ts:49
Add a directive to the expression's set clause.

Parameters
- path: AttributePath | string
- value: AttributeValue | FunctionExpression | MathematicalExpression | any
Returns void