🦔

EclipseでDBeaverを使う

2022/01/03に公開

Windows

eclipse

idea

1. 概要

DBクライアントでDBeaverというものがあるが、単体のソフトとしてだけでなく、Eclipseのプラグインとしても存在する(そもそもDBeaverはEclipseベースで作られている)。
そんなわけでEclipseのプラグインとしてのDBeaverの使い方をまとめる。
(単体のDBeaverも大体同じ使い方のはず)

2. インストール

インストールの仕方は3通りある。

新規ソフトウェアのインストール
Eclipseマーケットプレース
Webのマーケットプレースからドラッグ

どれでもいいんだけど、ひとまず新規ソフトウェアのインストールの手順を詳しくまとめる。あとの2つはざっとまとめる。

2.1. 新規ソフトウェアのインストール

基本のインストール方法。

手順

ヘルプ→新規ソフトウェアのインストールをクリック。
追加→名前にDBeaverと入力→ロケーションにhttps://dbeaver.io/update/latest/を入力→追加をクリック。
DBeaverとDBeaver Extensionsにチェックを入れる→次へをクリック。
※DBeaver Extensionsは必須ではないけど入れておいてもいいんじゃなかろうか、それぞれ何ができるか知らんけど。次の機能が含まれている。
- DBeaver Debug
- DBeaver Git support
- DBeaver Office Support
- DBeaver SVG Extension
インストールされる内容が改めて表示される。次へをクリック。
使用条件の条項に同意しますを選択→完了をクリック。
警告が出るがインストールをクリック。
証明書確認の画面が出る。チェックをいれて選択を受け入れるをクリック。
再起動を求められる。今すぐ再起動をクリック。再起動が終わったらインストールは完了している。

2.2. EclipseマーケットプレースとWEBのマーケットプレースの方法

新規ソフトウェアのインストールの方法がうまくいかない場合はこの方法を試すと良い。ざっとしか書かないけど…。

手順

2.2.1. Eclipseマーケットプレース

ヘルプからEclipseマーケットプレース。
DBeaverで検索するとプラグインが表示される。あとはよしなに。

2.2.2. Webのマーケットプレース

https://marketplace.eclipse.org/content/dbeaver にアクセス！
InstallボタンをEclipseにドラッグするといけるらしい。

3. 設定

DBeaverを使うにあたってやっておいた方がいい設定。
DBeaverの設定はEclipseの設定のデータベースの項目のところにある。

3.1. SQL実行時に空白行を区切りとして扱わない

デフォルトだと空白行がSQLの区切りとして扱われてしまい、空白行を含むSQLがうまく動かない。なのでこの設定をオフにする。

手順

データベース/エディター/SQLエディタ/SQL処理→デリミタグループ→空白行は文の区切り文字ですのチェックを外す。

3.2. テーブル名補完入力時にスキーマ名をつける

スキーマが複数あるデータベースの構成なら、スキーマ名がテーブル名に付くようにしておいたほうが良いかも。

手順

データベース/エディター/SQLエディタ/SQLの完了→長いオブジェクト名を使用するにチェックを入れる。

3.3. テーブル名補完時にエイリアスを付けない

デフォルトだとテーブル名に勝手にエイリアスをつけてくれるんだけど、邪魔な時が多いのでオフにする。

手順

データベース/エディター/SQLエディタ/SQLの完了→Insert table aliasesをN/Aにする。

3.4. トランザクションの終了時に自動コミットに戻さない

デフォルトだとオンになっているが、事故を防ぐためにオフの方がいいんじゃないかしら？まあお好みで。

手順

データベース/接続/トランザクション→トランザクションの終了時に自動コミットに戻すのチェックを外す。

3.5. 接続タイプの設定

DBeaverでは、DBに接続するときに接続タイプという設定を指定することができ、この接続タイプによってどのスキーマを表示するとか、この操作は制限する、とかが変わる。そしてデフォルトでどの接続タイプを使うかとか、その接続タイプの時にどういう挙動にするかとかはカスタムできる。

手順

3.5.1. デフォルトの接続タイプ

新規にDB接続設定をするときに、デフォルトでどの接続タイプを選ぶかを指定できる。
デフォルトで何を選ぶかの設定なだけで、DB接続設定をするときに別の接続タイプを選ぶこともできるので、ひとまず開発でもいいかもしれない。

データベース/接続→接続タイプで下記の中から選ぶ。
※この接続タイプ種類はデフォルトで存在するもので、設定を変更したり新しいものを追加することもできる(後述)

	開発	テスト	製品
デフォルトで自動コミット	ON	ON
SQL実行の確認			ON
Automatically end long idle transactions			ON
Confirm data changes		ON	ON

3.5.2. デフォルトのナビゲータービュー

デフォルトの接続タイプと同じところに「ナビゲーター」ビューの設定もある。これはデータベースナビゲーターというプロジェクトエクスプローラー的なところでどう表示するかの設定になっている。

下記の中から選ぶが、それぞれの設定はカスタマイズで変更することができる。

	Simple	Advanced
システムオブジェクトを表示する		ON
ユーティリティオブジェクトを表示する
Show only schemas and tables	ON
Show all tables in a single list

表示例

3.5.3. 接続タイプの編集

3.5.1. デフォルトの接続タイプで説明した接続タイプは、設定を変更したり新規の接続タイプを作ったりもできる。

データベース/接続/接続タイプ、の設定欄で変更ができる。細かいことは、触ってみて試してくださいな。

4. 使い方

PCのローカル環境にあるMySQLに接続する例で説明する。

4.1. DBeaverのパースペクティブを開く

パースペクティブにDBeaverが追加されているので、それを開く。

4.2. 接続設定を作成

手順

ツールバーにある接続アイコンをクリック。
接続するDBの種類を問われるので、MySQLを選択して次へをクリック。
データベース名・ユーザー名・パスワードを入力してテスト接続をクリック。
ドライバが無い場合、ドライバを自動ダウンロードするか聞かれるのでダウンロードをクリック。
※プロキシ環境等で自動ダウンロードできない場合は、手動でドライバを設定する必要がある。それはまあうまいことやって。
ドライバがダウンロードされ、問題なく接続できれば接続済みと表示されるのでOKをクリック。
1つ前のウィンドウに戻る。接続タイプ(3.5.を参照)を変更したい場合は接続の詳細をクリックして接続タイプを変更してから完了。接続タイプを変更しなくていい場合はそのまま完了をクリック。
データベースナビゲータ欄に、設定したデータベースが表示される。

4.3. DBへ接続してテーブルを開く

対象のDB接続設定をクリックして展開するだけで、DBへ接続する(接続されると✅マークが付く)。
更に、その中にあるテーブルをダブルクリックすればそのテーブルが開かれる。

4.4. SQLの実行

手順

SQLを実行したいデータベース(スキーマ)を選択した状態にする。
※選択しなくてもいいのだが、その場合結局あとでデータベースを選択する必要が出てくる。
ツールバーのSQLのアイコンをクリックするとScriptというファイル名でSQL欄が開かれる。
※この時、目的のデータベース(スキーマ)が選択されていることを確認する。そうでないとSQLの実行ができないし補完も効かなくなる。目的のデータベースでない場合はクリックして目的のデータベースを選択する。
あとはSQLを書く。fromの部分やカラムなどを書く部分でCtrl + Spaceを押せば補完候補が表示される。
SQLを書いたら、▶実行アイコンを押すかCtrl + EnterでSQLを実行することができる。

4.5. DBの切断

DB接続設定を閉じるだけでは切断されない。右クリックして切断するで切断できる。