Go to file
2018-01-14 16:54:43 +01:00
bin readme, preparation to npm publish 2017-07-20 23:16:55 +02:00
src changed postgres timestamp without time zone recognition #16 2018-01-14 16:54:43 +01:00
test Formatting existing code 2017-12-31 17:28:41 +01:00
.editorconfig Added editorconfig 2017-12-30 16:04:10 +01:00
.gitignore readme, preparation to npm publish 2017-07-20 23:16:55 +02:00
.npmignore readme, preparation to npm publish 2017-07-20 23:16:55 +02:00
.travis.yml Formatting existing code 2017-12-31 17:28:41 +01:00
codecov.yml Formatting existing code 2017-12-31 17:28:41 +01:00
docker-compose.yml Formatting existing code 2017-12-31 17:28:41 +01:00
LICENSE Initial commit 2017-03-23 20:52:39 +01:00
package-lock.json merge from master 2018-01-11 18:34:32 +01:00
package.json merge from master 2018-01-11 18:34:32 +01:00
README.md docs(readme): add Greenkeeper badge 2017-12-27 21:48:03 +00:00
tsconfig.json Formatting existing code 2017-12-31 17:28:41 +01:00
typings.json Formatting existing code 2017-12-31 17:28:41 +01:00

typeorm-model-generator

Greenkeeper badge Build Status npm version codecov

Generates models for TypeORM from existing databases.
Suported db engines:

  • Microsoft SQL Server
  • PostgreSQL
  • MySQL
  • MariaDB

Installation

Global module

To install module globally simply type npm i -g typeorm-model-generator in your console.

Npx way

Thanks to npx you can use npm modules without polluting global installs. So nothing to do here :)

To use npx you need to use npm at version at least 5.2.0. Try updating your npm by npm i -g npm

Usage

Usage: typeorm-model-generator -h <host> -d <database> -p [port] -u <user> -x
[password] -e [engine]

Options:
  -h, --host      IP adress/Hostname for database server.             [required]
  -d, --database  Database name.                                      [required]
  -u, --user      Username for database server.                       [required]
  -x, --pass      Password for database server.                       [required]
  -p, --port      Port number for database server.
  -e, --engine    Database engine.
           [choices: "mssql", "postgres", "mysql", "mariadb"] [default: "mssql"]
  -o, --output    Where to place generated models.
  -s, --schema    Schema name to create model from. Only for mssql and postgres.
  --ssl                                               [boolean] [default: false]

Examples

  • Creating model from local MSSQL database
    • Global module
      typeorm-model-generator -h localhost -d tempdb -u sa -x !Passw0rd -e mssql -o .\
      
    • Npx Way
      npx typeorm-model-generator -h localhost -d tempdb -u sa -x !Passw0rd -e mssql -o .\
      
  • Creating model from local Postgres database, public schema with ssl connection
    • Global module
      typeorm-model-generator -h localhost -d postgres -u postgres -x !Passw0rd -e postgres -o .\ -s public --ssl
      
    • Npx Way
      npx typeorm-model-generator -h localhost -d postgres -u postgres -x !Passw0rd -e postgres -o .\ -s public --ssl