Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maru44/scheman
A tool to write schema definition from connected database.
https://github.com/maru44/scheman
go golang mysql notion notion-api postgresql
Last synced: 3 days ago
JSON representation
A tool to write schema definition from connected database.
- Host: GitHub
- URL: https://github.com/maru44/scheman
- Owner: maru44
- License: bsd-3-clause
- Created: 2022-02-17T22:22:28.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T08:53:52.000Z (almost 2 years ago)
- Last Synced: 2024-06-20T16:44:25.098Z (7 months ago)
- Topics: go, golang, mysql, notion, notion-api, postgresql
- Language: Go
- Homepage:
- Size: 105 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scheman
[](https://github.com/maru44/scheman/blob/master/LICENSE)
[](https://goreportcard.com/report/github.com/maru44/scheman)
Scheman is a tool to visualize tables schema or ERD of connected RDB.
Main purpose of this is accelerating working collaboration between engineers and non-engineers.
You can choose output destination from `Notion`, `File` or both of them.
### Sample Images
Here is examples for output.
#### Notion
#### File
##### definition
https://github.com/maru44/scheman/blob/master/testdata/postgres/def.csv
##### ERD
https://github.com/maru44/scheman/blob/master/testdata/postgres/erd.md
#### Supported Databases
| Database | Test Confirmed |
| ------------ | -------------- |
| PostgreSQL | 👌 |
| MySQL | 👌 |
| MSSQL Server | |
| SQLite3 | |
| CockroachDB | |
#### Supported Output Destination
Only Notion is supported as output destination now. But I am going to add output destination like spread-sheat.
| Output Destination | Test Confirmed |
| ------------------ | -------------- |
| Notion | 👌 |
| File | 👌 |
## How to Use
Install this package and write settings for connection.
**_installation_**
```shell: installation
go install github.com/maru44/[email protected]
```
**_example for PostgreSQL - Notion)_**
```shell: Notion - PostgreSQL
go install github.com/volatiletech/sqlboiler/v4/drivers/[email protected] \
&& scheman psql --services notion --erd-outputs notion \
--notion-token ${NOTION_TOKEN} --notion-page-id ${PSQL_NOTION_PAGE_ID}
```
If you want to overwrite your schema-definition tables or ERD, you have to set `notion-table-index` after this command done. This value is oututted in your command line.
**_example for MySQL - File with sqlboiler.toml)_**
```shell: File - MySQL
go install github.com/volatiletech/sqlboiler/v4/drivers/[email protected] \
&& scheman mysql -c sqlboiler.toml --def-file def.csv --erd-file erd.md
```
#### Generic config options
| Name | Defaults | |
| ------------------ | --------- | ------------------------------------------------------------------------------------------------- |
| config | "scheman" | if you use sqlboiler, you can use sqlboiler.toml(.yaml) with setting this "sqlboiler.toml(.yaml)" |
| services | [ ] | notion |
| erd-outputs | [ ] | notion |
| notion-page-id | "" | required if output destinations contain "notion" |
| notion-page-token | "" | required if output destinations contain "notion" |
| notion-table-index | "" | if you want to overwrite definition table, please fill this |
| def-file | "" | The file name. required if output destinations if you want to output tables schema to file |
| erd-file | "" | The file name. required if output destinations if you want to output ERD to file |
| disable-views | false | |
| attr-ignore | [ ] | |
#### Database Driver Configuration
Settings for database you want to connect.
| Name | Required | Postgres Default | MySQL Default | MSSQL Default |
| --------- | -------- | ---------------- | ------------- | ------------- |
| schema | no | "public" | none | "dbo" |
| dbname | yes | none | none | none |
| host | yes | none | none | none |
| port | no | 5432 | 3306 | 1433 |
| user | yes | none | none | none |
| pass | no | none | none | none |
| sslmode | no | "require" | "true" | "true" |
| whitelist | no | [] | [] | [] |
| blacklist | no | [] | [] | [] |
ref: https://github.com/volatiletech/sqlboiler#database-driver-configuration
## thx
https://github.com/volatiletech/sqlboiler
https://github.com/dstotijn/go-notion