squidfunk / isotopes

Serverless and typed object store built on top of AWS SimpleDB

Isotopes

A serverless, typed and super lightweight object store that enables storage, indexing and querying of JSON documents in AWS SimpleDB using SQL queries. Isotopes is just perfect for small to medium-sized datasets, especially for indexing metadata from other AWS services for flexible querying. It can easily be run from within AWS Lambda and reduces the boilerplate that is necessary to interface with SimpleDB to an absolute minimum.

Quick start

npm install isotopes aws-sdk

In your project:

import { Isotope } from "isotopes"

const isotope = new Isotope<T>({
  domain: "<domain>",
  key: "<keyof T>"
})

For detailed instructions see the getting started guide and the API reference guide.

License

MIT License

Copyright (c) 2018-2020 Martin Donath

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

isotopes's Issues

Add region and endpoint additional config to readme

Great library! It might be useful in the docs to show how to configure the library, as follows:

   const seasons = new Isotope<Season>({
    domain: "seasons",                     
    key: "id"                            
  }, { region 		: 'US-East',
  endpoint 	: 'https://sdb.amazonaws.com'} );

Without this additional config, I couldn't get things working...

Get count of records

Description

No obvious ways to get a count of records matching some criteria using Isotope

Expected behavior

A method that would allow someone to call the equivalent of select count(*) where ...; obviously restricted to the type of record

see https://docs.aws.amazon.com/AmazonSimpleDB/latest/DeveloperGuide/CountingDataSelect.html

eg I was thinking something along the lines of

const expr = isotope
    .getQueryBuilder()
    .where('`active` = ? and `submitDate` >= ?', true, startDate);

const total = await isotope.count(expr);

Actual behavior

As far as I can tell, I would need to pull all the items to get a count which seems wasteful.

Package versions

• isotopes: 0.6.1
• aws-sdk: 2.987.0

SimpleDB deprecation

Description

As titled, simpleDB in aws is deprecated and not available in most of cases (new regions or new accounts). While this project looks young still, should it be bump to any current available alternative like DynamoDB?

Expected behavior

Document updates and new release (could be a breaking change one)

Incorrect documentation for query a domain

Description

In the docs for Isotope the example for a query is

const expr = tasks.getQueryBuilder()
  .where("`active` = ?", true)
  .order("`props.memory >= ?`", 2048)
  .limit(100)

This is incorrect as you do not order by a predicate.

Expected behavior

it should possibly be

const expr = tasks.getQueryBuilder()
  .where("`active` = ?", true)
  .order("`props.memory`", 'asc')
  .limit(100)

however, when you try the above you will get an error like this

INFO InvalidSortExpression: Invalid sort expression. The sort attribute must be present in at least one of the predicates, and the predicate cannot contain the is null operator.

to make it work you need to add another predicate eg

const expr = tasks.getQueryBuilder()
  .where("`active` = ? and `props.memory` > ? ", true, 0)
  .order("`props.memory`", 'asc')
  .limit(100)

PS. thanks for the library - I moved from DynamoDB implementation to SimpleDB one in a few hours.

PPS. What tools do you use to manage SimpleDB if you don't mind me asking?