@aws/dynamodb-expressions

Index

Classes

Type aliases

Functions

Type aliases

AttributeType

AttributeType: "S" | "SS" | "N" | "NS" | "B" | "BS" | "BOOL" | "NULL" | "L" | "M"

ComparisonOperand

ComparisonOperand: AttributePath | AttributeValue | FunctionExpression | any

ConditionExpression

ConditionExpression: SimpleConditionExpression | AndExpression | OrExpression | NotExpression | FunctionExpression

ConditionExpressionPredicate

ConditionExpressionPredicate: EqualityExpressionPredicate | InequalityExpressionPredicate | LessThanExpressionPredicate | LessThanOrEqualToExpressionPredicate | GreaterThanExpressionPredicate | GreaterThanExpressionPredicate | GreaterThanOrEqualToExpressionPredicate | BetweenExpressionPredicate | MembershipExpressionPredicate | FunctionExpressionPredicate

FunctionExpressionPredicate

FunctionExpressionPredicate: AttributeExistsPredicate | AttributeNotExistsPredicate | AttributeTypePredicate | BeginsWithPredicate | ContainsPredicate

MathematicalExpressionOperand

MathematicalExpressionOperand: AttributePath | string | number

PathElement

PathElement: AttributeName | ListIndex

ProjectionExpression

ProjectionExpression: Array<AttributePath | string>

An array of attributes to project. Each may be represented as either an AttributePath object or as a string.

SimpleConditionExpression

SimpleConditionExpression: ConditionExpressionSubject & ConditionExpressionPredicate

Functions

attributeExists

attributeExists(): AttributeExistsPredicate

- Defined in ConditionExpression.ts:173
Returns AttributeExistsPredicate

attributeNotExists

attributeNotExists(): AttributeNotExistsPredicate

- Defined in ConditionExpression.ts:191
Returns AttributeNotExistsPredicate

attributeType

attributeType(expected: AttributeType): AttributeTypePredicate

- Defined in ConditionExpression.ts:210
Parameters
- expected: AttributeType
Returns AttributeTypePredicate

beginsWith

beginsWith(expected: string): BeginsWithPredicate

- Defined in ConditionExpression.ts:229
Parameters
- expected: string
Returns BeginsWithPredicate

between

between(lowerBound: ComparisonOperand, upperBound: ComparisonOperand): BetweenExpressionPredicate

- Defined in ConditionExpression.ts:126
Parameters
- lowerBound: ComparisonOperand
- upperBound: ComparisonOperand
Returns BetweenExpressionPredicate

contains

contains(expected: string): ContainsPredicate

- Defined in ConditionExpression.ts:248
Parameters
- expected: string
Returns ContainsPredicate

equals

equals(operand: ComparisonOperand): EqualityExpressionPredicate

- Defined in ConditionExpression.ts:26
Create an expression predicate asserting that the subject is equal to the predicate.

Parameters
- operand: ComparisonOperand
Returns EqualityExpressionPredicate

greaterThan

greaterThan(operand: ComparisonOperand): GreaterThanExpressionPredicate

- Defined in ConditionExpression.ts:91
Parameters
- operand: ComparisonOperand
Returns GreaterThanExpressionPredicate

greaterThanOrEqualTo

greaterThanOrEqualTo(operand: ComparisonOperand): GreaterThanOrEqualToExpressionPredicate

- Defined in ConditionExpression.ts:108
Parameters
- operand: ComparisonOperand
Returns GreaterThanOrEqualToExpressionPredicate

inList

inList(...operands: Array<ComparisonOperand>): MembershipExpressionPredicate

- Defined in ConditionExpression.ts:146
Parameters
- Rest ...operands: Array<ComparisonOperand>
Returns MembershipExpressionPredicate

isConditionExpression

isConditionExpression(arg: any): boolean

- Defined in ConditionExpression.ts:365
Evaluates whether the provided value is a condition expression.

Parameters
- arg: any
Returns boolean

isConditionExpressionPredicate

isConditionExpressionPredicate(arg: any): boolean

- Defined in ConditionExpression.ts:278
Evaluate whether the provided value is a condition expression predicate.

Parameters
- arg: any
Returns boolean

isConditionExpressionSubject

isConditionExpressionSubject(arg: any): boolean

- Defined in ConditionExpression.ts:318
Parameters
- arg: any
Returns boolean

lessThan

lessThan(operand: ComparisonOperand): LessThanExpressionPredicate

- Defined in ConditionExpression.ts:58
Parameters
- operand: ComparisonOperand
Returns LessThanExpressionPredicate

lessThanOrEqualTo

lessThanOrEqualTo(operand: ComparisonOperand): LessThanOrEqualToExpressionPredicate

- Defined in ConditionExpression.ts:75
Parameters
- operand: ComparisonOperand
Returns LessThanOrEqualToExpressionPredicate

notEquals

notEquals(operand: ComparisonOperand): InequalityExpressionPredicate

- Defined in ConditionExpression.ts:42
Parameters
- operand: ComparisonOperand
Returns InequalityExpressionPredicate

serializeConditionExpression

serializeConditionExpression(condition: ConditionExpression, attributes: ExpressionAttributes): string

- Defined in ConditionExpression.ts:401
Convert the provided condition expression object to a string, escaping any values and attributes to expression-safe placeholders whose expansion value will be managed by the provided ExpressionAttributes object.

Parameters
- condition: ConditionExpression
- attributes: ExpressionAttributes
Returns string

serializeProjectionExpression

serializeProjectionExpression(projection: ProjectionExpression, attributes: ExpressionAttributes): string

- Defined in ProjectionExpression.ts:15
Convert the supplied projection expression to the string format expected by DynamoDB, substituting all attribute paths using the provided ExpressionAttributes object.

Parameters
- projection: ProjectionExpression
- attributes: ExpressionAttributes
Returns string