テーブル定義書生成ツール

【Database Define】

ver.8.2.0

URL : https://www.zumuzack.com/zack/table-define-tool/

Last Updated :

概要

DBからテーブル情報を抽出して テーブル定義書 を自動生成します ( HTML版 / EXCEL版 )
生成される テーブル定義書 (HTML版) には、検索機能 や SQL(一括)生成、DDL生成、コード定義ポップアップ、インデックス/ビュー式/外部キー制約情報/トリガー情報/ファンクション/プロシージャ情報/コード定義一覧 の表示 といった機能が装備されています

(Microsoft Winodws用アプリケーションです)

対応DB

MySQL (MariaDB)、PostgreSQL、SQLite3、Oracle、SQL Server
　※Excel定義書(A5M2版、当アプリ版)、ER図(A5M2)も入力DBとして対応しています

インストール

ダウンロードした DatabaseDefine.zip を展開(解凍)します
(./DatabaseDefine/ というフォルダが生成されます)

アンインストール

./DatabaseDefine/ フォルダを削除します
　※レジストリ操作はしていないので、フォルダ削除のみになります

目次

TOPへ

使い方

操作手順

  1. 起動する
    ./DatabaseDefine/bin/DatabaseDefine.exe を起動します

  2. 動作設定する
    「動作設定」ボタンより Settings 画面を開き、DB接続情報 / 出力タイプ / オプション 等の内容を設定します

    (Settings)

    ※ここでは「Output」欄の「HTML」チェックを付けた (HTML版テーブル定義書生成の) 手順とします

  3. テーブル定義書を生成する
    「一括(①＋②)」ボタンよりコンテンツ(テーブル定義書)を生成します

  4. テーブル定義書を起動する
    「HTML定義書参照」ボタンより、コンテンツを参照(利用)します

    ↓　※ブラウザが起動します


    テーブル定義書サンプル集 (リンク)


    コンテンツマニュアル


    目次へ

画面機能詳細

メイン画面：Database Define


設定情報：Information【①】

設定：Settings【②】

実行：Execution【③】

各種参照機能：Reference【④】

その他：Other【⑤】

動作設定画面：Settings

インプット情報：Input【①】

アプトプット情報：Output【②】

オプション設定：Option【③】

オプション設定：Option【④】

SSHトンネル接続設定：SSH【⑤】

処理【⑥】

ユーティリティ画面：Utility

補助情報設定Excel : DatabaseDefineSubInfo.xlsx

補助情報を設定するためのファイルになります
メイン画面「Settings」欄の「補助情報設定」ボタンでこのExcelが開かれます
設定したら保存してEXCELファイル「DatabaseDefineSubInfo.xlsx」を閉じます (このExcelを開いた状態で実行系ボタンをクリックするとエラーになります)
(イメージ)

　　　　　　　　　　　　　　　↓　↓　↓


補助情報は、ExcelがインストールされたPCであれば ./excel/DatabaseDefineSubInfo.xlsx に各設定を保存しますが ExcelがインストールされていないPCの場合はテキストエディタなどで、直接CSVファイルを編集することになります(./bin/csv/)。
※エディタなどで手動作成する場合は、キャラクタコードにご注意ください。～.csv は UTF-8 になります。
※ExcelがインストールされているPCでは、直接CSV編集しても DatabaseDefineSubInfo.xlsx の内容で上書きされてしまいますので、Excelインストール済PCでのcsv直接編集はしないようにしてください。

補助情報一覧 (シート一覧)

目次へ

【table.csv】シート

補助情報一覧へ

【code.csv】シート

補助情報一覧へ

【col.csv】シート

補助情報一覧へ

【col-code.csv】シート

※ver.5.5.0 より１つの項目(Col Id.)に複数のコード定義(Code Id.)を紐づけることができるようになりました

補助情報一覧へ

【table-col.csv】シート

補助情報一覧へ

【table-col-code.csv】シート

補助情報一覧へ

【join-col.csv】シート

補助情報一覧へ

【join-table-col.csv】シート

補助情報一覧へ

【trigger.csv】シート

補助情報一覧へ

【func_proc.csv】シート

補助情報一覧へ
目次へ

その他


目次へ

モジュール構成

※アプリケーションで生成されるフォルダ/ファイルも記載しています

./DatabaseDefine/
    bin/
        a5er/                             ※A5ER図ファイル保存場所としてご利用ください
        csv/                              ※ExcelなしPCの場合のみテキストエディタで編集
            code.csv
            col.csv
            col-code.csv
            func_proc.csv
            join-col.csv
            join-table-col.csv
            table.csv
            table-col.csv
            table-col-code.csv
            trigger.csv
        excel/
            DatabaseDefineSubInfo.xlsx    ※補助設定情報ファイル★
        pic/                              ※ロゴ画像ファイル保存場所としてご利用ください
        sqlite/                           ※SQLiteファイル保存場所としてご利用ください
        sshauth/                          ※SSHトンネル用鍵ファイル保存場所としてご利用ください
        x64/
            SQLite.Interop.dll
        x86/
            SQLite.Interop.dll
        BouncyCastle.Cryptography.dll
        BouncyCastle.Cryptography.xml
        DatabaseDefine.exe                ※メインプログラム(起動プログラム)
        DatabaseDefine.exe.config
        DatabaseDefine.pdb
        DatabaseDefine.xml
        HtmlAgilityPack.dll
        HtmlAgilityPack.pdb
        HtmlAgilityPack.xml
        Microsoft.Bcl.AsyncInterfaces.dll
        Microsoft.Bcl.AsyncInterfaces.xml
        Microsoft.Bcl.HashCode.dll
        Microsoft.Bcl.HashCode.xml
        Microsoft.Extensions.DependencyInjection.Abstractions.dll
        Microsoft.Extensions.DependencyInjection.Abstractions.xml
        Microsoft.Extensions.Logging.Abstractions.dll
        Microsoft.Extensions.Logging.Abstractions.xml
        MySqlConnector.dll
        MySqlConnector.xml
        Npgsql.dll
        Npgsql.xml
        Oracle.ManagedDataAccess.dll
        Renci.SshNet.dll
        Renci.SshNet.xml
        sql_reserved_words.txt            ※記載した予約語はコンテンツ上で強調表示されます
        System.Buffers.dll
        System.Buffers.xml
        System.Collections.Immutable.dll
        System.Collections.Immutable.xml
        System.Diagnostics.DiagnosticSource.dll
        System.Diagnostics.DiagnosticSource.xml
        System.Formats.Asn1.dll
        System.Formats.Asn1.xml
        System.IO.Packaging.dll
        System.IO.Packaging.xml
        System.IO.Pipelines.dll
        System.IO.Pipelines.xml
        System.Memory.dll
        System.Memory.xml
        System.Numerics.Vectors.dll
        System.Numerics.Vectors.xml
        System.Runtime.CompilerServices.Unsafe.dll
        System.Runtime.CompilerServices.Unsafe.xml
        System.Text.Encodings.Web.dll
        System.Text.Encodings.Web.xml
        System.Text.Json.dll
        System.Text.Json.xml
        System.Threading.Channels.dll
        System.Threading.Channels.xml
        System.Threading.Tasks.Extensions.dll
        System.Threading.Tasks.Extensions.xml
        System.ValueTuple.dll

    output/
        backup/                           ※バックアップフォルダ
            databasedefine/
            databasedefinesubinfo/
            wwwdir/
        commonxml/
            commoninfo.xml
        ddl/                              ※DDLファイル出力フォルダ★
        excel/
            DatabaseDefine.xlsx           ※EXCELテーブル定義書★
        foreignkeyxml/
        indexxml/
        log/                              ※ログ出力フォルダ
        srcxml/
        tablexml/
        triggerxml/
        viewxml/
        wwwdir/                           ※コンテンツフォルダ(HTMLテーブル定義書)
            dbdef/
                css/
                    define.css
                    perfect-scrollbar.css
                db_src/
                entity/
                entity_fx/
                entity_idx/
                entity_trig/
                entity_view/
                images/
                    arrow1.png
                    arrow2.png
                    arrows.png
                    checked.png
                    favicon.ico
                    notchecked.png
                js/
                    common.js
                    data.js
                    database.js
                    disptitle.js
                    environment.js
                    jquery.min.js
                    pagetitle.js
                    perfect-scrollbar.min.js
                    realtimesearch.js
                    sql_reserved.js
                    sqlstatement.js
                    sqlstatement_parts.js
                    tables.js
                other/
                    CodeInfo.html
                dummy.html
                index.html                ※HTMLテーブル定義書★
    manual/
        images/
        manual.html                       ※当ファイル
        manual_cont.html
    licenses.txt
    readme.txt


目次へ

バージョンアップ内容 (直近)

Ver.8.2.0　　　(2025/06/25)

Ver.8.1.0　　　(2025/05/14)

Ver.8.0.0　　　(2025/04/09)


目次へ