dan/mysqlExporterDeno
1
0
Fork 0
mirror of https://github.com/danbulant/mysqlExporterDeno synced 2026-05-19 04:08:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add readme about setting up and running mysql exporter

Browse source
This commit is contained in:
Daniel Bulant 2020-04-14 12:36:49 +02:00
parent 5bd601cd56
commit f2724f37ad
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md Normal file
View file

@ -0,0 +1,29 @@
# MySQL exporter
MySQL exporter is a simple tool for generating data dictionaries from database.
## Configuring
The exporter uses simple config.json, **in the current workind directory**. Just create config.json and use the following format:
```json
{
"mysql": {
"host": "localhost",
"user": "root",
"password": "",
"database": "mysql"
},
"fields_ignored": []
}
```
Fields ignored is an array of fields which shouldn't be in the report. It's case insensitive.
## Running
If you have [node](http://nodejs.org) and [git](https://git-scm.com/) installed on your system, simply create the config and run `npx github:danbulant/mysqlExporter`.
## Saving and sharing reports
On the newly opened page (opened by running), press `ctrl+s` and save the HTML file. That file is fully self-contained, even for offline use, so you can share the report with others.