MySQL Workbenchを使用してTiDBに接続する
TiDBはMySQL互換データベースであり、 MySQL WorkchenはMySQLデータベースユーザー向けのGUIツールセットです。
このチュートリアルでは、MySQL Workbenchを使用してTiDBに接続する方法を学ぶことができます。
前提条件
このチュートリアルを完了するには、以下が必要です。
- MySQL Workchen 8.0.31以降のバージョン。
- TiDBクラスタ。
TiDBクラスタをお持ちでない場合は、以下の手順で作成できます。
- (推奨) TiDB Cloud Starterインスタンスを作成する。
- ローカルテスト用のTiDB Self-Managedクラスタをデプロイまたは本番のTiDB Self-Managedクラスタをデプロイ
TiDBに接続する
選択したTiDBのデプロイオプションに応じて、TiDBに接続してください。
My TiDBページに移動し、対象のTiDB Cloud StarterまたはEssentialインスタンスの名前をクリックして、概要ページに移動します。
右上隅のConnectをクリックしてください。接続ダイアログが表示されます。
接続ダイアログの設定がご使用のオペレーティング環境と一致していることを確認してください。
- Connection Typeは
Publicに設定されています。 - Branchは
mainに設定されています。 - Connect Withは
MySQL Workbenchに設定されています。 - お使いの環境に合ったOperating Systemを選択してください。
- Connection Typeは
Generate Passwordをクリックすると、ランダムなパスワードが生成されます。
MySQL Workbenchを起動し、 MySQL Connectionsタイトルの横にある+をクリックします。
Setup New Connectionダイアログで、以下の接続パラメータを設定します。
Connection Name:この接続に分かりやすい名前を付けてください。
Hostname: TiDB Cloud接続ダイアログから
HOSTパラメータを入力します。Port: TiDB Cloud接続ダイアログから
PORTパラメータを入力します。Username: TiDB Cloud接続ダイアログから
USERNAMEパラメータを入力してください。Password: Store in Keychain ...またはStore in Vaultをクリックし、手順4で作成したパスワードを入力して、 OKをクリックしてパスワードを保存します。
次の図は、接続パラメータの例を示しています。
Test Connectionをクリックして、対象のTiDB Cloud StarterまたはEssentialインスタンスへの接続を検証してください。
接続テストが成功すると、 Successfully made the MySQL connectionというメッセージが表示されます。 OKをクリックして接続設定を保存してください。
My TiDBページに移動し、対象のTiDB Cloud Premiumインスタンスの名前をクリックして概要ページに移動します。
左側のナビゲーションペインで、 Settings > Networkingをクリックします。
Networkingページで、Public EndpointのEnableをクリックし、次にAdd IP Addressをクリックします。
クライアントのIPアドレスがアクセスリストに追加されていることを確認してください。
左側のナビゲーションペインでOverviewをクリックすると、インスタンスの概要ページに戻ります。
右上隅のConnectをクリックしてください。接続ダイアログが表示されます。
接続ダイアログで、 Connection TypeドロップダウンリストからPublicを選択します。
- 公開エンドポイントがまだ有効化中であることを示すメッセージが表示された場合は、処理が完了するまでお待ちください。
- まだパスワードを設定していない場合は、ダイアログのSet Root Passwordをクリックしてください。
- サーバー証明書を確認する必要がある場合、または接続に失敗して認証局(CA)証明書が必要な場合は、 CA certをクリックしてダウンロードしてください。
- Public接続タイプに加えて、 TiDB Cloud Premium はPrivate Endpoint接続をサポートします。詳細については、 AWS PrivateLink経由でTiDB Cloud Premiumに接続しますを参照してください。
MySQL Workbenchを起動し、 MySQL Connectionsタイトルの横にある+をクリックします。
Setup New Connectionダイアログで、以下の接続パラメータを設定します。
- Connection Name:この接続に分かりやすい名前を付けてください。
- Hostname: TiDB Cloud接続ダイアログから
HOSTパラメータを入力します。 - Port: TiDB Cloud接続ダイアログから
PORTパラメータを入力します。 - Username: TiDB Cloud接続ダイアログから
USERNAMEパラメータを入力してください。 - Password: Store in Keychain ...またはStore in Vaultをクリックし、 TiDB Cloud Premiumインスタンスのパスワードを入力して、 OKをクリックするとパスワードが保存されます。
Test Connectionをクリックして、 TiDB Cloud Premiumインスタンスへの接続を検証してください。
接続テストが成功すると、 Successfully made the MySQL connectionというメッセージが表示されます。 OKをクリックして接続設定を保存してください。
My TiDBページに移動し、対象のTiDB Cloud Dedicatedクラスタの名前をクリックして概要ページに移動します。
右上隅のConnectをクリックしてください。接続ダイアログが表示されます。
接続ダイアログで、 Connection TypeドロップダウンリストからPublicを選択し、 CA certをクリックしてCA証明書をダウンロードします。
IP アクセス リストを設定していない場合は、最初の接続の前に、 Configure IP Access Listをクリックするか、IP アクセス リストを設定するの手順に従って設定します。
TiDB Cloud Dedicated は、Public接続タイプに加えて、Private EndpointおよびVPC Peering接続タイプもサポートしています。詳細については、 TiDB Cloud Dedicatedクラスタに接続しますを参照してください。
MySQL Workbenchを起動し、 MySQL Connectionsタイトルの横にある+をクリックします。
Setup New Connectionダイアログで、以下の接続パラメータを設定します。
Connection Name:この接続に分かりやすい名前を付けてください。
Hostname: TiDB Cloud接続ダイアログから
HOSTパラメータを入力します。Port: TiDB Cloud接続ダイアログから
PORTパラメータを入力します。Username: TiDB Cloud接続ダイアログから
USERNAMEパラメータを入力してください。Password: Store in Keychain ...をクリックし、 TiDB Cloud Dedicatedクラスタのパスワードを入力して、 OKをクリックするとパスワードが保存されます。
次の図は、接続パラメータの例を示しています。
Test Connectionをクリックして、 TiDB Cloud Dedicatedクラスターへの接続を検証してください。
接続テストが成功すると、 Successfully made the MySQL connectionというメッセージが表示されます。 OKをクリックして接続設定を保存してください。
MySQL Workbenchを起動し、 MySQL Connectionsタイトルの横にある+をクリックします。
Setup New Connectionダイアログで、以下の接続パラメータを設定します。
Connection Name:この接続に分かりやすい名前を付けてください。
Hostname:TiDB Self-ManagedクラスタのIPアドレスまたはドメイン名を入力してください。
Port:TiDB Self-Managedクラスタのポート番号を入力してください。
Username:TiDBに接続するために使用するユーザー名を入力してください。
Password: Store in Keychain ...をクリックし、TiDB Self-Managedクラスタへの接続に使用するパスワードを入力して、 OKをクリックしてパスワードを保存します。
次の図は、接続パラメータの例を示しています。
Test Connectionをクリックして、TiDB Self-Managedクラスタへの接続を検証してください。
接続テストが成功すると、 Successfully made the MySQL connectionというメッセージが表示されます。 OKをクリックして接続設定を保存してください。
よくある質問
接続タイムアウトエラー「エラーコード:2013。クエリ実行中にMySQLサーバーへの接続が失われました」への対処方法を教えてください。
このエラーは、クエリの実行時間がタイムアウト制限を超えたことを示しています。この問題を解決するには、以下の手順でタイムアウト設定を調整してください。
MySQL Workbenchを起動し、 Workbench Preferencesページに移動します。
SQL Editor > MySQL Sessionセクションで、 DBMS connection read timeout interval (in seconds)オプションを設定します。これは、MySQL Workbenchがサーバーから切断されるまでにクエリが実行できる最大時間(秒単位)を設定します。
詳細については、 MySQL Workbench frequently asked questionsを参照してください。
次のステップ
- MySQL Workbench の使用法の詳細についてはMySQL Workbenchのドキュメントを参照してください。
- 開発者ガイド の データを挿入する、データの更新、データを削除する、単一表の読み取り、トランザクション、SQLパフォーマンス最適化 などの章を参考に、TiDB アプリケーション開発のベストプラクティスを学びます。
- プロフェッショナルなTiDB開発者向けコースコースを通じて学習し、試験に合格するとTiDB認定資格を取得します。
お困りですか?
- Discordor Slackコミュニティに質問してください。
- TiDB Cloudのサポートチケットを送信してください
- TiDB Self-Managedのサポートチケットを送信してください







