@wmfs/relationize

relationize

Takes a set of JSON Schema definitions and returns a relational database structure capable of storing compliant data.

Install

$ npm install relationize --save

Usage

  const relationize = require('relationize')

  relationize (
    {
      source: {
        paths: [
          {
            namespace: 'relationizeTest',
            path: '/somewhere/json-schemas/live'
          }
        ]
      }
    },
    function (err, dbStructure) {
      // Done!
      // - The value of 'dbStructure' takes the same form  
      //   as the output generated by the 'pg-info' package.
    }
  )

API

relationize(options, callback)

Options:

Option	Type	Notes
source	object	A source object for configuring where to derive JSON Schema data from.

source object

Examples

• From files:

{
  paths: [
    {
      namespace: 'relationizeTest',
      path: '/somewhere/json-schemas/live'
    }
  ]
}

• From Javascript object:

{
  schemas: [
    {
      namespace: 'relationizeTest',
      schema: {
        // JSON schema here
      }
    }
  ]
}

Properties

property	Type	Notes
paths	[object]	An array of objects containing a namespace property (used to separate related tables into schemas_ and path (a file-path from where to load JSON files from - uses glob, so the ** pattern is supported)
schemas	[object]	An array of objects containing a namespace property (used to separate related tables into schemas_ and schema (a ready-to-use JSON Schema)

Output

Relationize returns objects of the same form as those returned by the pg-info package. The output of Relationize can then be used to generate a relational database (complete with comments, tables, indexes and foreign key constraints) to store your JSON-structured data.

• Please refer to the pg-info docs for more details.

Testing

$ npm test

License

MIT

Changelog

1.22.0 (2020-04-27)

✨ Features

• interface: Removed relationize callback interface - now returns a promise (7c5f96c)

🛠 Builds

• deps: Remove 'async' dependency (f623921)
• deps-dev: bump mocha from 7.1.1 to 7.1.2 (4ef04e5)

📦 Code Refactoring

• Functions in schemaFilesParser don't need to be local (a388bb2)
• Minor clean ups in parser (9caf3ec)
• Rework load-from-schema-files to remove 'async' package dependency (5858bb1)
• Switch loader over to using async/await (2637f30)

🚨 Tests

• Flip from callback to async/await (f0725f3)