This project attempts to solve the task of getting an SQL diagram from an existing schema.
npm i
npm start
POST http://localhost:3000/html and pass as json body:
{
"host": "DB_HOST_HERE",
"port": "DB_PORT_HERE",
"password": "DB_PASSWORD_HERE",
"user": "DB_USER_HERE",
"database": "DB_NAME_HERE",
"schemas": "DB_SCHEMAS_HERE",
}Defaults values are:
{
host: '0.0.0.0',
port: '5432',
user: 'postgres',
schemas: ['public'],
database: 'postgres',
password: 'example',
}pg-structure: Library for retrieve schemas from postgres.
express: Server Framework. It is responsible to connect to your database and retrieve the schema using the library mentioned above.
gojs: Library for visualization. Used for render tables and relationships (diagram itself).
For now, only works with postgres databases.
Running development server
npm run dev
MIT License
Copyright (c) 2018 Bruno Cascio
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.