昔の dbflute Intro (for Java6)

※こちらは、Java6 の dbflute 用の dbflute Intro です。

新機能や改善など、Java8版の方がメインに開発されていますので、特に大きな理由がなければJava8版をご利用ください。

Alto dbflute の利用を支援するための、IDEなどに依存しない独立したGUIツールです。

• dbflute Introとは？
• Introのダウンロード
• 使い方の流れ
• dbflute Intro を起動
• まずはdbfluteダウンロード
  • dbfluteダウンロード画面
• つなぐDBの情報を入れる
  • DB情報入力画面
  • 入力項目の仕様
  • DB接続URLの指定
  • JDBCドライバの指定
• そして、ドキュメント生成 (SchemaHTML)
  • Introのトップ画面の例
  • ドキュメント生成ボタン
  • SchemaHTML表示リンク
  • DB接続に失敗したら...
• DB変更したら、また生成 (HistoryHTML)
  • HistoryHTML表示リンク
• まだまだこれから
• dbflute本体はどこに？

dbflute Introとは？

アプリの外側で活躍するdbfluteの機能 (Alto dbflute) を、インストールから実行までGUIだけで実行できるツールです。 Javaの実行環境(JRE)さえあれば利用できる導入しやすいツールです。

Github で開発されているオープンソースです。 dbflute本体とは、独立した運用がされていますので、本家のサイトにも注目です。(ということで、ここでは、簡単な利用方法の説明だけをしていきます)

Introのダウンロード

インストールという概念はありません。単にファイル (.jar or .exe) を一つダウンロードするだけです。

こちらののリンクからダウンロードできます。

Mac

dbflute-intro.jar

Windows

dbflute-intro.zip ※zip形式になっているので要解凍

そして、以下のよう感じで、どこかのディレクトリに入れておくと良いでしょう。

e.g. dbflute Intro のファイルを dbflute-intro ディレクトリ配下に @Directory
...
 |-...
 |
 |-dbflute-intro
 |  |
 |  |-dbflute-intro.jar     // Windows なら .exe
 |
 |-...

使い方の流れ

1. dbflute Intro を実行
2. まずはdbfluteダウンロード
3. つなぐDBの情報を入れる
4. そして、ドキュメント生成 (SchemaHTML)
5. DB変更したら、また生成 (HistoryHTML)

dbflute Intro を起動

Mac

dbflute-intro.jar をダブルクリック ※一番最初だけ右クリック "開く" で叩く必要あり

Windows

dbflute-intro.exe をダブルクリック

まずはdbfluteダウンロード

dbflute Intro を起動すると、以下のような画面が表示され、最新版のバージョン番号があらかじめ入っています。そのまま "OK" を押してみましょう。早速 dbflute のダウンロードが始まります。

dbfluteダウンロード画面

dbfluteダウンロード画面の例

つなぐDBの情報を入れる

ダウンロードが無事終わると、今度は接続するデータベース(スキーマ)の情報を入力する画面が表示されます。 DBMSの種類、接続URL、接続ユーザーとパスワードなどを入力してDB接続環境を作成します。

DB情報入力画面

DB情報入力画面の例

入力項目の仕様

以下、それぞれの入力項目の仕様に従った入力していきます。(*)は必須項目

DB名(*)

接続対象のDB環境を表す任意の名前 ※別に yourdb のままでもOK

DBMS(*)

DBの種類 e.g. MySQL, PostgreSQL, Oracle など

URL(*)

DBに接続するためのURL ※先にDBMSを選択するとひな形が自動入力される

スキーマ

接続するスキーマ ※OracleやDB2では大文字で、MySQLでは不要

ユーザ(*)

接続するDBユーザ ※接続スキーマに対応するユーザ

パスワード

DBユーザのパスワード ※間違えないように...

JDBCドライバのパス

JDBCドライバをドラッグ＆ドロップする ※MySQL, PostgreSQL, H2では不要

dbfluteのバージョン(*)

利用するdbfluteのバージョン ※基本そのままで

他のDB環境

複数のDB環境を対象にする場合に増やせる ※後でできるのでひとまずスルー

DB接続URLの指定

DB接続のURLは、DBMSを選択することで自動入力されるURLひな形の xxx 部分にデータベース名もしくはスキーマ名を入力します。例えば、以下のような感じになります。

MySQL

jdbc:mysql://localhost:3306/exampledb

PostgreSQL

jdbc:postgresql://localhost:5432/exampledb

Oracle

jdbc:oracle:thin:@localhost:1521:XE

DB2

jdbc:db2://localhost:50000/dfexdb

SQLServer

jdbc:sqlserver://localhost:1433;databaseName=exampledb;

H2 Database

jdbc:h2:file:../src/main/resources/exampledb/exampledb

Apache Derby

jdbc:derby:../src/main/resources/librarydb;create=true

JDBCドライバの指定

dbflute Intro は "JDBCドライバ" を利用して接続するため、JDBCドライバが dbflute に同梱されていないDBMS(同梱が許されていないDBMS)の場合は、自分でダウンロードする必要があります。

MySQL

同梱されているので指定不要 ※mysql-connector-java-5.1.12-bin.jar

PostgreSQL

同梱されているので指定不要 ※postgresql-8.4-701.jdbc3.jar

Oracle

"ojdbc6.jar ダウンロード" で検索してダウンロード画面へ

DB2

"db2jcc.jar ダウンロード" で検索してダウンロード画面へ

SQLServer

"sqljdbc4.jar ダウンロード" で検索してダウンロード画面へ

H2 Database

同梱されているので指定不要 ※h2-1.3.xxx.jar

Apache Derby

"derby ダウンロード" で検索してダウンロード画面へ

ダウンロードしたら、dbflute Intro のDB情報入力画面に "JDBCドライバのパス" のテキストボックスにドラッグ＆ドロップしてください。 (DB接続環境の作成後にJDBCドライバはdbflute内にコピーされるので、その後はダウンロードしたJDBCドライバは削除しても構いません)

そして、ドキュメント生成 (SchemaHTML)

DB接続環境の作成が終わると、dbflute Intro のトップ画面が表示されます。この画面から様々な dbflute の操作ができますが、まずはドキュメントを生成しましょう。

Introのトップ画面の例

Introのトップ画面の例

ドキュメント生成ボタン

"ドキュメント生成" ボタンを押すと、DB接続してスキーマ情報を抽出し、ドキュメント生成します。

SchemaHTML表示リンク

ドキュメント生成に成功したら、SchemaHTML表示リンクをクリックしてみましょう。

すると、ブラウザが起動して、SchemaHTML が表示されます。

SchemaHTML Example

DB変更したら、また生成 (HistoryHTML)

DBが変わったら、またドキュメント生成をしましょう。

ドキュメント生成ボタンを押して SchemaHTML を開くと、新しいスキーマの情報が表示されます。

HistoryHTML表示リンク

そして、HistoryHTMLリンクをクリックしてみましょう。DB変更の履歴が表示されます。

HistoryHTMLの例

e.g. dbflute Intro のファイルを dbflute-intro 配下に @Directory
どこかのディレクトリ
 |-...
 |
 |-dbflute-intro
 |  |-mydbflute
 |  |  |-dbflute-1.x.x
 |  |
 |  |-dbflute_xxx      // DB名が yourdb なら dbflute_yourdb
 |  |  |-dfprop        // DB接続情報が保持されている、その他もろもろの設定
 |  |  |-log           // dbflute実行時のログ
 |  |  |-...
 |  |
 |  |-dbflute-intro.jar
 |
 |-...