DBeaverによるデータベースへの接続

DBeaverは汎用のデータベースクライアントツールであり、各データベースが提供するJDBCドライバを使用してデータベースに接続します。一般的なリレーショナルデータベース、非リレーショナルデータベース、分散型データベースなどをサポートしています。

DBeaverに組み込まれているOceanBaseドライバまたはMySQLドライバのいずれかを使用して、OceanBaseデータベースのMySQLテナントに接続できます。本記事では、OceanBaseドライバを例に、DBeaverを使用してOceanBaseデータベースのMySQLテナントに接続する方法を説明します。

前提条件

• DBeaverを入手し、インストール済みであることを確認してください。DBeaver公式ダウンロードURLから、ご使用のシステムに対応するDBeaverをダウンロードしてください。

• 接続対象のOBServerノードのIPアドレスとDBeaverが稼働しているマシン間でネットワーク接続が確立されていることを確認してください。

• OceanBaseデータベースをインストール済みで、MySQLモードのテナントが作成されていることを確認してください。

手順

ステップ１：データベース接続文字列の取得

OceanBaseデータベースのデプロイ担当者または管理者から、該当するデータベース接続文字列を取得します。例：

obclient -h$host -P$port -u$user_name -p$password -D$database_name

パラメータ説明：

• $host：OceanBaseデータベースへの接続IPアドレス。OceanBaseデータベースプロキシ(OceanBase Database Proxy、ODP)接続方式ではODPアドレスを使用し、直接接続方式ではOBServerノードのIPアドレスを使用します。

• $port：OceanBaseデータベースへの接続ポート。ODP接続方式のデフォルトポートは2883で、ODPデプロイ時にカスタマイズ可能です。直接接続方式のデフォルトポートは2881で、OceanBaseデータベースのデプロイ時にカスタマイズ可能です。

• $database_name：アクセス対象のデータベース名。

  注意

  テナントに接続するユーザーは、データベースに対する CREATE、INSERT、DROP、および SELECT 権限が付与されていなければなりません。その他のユーザー権限の詳細については、MySQLモードの権限分類を参照してください。

• $user_name：テナントの接続アカウント。ODP接続の一般的な形式：ユーザー名@テナント名#クラスタ名またはクラスタ名:テナント名:ユーザー名。直接接続方式の形式：ユーザー名@テナント名。

• $password：アカウントのパスワード。

その他の接続文字列の情報については、OBClientを使用したOceanBaseテナントへの接続を参照してください。

例：

obclient -hxxx.xxx.xxx.xxx -P2881 -utest_user001@mysql001 -p****** -Dtest

ステップ2：DBeaverコンソールを使用してOceanBaseデータベースに接続する

1. （オプション）ドライバーファイルのバージョンを変更します。

   DBeaverにおけるOceanBaseドライバーのデフォルトのドライバーファイルはmysql-connector-java-5.1.44です。このドキュメントではmysql-connector-java-5.1.47を例に説明します。ドライバーファイルの変更については、以下の手順を参考にしてください。

   1. MySQL公式JDBCドライバーのダウンロードページにアクセスし、5.1.47バージョンのドライバーファイルをダウンロードします。

   2. データベース > ドライバーマネージャー をクリックし、OceanBaseを検索します。OceanBaseドライバーを選択して編集をクリックすると、ドライバーの編集ページに入ります。

   3. ライブラリタブを選択し、OceanBaseドライバーに付属するドライバーファイルを選択して削除をクリックします。

   4. ファイルの追加をクリックして、ダウンロードしたドライバーファイルをライブラリに追加し、OKをクリックするとドライバーファイルの変更が完了します。

2. データベース > 新しいデータベース接続をクリックし、データベースの選択ページに入ります。ファイルの下のコネクター をクリックして、直接データベースの選択ページに入ることもできます。

3. データベースの選択ページでOceanBaseを選択し、次へをクリックします。接続設定ページに入り、Host、Port、Tenant、ユーザー名、パスワードを入力し、接続テストをクリックします。

   説明

   データベースへの接続には、IPアドレスによる直接接続とOBProxy経由での接続の2つの方法があります。直接接続する場合は、Portに設定されたmysql_portを入力します。デフォルトポートは2881です。OBProxyを使用して接続する場合は、Portに設定されたproxy_portを入力します。デフォルトポートは2883です。

4. 接続テストのポップアップウィンドウに接続済みと表示されれば、接続に成功しています。OKをクリックし、完了をクリックするとOceanBaseデータベースに接続できます。

5. データベースナビゲーションバーのデータベース名をダブルクリックし、以下のように展開されれば、OceanBaseデータベースへの接続に成功しています。

詳細を見る

DBeaverでOceanBaseデータベースに接続する際に問題が発生した場合は、DBeaverクライアント公式ドキュメントを参照することをお勧めします。