dennii/dbgate
1
0
Fork 0
mirror of https://github.com/DeNNiiInc/dbgate.git synced 2026-04-23 01:06:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

dbmodel docs

Browse Source
This commit is contained in:
Jan Prochazka
2023-01-29 08:27:28 +01:00
parent b3308dc389
commit 9356ef6667
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/dbmodel/README.md
View File

@@ -1,5 +1,7 @@
# dbmodel
Deploy, load or build script from model of SQL database. Can be used as command-line tool or as javascript functions
Deploy, load or build script from model of SQL database. Can be used as command-line tool. Uses [DbGate](https://dbgate.org) tooling and plugins for connecting many different databases.
If you want to use this tool from JavaScript interface, please use [dbgate-api](https://www.npmjs.com/package/dbgate-api) package.
Model is stored as a collection of files:
* tables - stored as YAML files
@@ -52,6 +54,18 @@ dbmodel deploy -s localhost -u USERNAME -p PASSWORD -d DATABASE -e mssql@dbgate-
dbmodel build -e mssql@dbgate-plugin-mssql PROJECT_FOLDER OUTPUT_FILE.sql
```
Parameter -e (or --engine) specifies database dialect and connection driver to be used
Supported databases:
- MySQL - `-e mysql@dbgate-plugin-mysql`
- MS SQL Server - `-e mssql@dbgate-plugin-mssql`
- PostgreSQL - `-e postgres@dbgate-plugin-postgres`
- SQLite - `-e sqlite@dbgate-plugin-sqlite`
- Oracle - `-e oracle@dbgate-plugin-oracle`
- MariaDB - `-e mariadb@dbgate-plugin-mysql`
- CockroachDB - `-e cockroach@dbgate-plugin-postgres`
- Amazon Redshift - `-e redshift@dbgate-plugin-postgres`
## Table yaml file documentation
```yaml