typeorm |
您所在的位置：网站首页 › typeorm-model-generator › typeorm |
typeorm
|
typeorm-model-generator
Generates models for TypeORM from existing databases. Supported db engines: Microsoft SQL Server PostgreSQL MySQL MariaDB Oracle Database SQLite Installation VersionsTypeorm-model-generator comes with preinstalled driver for each supported db(except for oracle). However if you want to use it as a dev-dependency you may want to install your db driver manually to reduce dependency footprint, reduce time spent in the CI. In such case you can use version without preinstalled db drivers - npm i typeorm-model-generator@no-engines. Global moduleTo install module globally simply type npm i -g typeorm-model-generator in your console. Npx wayThanks 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 Database driversAll database drivers except oracle are installed by default. To use typeorm-model-generator with oracle database you need to install driver with npm i oracledb and configure oracle install client on your machine. UsageThere are two way to use this utility: Use step by step wizard which will guide you though the process - just type npx typeorm-model-generator in your console. Provide all parameters through command line(examples below)Use npx typeorm-model-generator --help to see all available parameters with their descriptions. Some basic parameters below: Usage: typeorm-model-generator -h -d -p [port] -u -x [password] -e [engine] Options: --help Show help [boolean] --version Show version number [boolean] -h, --host IP address/Hostname for database server [default: "127.0.0.1"] -d, --database Database name(or path for sqlite) [required] -u, --user Username for database server -x, --pass Password for database server [default: ""] -p, --port Port number for database server -e, --engine Database engine [choices: "mssql", "postgres", "mysql", "mariadb", "oracle", "sqlite"] [default: "mssql"] -o, --output Where to place generated models [default: "./output"] -s, --schema Schema name to create model from. Only for mssql and postgres. You can pass multiple values separated by comma eg. -s scheme1,scheme2,scheme3 --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 Creating model from SQLite database Global module typeorm-model-generator -d "Z:\sqlite.db" -e sqlite -o . Npx Way npx typeorm-model-generator -d "Z:\sqlite.db" -e sqlite -o . Use CasesPlease take a look at few workflows which might help you with deciding how you're gonna use typeorm-model-generator. Naming strategyIf you want to generate custom names for properties in generated entities you need to use custom naming strategy. You need to create your own version of NamingStrategy and pass it as command parameter. typeorm-model-generator -d typeorm_mg --namingStrategy=./NamingStrategy -e sqlite -db /tmp/sqliteto.db |
【本文地址】