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