Visual Studio Codeを使用してTiDBに接続する
TiDB は MySQL 互換データベースであり、 Visual Studio Code (VS Code)は軽量かつ強力なソース コード エディターです。このチュートリアルでは、TiDB を公式ドライバーとしてサポートするSQLツール拡張機能を使用します。
このチュートリアルでは、Visual Studio Code を使用して TiDB に接続する方法を学ぶことができます。
注記:
- このチュートリアルは、 TiDB Cloud Starter、 TiDB Cloud Essential、 TiDB Cloud Dedicated、およびTiDB Self-Managedに対応しています。
- このチュートリアルは、 GitHub Codespaces 、Visual Studio Visual Studio Code 開発コンテナVisual Studio Code WSL Code リモート開発環境でも動作します。
前提条件
このチュートリアルを完了するには、以下が必要です。
- Visual Studio Code 1.72.0以降のバージョン。
- SQLTools MySQL/MariaDB/TiDB拡張機能です。インストールするには、以下のいずれかの方法を使用できます。
- このリンクをクリックするとVS Codeが起動し、拡張機能を直接インストールできます。
- VS Code マーケットプレイスに移動し、 [インストール]をクリックします。
- VS Code の[拡張機能]タブで
mtxr.sqltools-driver-mysqlを検索してSQLTools MySQL/MariaDB/TiDB拡張機能を取得し、 [インストール] をクリックします。
- TiDBクラスタ。
TiDBクラスタをお持ちでない場合は、以下の手順で作成できます。
TiDBに接続する
選択したTiDBのデプロイオプションに応じて、TiDBに接続してください。
私のTiDBページに移動し、対象のTiDB Cloud StarterまたはEssentialインスタンスの名前をクリックして、概要ページに移動します。
右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。
接続ダイアログの設定がご使用のオペレーティング環境と一致していることを確認してください。
接続タイプは
Publicに設定されています。ブランチは
mainに設定されています。「接続」は
VS Codeに設定されています。お使いの環境に合ったオペレーティングシステムを選択してください。
ヒント:
VS Code をリモート開発環境で実行している場合は、リストからリモートのオペレーティングシステムを選択してください。たとえば、Windows Subsystem for Linux (WSL) を使用している場合は、対応する Linux ディストリビューションに切り替えてください。GitHub Codespaces を使用している場合は、この操作は不要です。
「パスワードを生成」をクリックすると、ランダムなパスワードが生成されます。
ヒント:
以前にパスワードを作成したことがある場合は、元のパスワードを使用するか、 「パスワードをリセット」をクリックして新しいパスワードを生成できます。
VS Codeを起動し、ナビゲーションペインでSQLTools拡張機能を選択します。 [接続]セクションで[新しい接続を追加]をクリックし、データベースドライバとしてTiDBを選択します。
設定画面で、以下の接続パラメータを設定します。
接続名:この接続に分かりやすい名前を付けてください。
接続グループ:(オプション)この接続グループに分かりやすい名前を付けます。同じグループ名を持つ接続はグループ化されます。
接続方法:サーバーとポートを選択してください。
サーバーアドレス: TiDB Cloud接続ダイアログから
HOSTパラメータを入力します。ポート: TiDB Cloud接続ダイアログから
PORTパラメータを入力します。データベース:接続したいデータベースを入力してください。
ユーザー名: TiDB Cloud接続ダイアログから
USERNAMEパラメータを入力してください。パスワードモード: SQLToolsDriver認証情報を選択します。
MySQLドライバ固有のオプション領域で、以下のパラメータを設定します。
認証プロトコル:デフォルトを選択してください。
SSL : [有効]を選択します。TiDB Cloud Starterは安全な接続を必要とします。SSLオプション(node.TLSSocket)領域で、 TiDB Cloud接続ダイアログの
CAパラメーターを[認証局(CA)証明書ファイル]フィールドに設定してください。注記:
Windows または GitHub コードスペースで実行している場合は、 SSL を空白のままにすることができます。デフォルトでは、SQLTools は Let's Encrypt によって厳選された有名な CA を信頼します。詳細については、 TiDB Cloud Starterルート証明書管理参照してください。
「接続テスト」をクリックして、対象のTiDB Cloud StarterまたはEssentialインスタンスへの接続を検証してください。
ポップアップウィンドウで「許可」をクリックします。
SQLToolsDriver認証情報ダイアログで、手順4で作成したパスワードを入力します。
接続テストが成功すると、「接続に成功しました!」というメッセージが表示されます。 「接続を保存」をクリックして、接続設定を保存してください。
私のTiDBページに移動し、対象のTiDB Cloud Dedicatedクラスタの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。
接続ダイアログで、「接続タイプ」ドロップダウンリストから「パブリック」を選択し、 「CA証明書」をクリックしてCA証明書をダウンロードします。
IP アクセス リストを設定していない場合は、最初の接続の前に、 [IP アクセス リストの設定] をクリックするか、「IP アクセス リストを設定する」の手順に従ってIPアクセスリストを設定する。
TiDB Cloud Dedicated は、パブリック接続タイプに加えて、プライベート エンドポイントおよびVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud Dedicatedクラスタに接続します参照してください。
VS Codeを起動し、ナビゲーションペインでSQLTools拡張機能を選択します。 [接続]セクションで[新しい接続を追加]をクリックし、データベースドライバとしてTiDBを選択します。
設定画面で、以下の接続パラメータを設定します。
接続名:この接続に分かりやすい名前を付けてください。
接続グループ:(オプション)この接続グループに分かりやすい名前を付けます。同じグループ名を持つ接続はグループ化されます。
接続方法:サーバーとポートを選択してください。
サーバーアドレス: TiDB Cloud接続ダイアログから
hostパラメータを入力します。ポート: TiDB Cloud接続ダイアログから
portパラメータを入力します。データベース:接続したいデータベースを入力してください。
ユーザー名: TiDB Cloud接続ダイアログから
userパラメータを入力してください。パスワードモード: SQLToolsDriver認証情報を選択します。
MySQLドライバ固有のオプション領域で、以下のパラメータを設定します。
- 認証プロトコル:デフォルトを選択してください。
- SSL :無効を選択してください。
「接続テスト」をクリックして、 TiDB Cloud Dedicatedクラスターへの接続を検証してください。
- ポップアップウィンドウで「許可」をクリックします。
- SQLToolsDriver認証情報ダイアログで、 TiDB Cloud Dedicatedクラスタのパスワードを入力します。
接続テストが成功すると、「接続に成功しました!」というメッセージが表示されます。 「接続を保存」をクリックして、接続設定を保存してください。
VS Codeを起動し、ナビゲーションペインでSQLTools拡張機能を選択します。 [接続]セクションで[新しい接続を追加]をクリックし、データベースドライバとしてTiDBを選択します。
設定画面で、以下の接続パラメータを設定します。
接続名:この接続に分かりやすい名前を付けてください。
接続グループ:(オプション)この接続グループに分かりやすい名前を付けます。同じグループ名を持つ接続はグループ化されます。
接続方法:サーバーとポートを選択してください。
サーバーアドレス:TiDBセルフマネージドクラスタのIPアドレスまたはドメイン名を入力してください。
ポート:TiDBセルフマネージドクラスタのポート番号を入力してください。
データベース:接続したいデータベースを入力してください。
ユーザー名:TiDBセルフマネージドクラスタに接続するために使用するユーザー名を入力してください。
パスワードモード:
- パスワードが空欄の場合は、 「空欄のパスワードを使用する」を選択してください。
- それ以外の場合は、 「SQLToolsDriver資格情報」を選択してください。
MySQLドライバ固有のオプション領域で、以下のパラメータを設定します。
- 認証プロトコル:デフォルトを選択してください。
- SSL :無効を選択してください。
「接続テスト」をクリックして、TiDBセルフマネージドクラスタへの接続を検証してください。
パスワードが空欄でない場合は、ポップアップウィンドウで「許可」をクリックし、TiDBセルフマネージドクラスタのパスワードを入力してください。
接続テストが成功すると、「接続に成功しました!」というメッセージが表示されます。 「接続を保存」をクリックして、接続設定を保存してください。
次のステップ
- Visual Studio Code の使用法の詳細についてはVisual Studio Code のドキュメント参照してください。
- VS Code SQLTools 拡張機能の使用法について詳しくは、SQLTools のドキュメントおよびGitHubリポジトリご覧ください。
- 開発者ガイドデータを挿入する」、データの更新データを削除する、「SQL パフォーマンス最適化」など単一テーブルの読み取り章を読んで、TiDB アプリケーション開発のベスト 取引SQLパフォーマンス最適化。
- プロフェッショナルなTiDB開発者向けコースコースを通じて学習し、試験に合格するとTiDB認定資格を取得します。
お困りですか?
- 不和or スラックコミュニティに質問してください。
- TiDB Cloudのサポートチケットを送信してください
- TiDB Self-Managedのサポートチケットを送信してください




