DynamoDbQueryStatement

DynamoDbQueryStatement

new DynamoDbQueryStatement(opt)

SQL-ish Query statement class for AWS DynamoDB.

SQL-ish Syntax:

[SELECT <projection-expression>]
FROM <table-name>
WHERE <key-condition-expression>
[FILTER <filter-expression>]
[LIMIT <limit>]
  • [] is representing that can be ommited.
  • <projection-expression> - The comma separated attribute names to select.
  • <table-name> - DynamoDB table name.
  • <key-condition-expression> - Primary key conditional expression.
  • <filter-expression> - Filtering conditional expression.
  • <limit> - The number of items to scan.
Source:
Parameters:
Name Type Description
opt string | object

SQL-ish Query statement as string or parameter object for Query API.

Methods

getParameter(args) → {object}

Get parameter to invoke the query API.

Source:
Parameters:
Name Type Description
args object

key-values for the expression to run the query.
Returns:
Type:
object

A parameter for DynamoDB query API.

parse(sqlish) → {object}

Parse the SQL-ish statement.

Source:
Parameters:
Name Type Description
sqlish string

SQL-ish statement
Returns:
Type:
object

A parameter for DynamoDB query API.

setFilterExpression(filterExpr) → {undefined}

Set FilterExpression for query.

Source:
Parameters:
Name Type Description
filterExpr string

expression
Returns:
Type:
undefined

setKeyConditionExpression(keyConditionExpr) → {undefined}

Set KeyConditionExpression for query.

Source:
Parameters:
Name Type Description
keyConditionExpr string

expression
Returns:
Type:
undefined