Statement

Statement

new Statement()

Statement class

Source:

Methods

(static) assertAllParamSpecified(param) → {undefined}

Assert that all attribute values are specified.

Source:
Parameters:
Name Type Description
param object

K-V which has an attribute name to the value

Returns:
Type:
undefined

(static) setParam(param, args) → {object}

Set arguments to param.

Source:
Parameters:
Name Type Description
param object

API parameter

args object

Key-Value. Attribute name to value.

Returns:
Type:
object

result param. It is clone of the input param.

getParameter(args) → {object}

Get a parameter as a result of this statement instance. It is available to execute the DynamoDB API.

Source:
Parameters:
Name Type Description
args object

K-V which is an attribute name to the value.

Returns:
Type:
object

A parameter for the DynamoDB API.

parseConditionExpression(conditionExpr) → {string}

Parse ConditionExpression and translate the expr to use placeholders. The attribute names or values are added to expressionAttributeNames/Values.

Source:
Parameters:
Name Type Description
conditionExpr string

Expression

Returns:
Type:
string

A translated expression. It might include placeholders.

run() → {undefined}

Run this statement.

Source:
Returns:
Type:
undefined

setTableName(tableName) → {undefined}

Set table name.

Source:
Parameters:
Name Type Description
tableName string

A table name

Returns:
Type:
undefined