class Amazonite::DynamoDB::Update

Overview

Represents a request to perform an UpdateItem operation.

Included Modules

Defined in:

dynamodb/update.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(key : Hash(String, AttributeValue), update_expression : String, table_name : String, condition_expression : String | Nil = nil, expression_attribute_names : Hash(String, String) | Nil = nil, expression_attribute_values : Hash(String, AttributeValue) | Nil = nil, return_values_on_condition_check_failure : ReturnValuesOnConditionCheckFailure | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def condition_expression : String | Nil #

A condition that must be satisfied in order for a conditional update to succeed.


[View source]
def condition_expression=(condition_expression : String | Nil) #

A condition that must be satisfied in order for a conditional update to succeed.


[View source]
def expression_attribute_names : Hash(String, String) | Nil #

One or more substitution tokens for attribute names in an expression.


[View source]
def expression_attribute_names=(expression_attribute_names : Hash(String, String) | Nil) #

One or more substitution tokens for attribute names in an expression.


[View source]
def expression_attribute_values : Hash(String, AttributeValue) | Nil #

One or more values that can be substituted in an expression.


[View source]
def expression_attribute_values=(expression_attribute_values : Hash(String, AttributeValue) | Nil) #

One or more values that can be substituted in an expression.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def key : Hash(String, AttributeValue) #

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.


[View source]
def key=(key : Hash(String, AttributeValue)) #

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.


[View source]
def return_values_on_condition_check_failure : ReturnValuesOnConditionCheckFailure | Nil #

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.


[View source]
def return_values_on_condition_check_failure=(return_values_on_condition_check_failure : ReturnValuesOnConditionCheckFailure | Nil) #

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.


[View source]
def table_name : String #

Name of the table for the UpdateItem request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.


[View source]
def table_name=(table_name : String) #

Name of the table for the UpdateItem request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.


[View source]
def update_expression : String #

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.


[View source]
def update_expression=(update_expression : String) #

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.


[View source]
def validate! : Nil #

[View source]