Download the PHP package kojiro526/php-dbdoc without Composer
On this page you can find all versions of the php package kojiro526/php-dbdoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-dbdoc
DB定義書ジェネレータ
DB定義書を既存のスキーマから生成するツールです。
特徴
- 既存のデータベース上のスキーマからDB定義書をMarkdown形式で出力します。
- カラム、インデックス、外部キー等の情報を出力します。
- ファイル内でツールが更新するべき場所としない場所が分離されており、ツールが更新しない場所には任意の記述を加えることができます。
- ファイル内にコメント形式で記述されたタグを元にテーブルとファイルの紐付けを行っているため、ファイル名は自由に変更することができます。
必要要件
- php >= 7.1.0
- composerが予め利用可能である必要があります。 （ インストール方法 ）
事前の設定
このコマンドはcomposerでグローバルインストールして使うことを想定しているため、以下のディレクトリにパスを通して下さい。
Linux, OSX等
.bash_profile等に以下のパスを設定して下さい。
Windows
Windowsでは以下のフォルダを環境変数のPATHに設定して下さい。
インストール
本リポジトリに含まれるDockerfileを元にDockerイメージをビルドすると、環境構築の手間を省く事が出来ます。
使い方
以下のようにしてDBに接続し、指定したディレクトリ配下にDB定義書を出力します。
※localhostにMySQL（MariaDB）のデータベースが立ち上がっている想定です。
ファイル中のコメントタグは、本ツールが更新するブロックを認識するための目印です。
本ツールを再度実行してDB定義書を更新すると、上記のブロック部分のみが更新されるため、それ以外の場所をどのように編集しても影響はありません。
Dockerを使った実行方法
本ツールはPHP7.1以上を要件としており、環境によっては利用が難しい場合もあり得るため、その場合はDockerを使って実行することもできます。
本リポジトリに含まれるDockerfileをビルドしてDockerイメージを作成して下さい。
Dockerイメージは以下のようになっています。
- 本ツールが最初からインストール済みです。
- コンテナ内の
/workをWORKDIRとして設定しているため、カレントディレクトリを/workにマウントするなどして使って下さい。
※コンテナ内からローカルPC上のlocalhostにアクセスするためには、docker.for.mac.localhost（Windowsの場合はdocker.for.win.localhost）と指定する必要があります。（そうしなければ、コンテナ内のlocalhostを参照してしまいます）
サンプル
本リポジトリに含まれるdocker-compose.ymlはコマンドの実行環境とサンプルDBを含んでおり、気軽に動作を試すことが出来ます。
サンプルの環境は以下のように実行して下さい。
サンプルDB
上記のコマンド実行後、以下の場所にあるSQLが自動的に実行されてサンプルDBが作成されます。
サンプルDBのドキュメント生成
以下のようにサンプルDBのドキュメントを./tmp配下に出力できます。
