https://github.com/andrglo/json-schema-entity

Manage a group of tables with a parent child relation in SQL that will be seen as a document, or entity, like a no SQL database
https://github.com/andrglo/json-schema-entity

Last synced: 26 days ago
JSON representation

Manage a group of tables with a parent child relation in SQL that will be seen as a document, or entity, like a no SQL database

• Host: GitHub
• URL: https://github.com/andrglo/json-schema-entity
• Owner: andrglo
• License: mit
• Created: 2015-08-22T19:03:06.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T17:23:15.000Z (3 months ago)
• Last Synced: 2024-11-11T01:43:24.231Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 1.42 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# json-schema-entity [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![CircleCI](https://circleci.com/gh/andrglo/json-schema-entity.svg?style=svg)](https://circleci.com/gh/andrglo/json-schema-entity)

> Manage a group of tables with a parent child relation in SQL that will be seen as a document, or entity, like a no SQL database

## Install

```sh

$ npm install --save json-schema-entity

```

## Usage (require pg-cr-layer or mssql-cr-layer)

```js

var jse = require('json-schema-entity');

var pgCrLayer = require('pg-cr-layer');

var config = {

  user: 'me',

  password: 'my password',

  host: 'localhost',

  port: 5432,

  pool: {

    max: 25,

    idleTimeout: 30000

  }

};

var db = new PgCrLayer(config)

var invoiceClass = jse('invoice', {

    properties: {

      id: {

        type: 'integer',

        autoIncrement: true,

        primaryKey: true

      },

      client: {

        type: 'string'

      }

    }

  });

invoiceClass.hasMany('items', {

  properties: {

    id: {

      type: 'integer',

      autoIncrement: true,

      primaryKey: true

    },

    name: {

      type: 'string'

    },

    description: {

      type: 'string'

    },

    price: {

      type: 'number',

      maxLength: 10,

      decimals: 2

    },

    invoiceId: {

      type: 'integer',

      $ref: 'invoice'

    }

  }

});

var invoiceInstance;

var invoice = invoiceClass.new(db);

invoice.createTables() // Will create tables invoice and items

  .then(function() {

    return invoice.syncTables(); // Then the reference in items

  })

  .then(function() {

    invoiceInstance = invoice.createInstance({

      client: 'Jessica',

      items: [

        {

          name: 'diamond',

          description: 'a beautiful diamond',

          price: 9999.99

        }

      ]

    });

    return invoiceInstance.save();

  })

  .then(function() {

    console.log(JSON.stringify(invoiceInstance, null, ' '));

    /* will log

     {

      "id": 1,

      "client": "Jessica",

      "items": [

       {

        "id": 1,

        "name": "diamond",

        "description": "a beautiful diamond",

        "price": 9999.99,

        "invoiceId": 1

       }

      ]

     }

    */

```

## License

MIT © [Andre Gloria]()

[npm-image]: https://badge.fury.io/js/json-schema-entity.svg

[npm-url]: https://npmjs.org/package/json-schema-entity

[daviddm-image]: https://david-dm.org/andrglo/json-schema-entity.svg?theme=shields.io

[daviddm-url]: https://david-dm.org/andrglo/json-schema-entity