Interface UpdateOptions

interface UpdateOptions {
    conditionExpression?: string;
    expressionAttributeNames?: Record<string, string>;
    expressionAttributeValues?: DynamoDBValues;
    ttl?: number;
    ttlInFutureDays?: number;
    update?: {
        add?: string;
        delete?: string;
        remove?: string;
        set?: string;
    };
}

Properties

conditionExpression? expressionAttributeNames? expressionAttributeValues? ttl? ttlInFutureDays? update?

Properties

OptionalconditionExpression

conditionExpression?: string

DynamoDB Condition Expression

See

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html

Default

No condition set

OptionalexpressionAttributeNames

expressionAttributeNames?: Record<string, string>

DynamoDB Expression Attribute Names for Update and/or Condition Expression

See

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html

Default

No names set

OptionalexpressionAttributeValues

expressionAttributeValues?: DynamoDBValues

DynamoDB Expression Attribute Values for Update and/or Condition Expression

See

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeValues.html

Default

No values set

Optionalttl

ttl?: number

Absolute TTL value on record, if TTL attribute configured for table

See

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/howitworks-ttl.html

Default

No TTL set, unless ttlInFutureDays is set

OptionalttlInFutureDays

ttlInFutureDays?: number

Sets TTL value on record with a relative value - now + number of days in the future If the ttl attribute is set then this value is ignored DynamoDB only guarantees TTL cleanup precision within a few days, so more precision here is unnecessary

See

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/howitworks-ttl.html

Default

No TTL set, unless ttl is set

Optionalupdate

update?: {
    add?: string;
    delete?: string;
    remove?: string;
    set?: string;
}

Update Expression, with each of the 4 possible clauses broken out

See

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.UpdateExpressions.html

Default

No update expression set. This is only valid if the update is only used for updating the TTL value

Settings

Member Visibility

On This Page

Properties