mp-php / fuel-packages-dbdocs
Installs: 14
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Language:JavaScript
Type:fuel-package
Requires
- doctrine/orm: 2.*
- jdorn/sql-formatter: 1.*
- symfony/console: 2.*
- symfony/yaml: 2.*
This package is auto-updated.
Last update: 2024-10-19 20:16:38 UTC
README
- fuel-packages-dbdocs is generator for database documentation
- You can generate database documentation from command line
- Example(GitLab Database) http://fueldbdocssample.madroom.net/index.html
- Powered by FuelPHP http://fuelphp.com/
You can also use https://github.com/mp-php/fuel-dbdocs
Supporting databases
- MySQL (pdo_mysql is required)
- PostgreSQL (pdo_pgsql is required)
- SQLite (pdo_sqlite is required)
- Microsoft SQLServer (pdo_sqlsrv is required)
Install
Setup to fuel/packages/dbdocs
- Use composer https://packagist.org/packages/mp-php/fuel-packages-dbdocs
- git submodule add
- Download zip
If you use git submodule or download zip, you must install vendors
$ cd fuel/packages/dbdocs
$ php composer.phar install
Configuration
In app/config/config.php
'always_load' => array('packages' => array(
'dbdocs',
...
'security' => array('whitelisted_classes' => array(
'Doctrine\\DBAL\\Schema\\Table',
'Doctrine\\DBAL\\Schema\\View',
...
Usage
$ php oil r dbdocs:help
License
Copyright 2013, Mamoru Otsuka. Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php