Skip to content
This repository has been archived by the owner on Oct 22, 2022. It is now read-only.

Latest commit

 

History

History
74 lines (57 loc) · 2.82 KB

README.md

File metadata and controls

74 lines (57 loc) · 2.82 KB

Github Action Codecov Gitter npm

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.