Visual Studio Code で TiDB に接続する
TiDB は MySQL 互換のデータベースであり、 ビジュアルスタジオコード (VSコード)軽量でありながら強力なソース コード エディターです。このチュートリアルでは、 公式ドライバーとして TiDB をサポートするSQLツール拡張機能を使用します。
このチュートリアルでは、Visual Studio Code を使用して TiDB クラスターに接続する方法を学習します。
注記：
- このチュートリアルは、 TiDB Cloud Serverless、 TiDB Cloud Dedicated、および TiDB Self-Managed と互換性があります。
- このチュートリアルは、 GitHub コードスペース 、 Visual Studio Code 開発コンテナ 、 ビジュアルスタジオコード WSLなどの Visual Studio Code リモート開発環境でも機能します。
前提条件
このチュートリアルを完了するには、次のものが必要です。
- ビジュアルスタジオコード 1.72.0以降のバージョン。
- Visual Studio Code のSQLツール MySQL/MariaDB/TiDB拡張機能。インストールするには、次のいずれかの方法を使用します。
- このリンクをクリックして VS Code を起動し、拡張機能を直接インストールします。
- VS Code マーケットプレイスに移動して、 [インストール]をクリックします。
- VS Code の[拡張機能]タブで、
mtxr.sqltools-driver-mysqlを検索してSQLTools MySQL/MariaDB/TiDB拡張機能を取得し、 [インストール]をクリックします。
- TiDB クラスター。
TiDB クラスターがない場合は、次のように作成できます。
- (推奨) TiDB Cloud Serverless クラスターの作成に従って、独自のTiDB Cloudクラスターを作成します。
- ローカルテストTiDBクラスタをデプロイまたは本番のTiDBクラスタをデプロイに従ってローカル クラスターを作成します。
TiDBに接続する
選択した TiDB デプロイメント オプションに応じて、TiDB クラスターに接続します。
- TiDB Cloud Serverless
- TiDB Cloud Dedicated
- TiDB Self-Managed
クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
接続タイプは
Publicに設定されています。ブランチは
mainに設定されています。Connect With は
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 TiDB Cloud Serverless には安全な接続が必要です。 「SSL オプション (node.TLSSocket)」領域で、 TiDB Cloud接続ダイアログの
CAのパラメータとして「証明機関 (CA) 証明書ファイル」フィールドを設定します。注記：
Windows または GitHub Codespaces で実行している場合は、 SSL を空白のままにすることができます。デフォルトでは、SQLTools は Let's Encrypt によってキュレートされた既知の CA を信頼します。詳細については、 TiDB Cloudサーバーレスルート証明書管理を参照してください。
「テスト接続」をクリックして、 TiDB Cloud Serverless クラスターへの接続を検証します。
ポップアップウィンドウで、 [許可]をクリックします。
SQLToolsDriver資格情報ダイアログで、手順 4 で作成したパスワードを入力します。
接続テストが成功すると、 「正常に接続されました」というメッセージが表示されます。 「接続を保存」をクリックして接続構成を保存します。
クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログで、 [接続タイプ]ドロップダウン リストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。
IP アクセス リストを設定していない場合は、 「IP アクセス リストの設定」をクリックするか、手順IPアクセスリストを構成するに従って最初の接続の前に設定してください。
TiDB Dedicated は、パブリック接続タイプに加えて、プライベートエンドポイントとVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB専用クラスタに接続するを参照してください。
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のドキュメントから詳しく学びます。
- SQLTools のドキュメントとGitHub リポジトリから、VS Code SQLTools 拡張機能の詳細な使用方法を学習します。
- 開発者ガイドのデータを挿入 、 データの更新 、 データを削除する 、 単一テーブル読み取り 、 取引 、 SQLパフォーマンスの最適化などの章で、 TiDB アプリケーション開発のベスト プラクティスを学習します。
- プロフェッショナルTiDB 開発者コースを通じて学び、試験に合格するとTiDB 認定獲得します。
ヘルプが必要ですか?
TiDB コミュニティ 、またはサポートチケットを作成するについて質問します。