DBeaverは汎用的なデータベースクライアントツールであり、各データベースが提供するJDBCドライバーを使用してデータベースに接続します。リレーショナルデータベース、非リレーショナルデータベース、分散データベースなど、一般的なデータベースに対応しています。
DBeaverに搭載されているOceanBaseドライバーまたはMySQLドライバーのいずれかを使用して、OceanBaseデータベースのMySQLテナントに接続できます。本記事では、OceanBaseドライバーを例に、DBeaverを使用してOceanBaseデータベースのMySQLテナントに接続する方法を紹介します。
前提条件
DBeaverを取得しインストール済みであることを確認してください。DBeaver公式ダウンロードURLから、お使いのシステムに対応するDBeaverをダウンロードしてください。
接続するOBServerノードのIPアドレスとDBeaverが配置されているマシンとの間でネットワーク接続が確立されていることを確認してください。
OceanBaseデータベースがインストール済みで、MySQLモードのテナントが作成されていることを確認してください。
操作手順
ステップ1:データベース接続文字列を取得する
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データベースに接続する
説明
DBeaverのバージョンによって操作画面が異なる場合があります。この記事では、DBeaver 22.0.5を例にデータベース接続のステップを説明します。他のバージョンでの操作については、DBeaverの対応するバージョンのプロダクトドキュメントを参照してください。
(オプション)ドライバーファイルのバージョンを変更します。
DBeaver内のOceanBaseドライバーのデフォルトのドライバーファイルはmysql-connector-java-5.1.44です。この記事ではmysql-connector-java-5.1.47を例に説明します。ドライバーファイルの変更については次のステップを参照してください。
MySQL公式JDBCドライバーのダウンロード URLから5.1.47バージョンのドライバーファイルをダウンロードします。
データベース>ドライバーマネージャーをクリックし、OceanBaseを検索します。OceanBaseドライバーを選択し、編集をクリックしてドライバー編集ページに入ります。
ライブラリタブを選択し、OceanBaseドライバーに付属するドライバーファイルを選択して削除をクリックします。
ファイルの追加をクリックして、ダウンロードしたドライバーファイルをライブラリに追加し、OKをクリックするとドライバーファイルの置き換えが完了します。
データベース>データベース接続の新規作成をクリックして、データベースの選択ページに入ります。ファイルの下のコネクター
をクリックすることで、直接データベースの選択ページに入ります。データベースの選択ページでOceanBaseを選択し、次へをクリックします。接続の設定ページに入り、
Host、Port、Tenant、ユーザー名、パスワードを入力し、接続テストをクリックします。説明
データベースへの接続には、IPアドレスによる直接接続と、OBProxy経由での接続という2つの方法があります。直接接続する場合は、Portに
mysql_portの値を入力します。デフォルトのポートは2881です。OBProxyを使用して接続する場合は、Portにproxy_portを入力します。こちらのデフォルトポートは2883です。接続テストのポップアップウィンドウに接続済みと表示されれば接続成功です。OKをクリックした後に完了をクリックすると、OceanBaseデータベースに接続できます。
データベースナビゲーションバーのデータベース名をダブルクリックし、情報が正しく表示されれば、OceanBaseデータベースへの接続は成功です。
詳細情報
DBeaverを使用してOceanBaseデータベースに接続する際に問題が発生した場合は、DBeaverクライアント公式使用ドキュメントを参照することを推奨します。