This module is part of ORM. It's used synchronize model tables in supported dialects.
Sorry there is no API documentation for now but there are a couple of tests you can read and find out how to use it if you want.
Example
Install orm & the required driver (eg: mysql).
Create a file with the contents below and change insert your database credentials.
Run once and you'll see table ddl_sync_test appear in your database. Then make some changes to it (add/drop/change columns)
and run the code again. Your table should always return to the same structure.
var orm = require("orm");var mysql = require("mysql");var Sync = require("sql-ddl-sync").Sync;orm.connect("mysql://username:password@localhost/database", function (err, db) { if (err) throw err; var driver = db.driver; var sync = new Sync({ dialect : "mysql", driver : driver, debug : function (text) { console.log("> %s", text); }