Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cavo789/db_documentor

This script will establish a connection to a MySQL database, retrieve all tables and document them by creating `.csv`, `.md` and `.sql` files. If you're using [Marknotes](https://github.com/cavo789/marknotes), it'll also create the full documentation folder for Marknotes.
https://github.com/cavo789/db_documentor

documentation-generator markdown marknotes mysqli wiki

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/cavo789/db_documentor
Owner: cavo789
License: mit
Created: 2019-02-18T08:24:24.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2021-11-01T21:30:19.000Z (almost 3 years ago)
Last Synced: 2024-04-29T12:34:20.526Z (5 months ago)
Topics: documentation-generator, markdown, marknotes, mysqli, wiki
Language: PHP
Size: 630 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: LICENSE

Awesome Lists containing this project

jimsghstars - cavo789/db_documentor - This script will establish a connection to a MySQL database, retrieve all tables and document them by creating `.csv`, `.md` and `.sql` files. If you're using [Marknotes](https://github.com/cavo789/ma (PHP)

README

# DB Documentor

![Banner](imag.es/banner.svg)

> This script will establish a connection to a MySQL database, retrieve all tables and document them by creating `.csv`, `.md` and `.sql` files. If you're using [Marknotes](https://github.com/cavo789/marknotes), it'll also create the full documentation folder for Marknotes.

- [Description](#description)
- [Install](#install)
- [Configuration](#configuration)
- [Usage](#usage)
- [Hints](#hints)
- [Marknotes](#marknotes)
- [Laravel](#laravel)
- [Author](#author)
- [License](#license)

## Description

Table by table documentation will be generated:

- a .csv file with the first xxx records of the table
- a .sql file with a simple SELECT statement on that table
- a \_connection.md file with the info needed for establishing a connection
on the database
- a \_description.md file with the description of the table
- a \_structure.md file with a markdown table and will display the structure of the table (fieldname, type and comments if any)

If create_marknotes setting is set to True, additional .md files will be created:

- a .md file for the documentation of the database itself
- one .md file by table.

These two additional files will use a template defined in the settings.json file, under
marknotes->templates. Please refers to the marknotes documentation to learn more on that tool.

@see https://github.com/cavo789/marknotes

## Install

1. Get a copy of `DB_Documentor.php` (or download/clone the repository) and store the script on your localhost website;
2. Copy the `settings.json.dist` and name the name file `settings.json`;
3. Edit `settings.json` and edit the file (DB name, host, user, ...) so the setting fit your needs;

## Configuration

All the configuration is done in a file called `settings.json`. If the file isn't present, please copy `settings.json.dist` and name the new file `settings.json`.

Then edit the file so you can customize how the script works.

Below the content of the file:

````json
{
"databases": [
{
"host": "localhost",
"name": "your-db-name",
"user": "root",
"password": "",
"prefix": "",
"type": "mysqli",
"output": {
"folder": "C:\\temp\\db-documentation",
"url": ""
}
}
],
"config": {
"create_csv": 1,
"create_marknotes": 1,
"create_md": 1,
"create_sql": 1,
"csv_separator": ";",
"get_credentials": 1,
"get_detail": 1,
"maxrows": 5,
"timeformat": "d/m/Y H:i:s",
"timezone": "Europe/Brussels"
},
"marknotes": {
"templates": {
"database": [
"# Database @@DB_NAME@@",
"",
"%TOC_6%",
"",
"## Connection information",
"",
"%INCLUDE tables/.files/@@DB_NAME@@_connection.md%",
"",
"## Summary of tables",
"",
"%CSV tables/.files/@@DB_NAME@@_tables.csv%",
"",
"## List of tables",
"",
"%INCLUDE tables/*.md%"
],
"table": [
"# @@TABLE_NAME@@",
"",
"%INCLUDE .files/@@TABLE_NAME@@_description.md%",
"",
"%INCLUDE .files/@@TABLE_NAME@@_custom.md%",
"",
"## SQL",
"",
"```sql",
"%INCLUDE .files/@@TABLE_NAME@@.sql%",
"```",
"",
"## Fields",
"",
"%INCLUDE .files/@@TABLE_NAME@@_structure.md%",
"",
"## Samples",
"",
"%CSV .files/@@TABLE_NAME@@.csv%"
]
}
}
}
````

### databases

This is where you'll define the databases that you want to document, you can have more than one f.i.

```json
"databases": [
{
"name": "DB1",
...
},
{
"name": "DB2",
...
},
{
"name": "DB3",
...
}
]
}
```

_(simplified example)_

A database should contain at least the following information:

- `host`: the name of the database server (`localhost` the most of time);
- `name`: name of the database. That name will appear in the interface;
- `user`: the name of the user to use to get access to the database (`root` the most of time on a local webserver);
- `password`: password for that user;
- `prefix`: if your tables have a prefix, please specify the prefix here;
- `type`: the database type (`mysqli` the most of time);

Then you'll have an `output` entry with two items:

- `add_custom_files`: 0 or 1 - create a `xxx_custom.md` (where `xxx` is a table name) file for each table with an empty content. That file will be created **only** if the file isn't yet present so the documentation maintainer can add extra comments in that custom file and generate again and again new documentation; the `xxx_custom.md` won't never be modified by code; just created if missing;
- `folder`: the full name to the folder where to store files generated by the script;
- `url`: when the output has been successfully done, DB Documentor can display a link `Click here to see the documentation online`. If you want this, just specifiy your documentation URL here f.i. `http://localhost:8080/yourdoc/index.html` (very useful when using Marknotes).

```json
{
"host": "localhost",
"name": "your-db-name",
"user": "root",
"password": "",
"prefix": "",
"type": "mysqli",
"output": {
"add_custom_files": 1,
"folder": "C:\\temp\\db-documentation",
"url": ""
}
}
```

### config

Configuration options:

- `create_csv`: 0 or 1 - Does this script should generate .csv files?;
- `create_marknotes`: 0 or 1 - Does this script should generate files for marknotes?;
- `create_md`: 0 or 1 - Does this script should generate .md files?;
- `create_sql`: 0 or 1 - Does this script should generate .sql files?;
- `csv_separator`: Define the separator to use for CSV files, Default is ";";
- `get_credentials`: 0 or 1 - Does the documentation should include the credentials of the database?;
- `get_detail`: 0 or 1 - Does the documentation should include one documentation by table?;
- `maxrows`: Number of rows to show in the table samples;
- `timeformat`: Format for displaying date/time, Default; if not specified, will be Y-m-d h:i:s a;
- `timezone`: Needed to correctly display date/time, Default will be retrieved from the server's default.

```json
"config": {
"create_csv": 1,
"create_marknotes": 1,
"create_md": 1,
"create_sql": 1,
"csv_separator": ";",
"get_credentials": 1,
"get_detail": 1,
"maxrows": 5,
"timeformat": "d/m/Y H:i:s",
"timezone": "Europe/Brussels"
}
```

### marknotes

When the `create_marknotes` option is set to `1` in the `config` node, generated files will be create in such way that [Marknotes](https://github.com/cavo789/marknotes) will display them easily.

Marknotes documentation will be:

- One markdown file (`.md` extension) with the documentation of the database and
- One markdown file for each table in the database.

Both these files will be created by using a template. The `marknotes` node in the `settings.json` file deserves that purpose.

````json
"marknotes": {
"templates": {
"database": [
"# Database @@DB_NAME@@",
"",
"%TOC_6%",
"",
"## Connection information",
"",
"%INCLUDE tables/.files/@@DB_NAME@@_connection.md%",
"",
"## Summary of tables",
"",
"%CSV tables/.files/@@DB_NAME@@_tables.csv%",
"",
"## List of tables",
"",
"%INCLUDE tables/*.md%"
],
"table": [
"# @@TABLE_NAME@@",
"",
"%INCLUDE .files/@@TABLE_NAME@@_description.md%",
"",
"%INCLUDE .files/@@TABLE_NAME@@_custom.md%",
"",
"## SQL",
"",
"```sql",
"%INCLUDE .files/@@TABLE_NAME@@.sql%",
"```",
"",
"## Fields",
"",
"%INCLUDE .files/@@TABLE_NAME@@_structure.md%",
"",
"## Samples",
"",
"%CSV .files/@@TABLE_NAME@@.csv%"
]
}
}
````

## Usage

Once your changes have been made in the `settings.json` file, just go to your web interface (f.i. `http://localhost/doc/DB_Documentor.php`) and run it.

You'll get a form with a selection box: the list of databases will be displayed and simply select the database for which you want to generate the documentation.

As soon as a database name is selected, the program will start and after a few seconds, files will be created on your disk. Where? Please see the `output` folder in your `settings.json` file.

You can define one `output` folder by databases.

## Hints

### Marknotes

By using [Marknotes](https://github.com/cavo789/marknotes), documentation has never be so simple: just install Marknotes (see [Marknotes_Install](https://github.com/cavo789/marknotes_install)) and once done, specify the location of the `doc` folder of your current Marknotes installation in the `output` folder of your `settings.json` file.

By refreshing the documentation, files will be immediately store in your Marknotes installation and immediately available for your documentation.

Marknotes has a lot of plugins and can easily convert documentation to Word documents (`.docx`) or Markdown files (`.md`).

### Laravel

If you're working with Laravel, it's easy to add comments to tables and fields by using a migration script.

When you create your own table in Laravel, as you know, you get a `.php` file in the `/database/migrations` folder. This is the file where you specify your fields.

Take a look on the `up` function here below to learn how to add comments for fields and for the table:

```php
public function up()
{
Schema::create('test', function (Blueprint $table) {
$table->string('id', 100)->primary();
$table->integer('user_id');
$table->boolean('enabled')->comment = 'When set to false, the record should be considered as deleted (soft delete)';
});

DB::statement("ALTER TABLE `test` comment 'This table is used for ... and also for ...'");
}
```

Laravel expose a `comment` attribute for fields but no for the table. That's why we recommend to use a `DB::statement` command for running a DDL `ALTER TABLE`.

Both table and field's comment will be retrieved by this `DB_Documentor` tool.

## Author

Christophe Avonture

## License

[MIT](LICENSE)