Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krismorte/database-diagrams
automatic database documentation solution using shemaspy
https://github.com/krismorte/database-diagrams
crontab database-diagrams database-documentation docker docker-image java mssql mysql oracle postgresql schemaspy
Last synced: about 2 months ago
JSON representation
automatic database documentation solution using shemaspy
- Host: GitHub
- URL: https://github.com/krismorte/database-diagrams
- Owner: krismorte
- License: gpl-3.0
- Created: 2019-05-04T21:26:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T07:56:23.000Z (9 months ago)
- Last Synced: 2024-08-09T02:15:47.941Z (5 months ago)
- Topics: crontab, database-diagrams, database-documentation, docker, docker-image, java, mssql, mysql, oracle, postgresql, schemaspy
- Language: JavaScript
- Homepage:
- Size: 22.4 MB
- Stars: 10
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - krismorte/database-diagrams - automatic database documentation solution using shemaspy (JavaScript)
README
# database-diagrams
> Please support a project by simply putting a Github star.
Share this library with friends on Twitter and everywhere else you can.
Thanks to the [SchemaSpy](https://github.com/schemaspy/schemaspy) developers
This code was made to implementing full database documentation per server that wasn't implementing in the SchemaSpy originally project. This project also include a crontab scheduling, a nginx server to show the results and a java application to manager and coordinate the execution and build a main page to redirect to all databases sites made.
## Run Docker Pull
```
docker pull krismorte/databasediagrams:2.2
```
## Run a test
This project include a docker-compose file to test the solution locally running against 2 mysql and 1 postgres containers
```
git clone https://github.com/krismorte/database-diagrams.git
cd database-diagrams/
docker-compose up
```
on dbconf folder you will find .prop files with the database servers configuration and also a mysql and postgres script used to create the diagram_test database when the container is created.
## Run Docker Container
To use this solution you have to edit the .prop files with your own servers and run this follow command:
```
docker run -it --rm -p 80:80 -v $PWD/dbconf:/dbconf --name databasediagrams krismorte/databasediagrams:2.2
```
_*this command will show the output and lock the terminal, to run in production please change the -it option for -d_
You can put your company name at the main page using the option `-e COMPANY_NAME=MyCompany`
access the url http://localhost/
The output don't show the schemaspy log to see that run the follow command:
```
docker exec databasediagrams cat /var/log/script.log
```
Depends on the amount of databases and tables this process can take a long time to run, be aware about this. By default the script will run everyday at as 07AM you can overwrite the env __CRN__
, but you can run manually to see the result. This process can take several minutes depends the database sizes
This solution was prepared and tested on mysql, sql server, postgres and oracle. The Schemaspy support much more databases as you can see [here](https://github.com/schemaspy/schemaspy/tree/master/src/main/resources/org/schemaspy/types) but my solution wrapper the schemaspy so I will add more database as soon as possible.
> schemaspy supported by database-diagrams are mssql, mssql05, mssql08, mysql, mariadb, postgres, postgres11, orathin
### Oracle Details
As Oracle remove jdbc jar from maven repository you need to download the jdbc manually on the [official site](https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html) and put the jar file on the same folder with your .prop files (ojdbc6.jar, ojdbc7.jar or ojdbc8.jar). Also you have to inform the SID on oracle prop file `db.oracsid=` and the `db.query` has no efect on Oracle.
## Build the Image
Simple build
``` #docker build -t krismorte/databasediagrams:2.2 .```
Build for multi arch
``` #docker buildx --builder docker-container build --platform linux/amd64,linux/arm64/v8 -t krismorte/databasediagrams:2.2 .```
the full documentarion of the container is [here](https://hub.docker.com/r/krismorte/databasediagrams)
## PROP file
- __Required__
- _optional_
File's configuration
- __schemaspy.db.type=mysql__ this fild is necessary to schemaspy knows about the database
- __db.server=172.17.0.1__ server name
- __db.user=root__ database user name
- __db.password=secret__ user's password
- _db.port=3307_ just necessary if you are using a different port
- _db.query=SELECT DISTINCT SCHEMA_NAME FROM information_schema.SCHEMATA WHERE SCHEMA_NAME ='performance_schema'_ you can customize the database query to include or exclude some database. Has no effect on Oracle.
- _**db.oracsid=xe**_ required only when the type was orathin
## Under the hook
The entry point will config the cron job, config the oracle on the local maven repository when it's available, running the application for the first time and up the nginx server. The cron job call a second script who contains the main java application.
### Docker Buildx Install on Mac
```
brew install docker-buildx
ln -sfn $(which docker-buildx) ~/.docker/cli-plugins/docker-buildx
docker buildx create --name docker-container --driver docker-container
docker buildx build --platform linux/amd64,linux/arm64/v8 -t krismorte/databasediagrams:2.2 .
```