Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/galeone/postgres2node-orm
Generate node-orm modules from a dump of a database schema
https://github.com/galeone/postgres2node-orm
Last synced: 5 days ago
JSON representation
Generate node-orm modules from a dump of a database schema
- Host: GitHub
- URL: https://github.com/galeone/postgres2node-orm
- Owner: galeone
- License: mit
- Created: 2013-10-31T22:44:31.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2013-11-25T06:57:08.000Z (about 11 years ago)
- Last Synced: 2024-10-30T06:27:32.196Z (about 2 months ago)
- Language: Perl
- Homepage:
- Size: 135 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
postgres2node-orm
============
Description
-------------
Generate [node-orm2](https://github.com/dresende/node-orm2) models from a postgresql schema dump.
To obtain a database schema dump use `pg_dump --schema-only`
Usage
-------
```shell
perl postgres2node-orm.pl databaseDefinition.sql outputdir
```
Where `databaseDefinition.sql` is the schema dump and `outputdir` is an existing directory.
It generates one file per table, in the current format: `table_name.ts`
In addition, the script will create a outputdir/index.ts in which are present the load call for each table and a module called `models` that contains all module definitions as interface.
The extension is for TypeScript file, but you can edit easily the script to generate .js files (and changing TypeScript closure `() => ` with JavaScript closure`function ()`), and removing interfaces or adapt it in some way.
Example
----------
In my dump I've got a table definiton like:
```SQL
CREATE TABLE users (
id serial8 NOT NULL,
stamp timestamp(0) WITH TIME ZONE NOT NULL DEFAULT NOW(),
story json,
private boolean NOT NULL DEFAULT FALSE,
username varchar(90) NOT NULL,
password varchar(40) NOT NULL,
name varchar(60) NOT NULL,
surname varchar(60) NOT NULL,
email varchar(350) NOT NULL,
board_lang varchar(2) DEFAULT NULL,
timezone varchar(35) NOT NULL DEFAULT 'UTC',
PRIMARY KEY (counter),
CONSTRAINT usersLastCheck CHECK(EXTRACT(TIMEZONE FROM last) = '0')
);
```
The output in `outputdir/users.ts` is
```TypeScript
import orm = require('orm');
module.exports = (db: orm.ORM, cb: (err?:Error) => void) => {
db.define("users",
/* definition */
{
id : { type: 'number', required: true, size: 8, rational: false},
stamp : { type: 'date', required: true, time: true , defaultValue: "NOW()"},
story : { type: 'object', required: false},
private : { type: 'boolean', required: true, defaultValue: "FALSE"},
username : { type: 'text', required: true, size: 90},
password : { type: 'text', required: true, size: 40},
name : { type: 'text', required: true, size: 60},
surname : { type: 'text', required: true, size: 60},
email : { type: 'text', required: true, size: 350},
board_lang : { type: 'text', required: false, size: 2, defaultValue: "NULL"},
timezone : { type: 'text', required: true, size: 35, defaultValue: "UTC"}
},
/* options */
{
id: ['counter']
});
return cb();
};
```
Thus, the outputdir/index.ts will look like:
```TypeScript
import orm = require('orm');
module.exports = (db: orm.ORM, cb: (err?:Error) => void) => {
db.load('users', (err) => {
if(err) {
return cb(err);
}
return cb();
});
};
//Interfaces
module models {
export interface users {
id: number;
stamp: Date;
story: JSON;
private: boolean;
username: string;
password: string;
name: string;
surname: string;
email: string;
board_lang: string;
timezone: string
}
}
export = models;
```
In this way, you can import outputdir/models.ts and use these interfaces.
Like:
```TypeScript
import models = require('outputdir/index');
[...]
orm.models["users"].get(id, (err, u: models.users) => {
new User(m.id, m.username, m.email); //where the constructor of User is defined like construct(public id: number, public username: string, public email: string);
//In this way types match and you can use autocompletion in u.
});
```
[](https://bitdeli.com/free "Bitdeli Badge")