LoginSignup
2
0

[TiDB] GUI SQLツールからTiDB Serverlessへの接続方法

Last updated at Posted at 2023-12-13

はじめに

みなさんTiDBに接続する際には何を使っていますか?
TiDB Cloudの接続時に接続方法が表示されるMySQL clientやMyCLIなどのコマンドラインクライアントももちろんですが、GUIクライアントでの接続も多いのではないかと思います。

TiDB Serverlessに接続する際にはTLS接続が必須となるため、クライアントによってはTLSの設定に何を設定すれば良いか困るケースもあります。ここでは、いくつかの代表的なGUIクライアントの接続方法を見ていきたいと思います。

CAファイルの取得

つい先日のアップデートで、TiDB Serverlessの接続画面からCAファイルがダウンロードできるようになりました!

TiDB Serverlessの接続画面で、Operating SystemでWindowsを選択してください。
このときに表示されるリンクから、CAファイルがダウンロード可能です。

スクリーンショット 2023-12-13 9.28.45.png

CAファイルの取得(従来の方法)

以下の記載は古い方法ですが、参考の為残しておきます

ドキュメントに記載されているように、TiDB Serverlessのサーバ証明書はLet's Encryptが発行しているものを利用しているので、下記のファイルをダウンロードしておきます。

Mozillaのバンドルには複数のルート証明書が含まれているのでドキュメントではそちらを推奨していますが、複数の証明書が含まれているのを許容しないようなクライアントでは ISRG Root X1の方を使うようにと記載してあります。
ただ今回紹介するクライアントはすべてMozilla CA証明書バンドルを受け付けましたので、cacert.pemだけで問題ありません。

DBeaver (Mac/Linux/Windows)

クロスプラットフォームで動作するクライアントで、MySQL系以外にもさまざまなデータベースをサポートしています。

接続設定

TiDBもサポートされています。データベース接続画面からTiDBを選択。
image.png

接続設定ではホストデータベースユーザー名パスワードを指定。ポートは最初から4000になっているのでそのまま
スクリーンショット 2023-12-04 7.52.11.png

SSLタブで、SSLを使用するにチェックを入れ、CA Certificateに、ダウンロードしたCA証明書バンドルを指定します。
スクリーンショット 2023-12-04 7.57.05.png

これでOKです。

image.png

VSCode (SQLTools) (Mac/Linux/Windows)

VSCode上からデータベースに接続できるプラグインの中から、今回はSQL Toolsを取り上げます。
データベース毎のドライバがあり、ドライバをインストールすることで様々なデータベースに接続できるようになっています。

拡張機能のインストール

VSCodeの拡張機能管理画面から、SQLToolsSQLTools MySQL/MariaDB/TiDBをインストールします
image.png
image.png

接続設定

拡張機能をインストールすると、左側にアイコンができるのでそれをクリックし、New Connectionから接続設定を行います。
はじめにTiDBを選択し、
image.png

Connection name(何でも良い)、Server AddressPortDatabaseUsername をセットします。パスワードは後から聞かれます。
スクリーンショット 2023-12-04 8.12.51.png

画面を下にスクロールして、SSLをEnableにして、証明書バンドルのパスを設定します。
スクリーンショット 2023-12-04 8.15.34.png

Test Connection時にパスワードの入力を求められるのでパスワードを入力すればOKです。
スクリーンショット 2023-12-04 8.19.31.png

HeidiSQL (Windows)

Windowsで動作するGUIクライアントです。様々なDBに接続できます。
TiDB接続用の設定はなく、MySQL/MariaDBとして接続します。

接続設定

ドライバとしてMySQL/MariaDBを選択し、HostnameUserPasswordPortを設定します。
heidisql-1.png

SSLタブで、SSLの有効化と証明書バンドルのパスを設定します。
heidisql-2.png

これでOKです。
heidisql-3.png

Sequel Ace (Mac)

Macで動作するGUIクライアントです。MySQL/MariaDB用です。

接続設定

HostUsernamePasswordDatabasePortを設定して、Require SSLにチェックを入れます。
CA Certに証明書バンドルのパスを設定します。
スクリーンショット 2023-12-04 8.54.22.png

これでOKです。
image.png

2
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
0