Skip to content
Gets you a JSON Schema from PostgreSQL or SQLite3. Also supports arrays and default values. Use it for introspection or preparing your domain models like with Rails's Active Record.
JavaScript Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
lib
test
.gitignore
.npmignore
CHANGELOG.md
LICENSE
Makefile
README.md
index.js
package.json

README.md

DDL.js

NPM version

DDL.js is a library that queries database and table schemas (currently from PostgreSQL and SQLite3) and describes their columns with JSON Schema v4.

You can use DDL.js for introspection, to prepare your domain models and set up simple type coercions or validations for those database columns. This way you can have the same convenience that Ruby on Rails's ActiveRecord provides, but in the JavaScript world.

DDL.js is open for extension and modifications, so if you have suggestions what more it should define or query from the database, please ping me with an email, a tweet or create an issue on GitHub.

Installing

npm install ddl

DDL.js follows semantic versioning, so feel free to depend on its major version with something like >= 1.0.0 < 2 (a.k.a ^1.0.0).

Using

Each database has its own function you can call passing it the connection to that database and the table name you'd like to get a data definition for. Look at DDL.js API Documentation for a list of supported databases.

Given the following table:

CREATE TABLE "golfers" (
  "name" VARCHAR(255) DEFAULT 'Tiger' NOT NULL,
  "handicap" INTEGER DEFAULT 52 NOT NULL,
  "updated_at" DATETIME
)

And the following code:

var Pg = require("pg")

var db = new Pg.Client
db.connect({database: "golf"})

var Ddl = require("ddl")
Ddl.postgresql(db, "golfers", function(err, ddl) {})

Your callback will be called with the following object for ddl:

{
  name: {type: "string", default: "Tiger", maxLength: 255},
  handicap: {type: "integer", default: 52},
  updated_at: {type: ["string", "null"], default: null}
}

This works well if you have a single JavaScript "class" or model per database table. With DDL.js you can initialize that model's attributes and their default values without having to manually keep the database and the model declaration in sync.

If you want to use the returned definition with a JSON Schema validator library, use it like this:

var Jsck = require("jsck")
var ddl = Ddl.postgresqlSync(db, "golfers")
var validation = new Jsck.draft4({type: "object", properties: ddl})
validation.validate({name: "John", handicap: 13})

API

For extended documentation on all functions, please see the DDL.js API Documentation.

Ddl

Attribute

License

DDL.js is released under a Lesser GNU Affero General Public License, which in summary means:

  • You can use this program for no cost.
  • You can use this program for both personal and commercial reasons.
  • You do not have to share your own program's code which uses this program.
  • You have to share modifications (e.g bug-fixes) you've made to this program.

For more convoluted language, see the LICENSE file.

About

Andri Möll typed this and the code.
Monday Calendar supported the engineering work.

If you find DDL.js needs improving, please don't hesitate to type to me now at andri@dot.ee or create an issue online.

You can’t perform that action at this time.