pyrope

pyrope

Pyrope is a Node.js promise-based ORM for GraphQL and AWS DynamoDB.

Under development. Not intended for production use. Watch on github to be notified about new releases. Coming soon.

Introduction

This project came into being in response to a lack of solutions for handling AWS DynamoDB through GraphQL, specifically in a Serverless architecture.

Use your existing GraphQL types and perform CRUD operations, as well as 1:1, 1:N, N:N associations.

Features

• Handle CRUD operations on records
• Handle 1:1, 1:N, N:N relationships
• Handle record counters

Getting Started

$ npm install --save pyrope

const User = new PyropeModel(UserType);

Where UserType is a GraphQLObjectType.

Use the PyropeModel instance in your resolvers in order to perform Queries and Mutations.

Documentation

Check the ES6Docs here, the API and the tests.

More to come...

Specifications

• Table names are generated by Inflector.tableize(modelName) from Inflected.
• The default index key for each record is uuid
• The association table name is generated by concatenating both table names with an underscore, in alphabetical order. ie, contacts_orgnaizations.
• If NODE_ENV='test' the table names are prefixed with _test_
• The record counts are stored in table_counters table.

TODOs

• Query optimizations
• Stress tests and look for data inconsistencies (ie. failed requests)
• Optimize algorithms for associations
• Production testing

MIT Licence

Copyright (c) 2016 Sergio del Rio

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 NONINFRINGEMENT. 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.