SQL Like query builder for dynamodb.
SQL Like Query interface for better code readability.
- Supports
select,scanandcountoperations - Supports selecting specific columns
- Supports Hash Keys and Range Keys
- Supports Filters
- Supports various operations for Range Keys and Filters
- Supports Pagination and limiting results.
- Automatically handles reserved and special character attribute names by using
ExpressionAttributeNames - Supports querying on Indexes, with optional scan direction
- Well Tested: Unit tests + Integration Tests (using
jest-dynamodb). - Supports returning Consumed Capacity from dynamodb
See tests for all the features that are supported, and examples on how to use them.
NPM Package: @jspreddy/torq
npm install @jspreddy/torqimport { Index, Table, Query, Operation, DdbType } from '@jspreddy/torq';const myTable = new Table('some-table-name', 'pk', 'sk');
const x = new Query(myTable);
x.select(['asdf', 'pqrs'])
.where.hash.eq('aasdf')
.where.range.eq('1235:238h9084')
.filter.eq('flower', 'rose')
.filter.eq('isPolinated', true)
.limit(10);
// Convert to object that can be used with dynamodb client.
console.log(x.toDynamo());This is what x.toDynamo() returns.
{
TableName: 'some-table-name',
Limit: 10,
ProjectionExpression: "asdf, pqrs",
KeyConditionExpression: "pk = :pk and sk = :sk",
FilterExpression: "flower = :flower and isPolinated = :isPolinated",
ExpressionAttributeValues: {
":pk": 'aasdf',
':sk': '1235:238h9084',
':flower': 'rose',
':isPolinated': true,
},
}const table = new Table('some-table-name', '_friend', '_best');
const x = new Query(table);
// query builder
x.select(['asdf', 'pqrs'])
.where.hash.eq('ramana')
.where.range.eq('bestie')
.filter.eq('_test', true)
.filter.eq('__test', 'stop!');
// log the result
console.log(x.toDynamo());This is the resulting dynamo query.
{
TableName: 'some-table-name',
Limit: 25,
ProjectionExpression: "asdf, pqrs",
KeyConditionExpression: "#_friend = :_friend and #_best = :_best",
FilterExpression: "#_test = :_test and #__test = :__test",
ExpressionAttributeNames: {
'#_friend': '_friend',
'#_best': '_best',
'#_test': '_test',
'#__test': '__test',
},
ExpressionAttributeValues: {
':_friend': 'ramana',
':_best': 'bestie',
':_test': true,
':__test': 'stop!',
},
}See the section on
"Reserved & Special Char Names"in unit tests for more examples.
See tests for all the features that are supported, and examples on how to use them.
Docs for referencing while building this library.
-
TODO: Provide an interface to run the dynamodb operations (Query, Scan).
-
TODO: Add recursive ddb query/scan to fill the requested limit.
-
TODO: Add support for parallel scans. https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan
-
TODO: Add support for easy ttl operations. https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html