Giter Club home page Giter Club logo

dynamometer's Introduction

Dynamometer

Dynamometer logo

Dynamometer


Enforces single table design on your DynamoDB queries in an elegant way.

npm package Build Status Downloads Issues Code Coverage Commitizen Friendly Semantic Release

A library to easily work with DynamoDB and enforces single table design approach.

Introduction

Inspired by Firestore SDK.

Managing your data with a single design approach in DynamodDB can sometimes be difficult. Dynamometer uses so-called "Collections" and "Docs" to structure your data in an comprehensible way.

Dynamometer is intended for simple, low-complexity projects and is designed to allow an architect to immediately take a single-table approach with a DynamoDB table without having to think much about access patterns.

const db = Dynamometer.create({
  tableName: "dataTable"
})

db.collection('USERS')
  .doc("xspvLRiJ")
  .collection("TODOS")
  .add({
    text: "Makes managing your data a breeze."
  })

Features


  • Easy to use API to query and create items in DynamoDB.
  • Data is automatically structured in single table design. `

Install

Install


npm install dynamometer       # npm
yarn add dynamometer          # yarn
pnpm add dynamometer          # pnpm

Usage

Basic usage


Create a instance of the dynamometer client.

import { Dynamometer } from 'dynamometer';

const db = Dynamometer.create({
  tableName: "dataTable"
})

CollectionReference

A collection holds a number of items.

Creating a collection

const collection = db.collection("USERS")

With a collection, items can be added to it or all can be queried.

Adding an item

collection.add({
  name: "John Doe"
})

Query all Items

const reponse = await collection.get()

Doc

If you know the ID of an item in the collection or you want to give it your own ID you can use the doc methode.

// get the doc
collection.doc("123").get()

// add the doc with the id 123
collection.doc("123").add({
  name: "John Doe"
})

DocumentReference

A document is an item of a collection. It offers CRUD methodes.

Doc

If you know the ID of an item in the collection or you want to give it your own ID you can use the doc methode.

Creating a document

const doc = db.collection("USERS").doc("123")

Set doc data

 const repsonse = await doc.set({
  name: "John Doe"
})

Get doc data

const data = await doc.get()

Update doc

const response = await doc.update({
  name: "John Doester"
})

Delete doc

const response = await doc.delete()

dynamometer's People

Contributors

andreascaldewei avatar

Watchers

 avatar

dynamometer's Issues

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.