画面機能詳細

メイン
- 設定内容：Information【①】
  設定内容を確認するためのエリア
- 設定機能：Settings【②】
  - 動作設定ボタン
    動作設定(Settings)画面を開きます
  - 補助情報設定ボタン
    補助情報設定Excelファイル(DatabaseDefineSubInfo.xlsx)を開きます
  - ユーティリティボタン
    Utility画面を開きます
- 実行機能：Execution【③】
  - テーブル構造取得①ボタン
    テーブルの構造情報を取得します。
  - コンテンツ生成②ボタン
    コンテンツ(HTML/EXCELテーブル定義書)を生成します。
  - 一括実行(①＋②)ボタン
    テーブル構造情報取得、コンテンツ(HTML/EXCELテーブル定義書)生成処理を一括して実行します。
  - EXCEL定義書チェックボタン
    Settings画面で設定したExcel定義書をチェックします。入力DBの”Type”を「Excel定義書」にした場合のみ使用できます。
    ( Excel定義書取込機能について )
  - DDL生成ボタン
    DDL文をテキスト出力します。
```
01.DROP_FOREIGN_KEY.txt
02.DROP_VIEW.txt
03.DROP_TABLE.txt
04.CREATE_TABLE_INDEX.txt
05.CREATE_VIEW.txt
06.ADD_FOREIGN_KEY.txt
```
- 参照機能：Reference【④】
  - コンテンツ参照ボタン
    生成したコンテンツ(HTMLテーブル定義書)をブラウザで表示します。
  - 実行ログ参照ボタン
    画面起動後の直近実行ログを表示します。
  - ログフォルダボタン
    ログが出力されているフォルダを開きます。
  - バックアップフォルダボタン
    バックアップが出力されているフォルダを開きます。
  - 定義書Excelフォルダボタン
    EXCEL版テーブル定義書が出力されるフォルダを開きます。
  - DDLフォルダボタン
    DDL文テキストファイルが出力されるフォルダを開きます。
- 進捗参照/処理中断機能：【⑤】
  - ①状況ボタン
    エクスプローラを起動し、テーブルごとのデータ抽出(csvファイル生成)状態を確認します。
  - ②状況ボタン
    エクスプローラを起動し、テーブルごとのページの生成(htmlファイル生成)状態を確認します。
  - 処理中断ボタン
    実行中の処理を中断します。

設定画面：Settings
※メイン画面の「動作設定」ボタンで開く画面です

インプット情報：Input【①】
※「Type」項目により設定項目は変化します
- Type(DBタイプ)
  データベースの種類を選択します(A5 ER図も選択肢となります)
  ※Oracle接続について
- Server
  データベースサーバーIP ( or ホストID)を入力します
- Port
  データベースへの接続ポートを入力します
  Typeで任意のDBを選択するとデフォルトポート番号が自動セットされますが、変更することも可能です
- TNS(Oracle選択時の接続文字)
  OracleへTNS接続するための接続文字列を入力します
- DB
  接続先データベースIDを入力します
- User
  データベースログインユーザーを入力します
- Pass
  データベースログインパスワードを入力します
- ～.a5er
  A5 ER図ファイルを選択します
- MySQL8.0 Over
  「Type」に”A5 ER図”を選択した場合、以下のチェックボックスが表示されます
  
  MySQLの場合ver.8.0から外部キー参照情報の保持のしかたが変更されています。DDL生成時に判別する必要がありますが、ER図はバージョン情報を保持していないため、このチェックボックスで指定する仕様としています。
- Also targets Synonyms
  「Type」に”Oracle”、”Oracle(直接接続)”を選択した場合、以下のチェックボックスが表示されます
  
  チェックをつけることでシノニムテーブルが対象になります。
- Excel
  Excel定義書ファイルを選択します
  ※Excel定義書取込機能について
- Class
  Excel定義書ファイルのタイプを選択します(A4横/A4縦/A5M2)
- DB(Type=”Excel定義書”選択時)
  Excel定義書ファイルでHTML版テーブル定義書を生成した場合の想定DBタイプを指定します(DDLコマンドなどの生成機能にてDBタイプを指定する必要があります)
- ExcelDefine Check
  Excel定義書ファイル取込を実施するときにExcel定義書の内容をチェック処理を実施するか否かのスイッチです。
- Check between sheets
  Excel定義書チェック実施時にシート間チェックも実施するか否かのスイッチです。
- Add Table (Excel)
  DBから取得するテーブルとは別に追加(更新)のテーブルがある場合に指定します。(手動で作成したテーブル定義書(EXCEL)です)
  システム機能拡張などで新規テーブルの追加や既存テーブルのカラム増減/変更があった場合を想定した機能です。物理DBに反映する前の設計段階でテーブル定義書に反映することができます。
  (イメージ)
- Class (Add Table用)
  追加Excel定義書ファイルの種別 ( A4横 / A4縦 / A5M2 ) を選択します。
- File (Add Table用)
  追加Excel定義書ファイルを選択します。対応フォーマットは当ツールの A4横タイプ / A4縦タイプの２種類に加え、A5M2で出力されるテーブル定義書の計３種類になります。

※Type別設定項目

Server

Port

TNS

User

Pass

～.a5er

MySQL8.0 Over

Also targets Synonyms

Excel

Class

DB(*)

ExcelDefine Check

Check between sheets

Add Table (Excel)～

A5 ER図

–

○

–

○

MySQL

○

–

○

–

○

PostgreSQL

○

–

○

–

○

Oracle(TNS)

–

○

–

○

–

○

–

○

Oracle(直接)

○

–

○

–

○

–

○

SQL Server
(Win認証)

○

–

○

–

○

SQL Server
(SQL認証)

○

–

○

–

○

Excel定義書

–

○

–

アウトプット情報：Output【②】
- HTML(チェック)
  HTMLテーブル定義書を出力したい場合にチェックします
- Color Set
  HTMLテーブル定義書のカラーリングを設定します
- EXCEL(チェック)
  EXCELテーブル定義書を出力したい場合にチェックします
  ※EXCEL版テーブル定義書にはテーブルレイアウト情報のみ出力されます(インデックス情報やビュー情報は出力されません)
- サイズ
  EXCEL定義書の出力サイズ(形式)を選択します
- 作成日(表紙)
  EXCEL定義書の表紙に出力する作成日を入力します
  ※ Todayチェックを付けるとシステム日付が自動的にセットされます
- バージョン(表紙)
  EXCEL定義書の表紙に出力するバージョンを入力します
  ※Optionチェックを付けると「Option」欄のバージョンラベルと同じ文言が自動的にセットされます
- 明細：バージョン出力(チェック)
  EXCEL定義書の明細シートのバージョン出力有無を制御します
- 明細：タグ出力(チェック)
  EXCEL定義書の明細シートのタグ情報出力有無を制御します
オプション設定：Option【③】
- タイトル
  ブラウザタイトル文字入力欄
  (画面)
  
  (ブラウザ)
- Label
  バージョンラベル入力欄
- Timestamp
  Dateチェック：日付を付加します
  Timestampチェック：日時を付加します
オプション設定：Option【④】
- Comment is Name(チェック)
  項目名にカラムのコメント情報を設定します
  ※コメント情報を項目名にする
- Table List Auto Create(チェック)
  自動的に対象テーブルを洗い出します。チェックなしの場合は、補助情報のテーブルリスト(table.csvシート)で指定されたテーブルが対象となります。
- Name is Comment (for DDL)(チェック)
  項目の論理名をコメントとします (DDL生成時に指定されます)
- Backup(チェック)
  テーブル定義書生成時に、バックアップをするか否かを指定します。対象は生成済の既存テーブル定義書(HTML/EXCEL)、補助情報ファイル(DatabaseDefineSubInfo.xlsx)です。保存先は .\DatabaseDefine\output\backup\ です。メイン画面の「バックアップフォルダ」ボタンよりアクセスできます。
- Upper Lower Id
  テーブルID、カラムID などの物理名を大文字/小文字変換します
  　　None：設定値のまま表示します
  　　abc → ABC：大文字化します
  　　ABC → abc：小文字化します
- Exclusion Tables (csv)
  除外対象のテーブルを指定します。複数入力したい場合はカンマ区切りします。* (アスタリスク)を使ったあいまい指定も可能です。
  ※Typeとして”Excel定義書”を指定している場合は、漢字などの入力も可能です
SSHトンネル接続設定：SSH【⑤】

※(参考) 当機能を使わずに Tera Term を利用した接続方法のページもあります
- SSHトンネル(チェック)
  SSHトンネル接続の有無
- SSH接続形式
  パスワード：パスワード認証
  鍵ファイル：秘密鍵ファイル認証
- SSH Host
  SSHトンネル接続するためのSSHサーバーIP
- User
  SSHトンネル接続するためのSSHサーバーのユーザーID.
- Pass
  SSHトンネル接続するためのSSHサーバーユーザーのパスワード
  ※秘密鍵ファイルのパスフレーズが未設定の場合は “null” と入力すると使用できます(ユーザー様が発見してくれました！)
- 鍵ファイル
  踏み台サーバーに接続するための秘密鍵ファイルを選択
  ※接続形式を「鍵ファイル」にした場合に必要。秘密鍵ファイルのパスを入力します。秘密鍵はPEM形式のみの対応。
処理
- テスト接続ボタン
  入力したDB接続情報でDBに接続できるかをテストします。
- 保存ボタン
  入力した設定内容を保存します。(define.ini)
- 閉じるボタン
  「Settings」画面を(保存せずに)閉じます。

補助画面：Utility
- テンプレートExcel(補助用)ボタン
  空の DatabaseDefineSubInfo.xlsx をダウンロードします ( コード定義情報などの補助情報用Excelテンプレートファイル )
  ※既に DatabaseDefineSubInfo.xlsx が存在する場合はバックアップされます
- テンプレートExcel(取込用)ボタン
  空の DatabaseDefine_A4●.xlsx をダウンロードします ( 取込用Excelテンプレートファイル )
  ※”Class”にて A4横 / A4縦を選択します。このファイルにDBレイアウトを記述(設計作業)してから取り込みます。
- 補助情報Excel整形ボタン
  ./excel/DatabaseDefineSubInfo.xlsx のデータを整形します
  同一データ(重複)の排除
  データの並び替え(table.csvのみ並び替えは行われません)
  ※元の DatabaseDefineSubInfo.xlsx はバックアップされます。
- CSV→Excel生成ボタン
  補助情報のcsvファイルからExcelファイルを生成します
  csvファイルが保存してあるフォルダを選択します
  
  ※既に DatabaseDefineSubInfo.xlsx が存在する場合はバックアップされます。旧バージョンでは補助情報をCSVファイルでのみ管理していたため、新バージョンを使う場合はこの操作で DatabaseDefineSubInfo.xlsxを生成する必要があります。

使い方へ