📣
TiDB Cloud Essential はパブリックプレビュー中です。このページは自動翻訳されたものです。原文はこちらからご覧ください。

Visual Studio Codeを使用してTiDBに接続する



TiDB は MySQL 互換データベースであり、 Visual Studio Code (VS Code)は軽量かつ強力なソース コード エディターです。このチュートリアルでは、TiDB を公式ドライバーとしてサポートするSQLツール拡張機能を使用します。

このチュートリアルでは、Visual Studio Code を使用して TiDB に接続する方法を学ぶことができます。

注記:

前提条件

このチュートリアルを完了するには、以下が必要です。

  • 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に接続してください。

    1. 私のTiDBページに移動し、対象のTiDB Cloud StarterまたはEssentialインスタンスの名前をクリックして、概要ページに移動します。

    2. 右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。

    3. 接続ダイアログの設定がご使用のオペレーティング環境と一致していることを確認してください。

      • 接続タイプPublicに設定されています。

      • ブランチmainに設定されています。

      • 「接続」はVS Codeに設定されています。

      • お使いの環境に合ったオペレーティングシステムを選択してください。

      ヒント:

      VS Code をリモート開発環境で実行している場合は、リストからリモートのオペレーティングシステムを選択してください。たとえば、Windows Subsystem for Linux (WSL) を使用している場合は、対応する Linux ディストリビューションに切り替えてください。GitHub Codespaces を使用している場合は、この操作は不要です。

    4. 「パスワードを生成」をクリックすると、ランダムなパスワードが生成されます。

      ヒント:

      以前にパスワードを作成したことがある場合は、元のパスワードを使用するか、 「パスワードをリセット」をクリックして新しいパスワードを生成できます。

    5. VS Codeを起動し、ナビゲーションペインでSQLTools拡張機能を選択します。 [接続]セクションで[新しい接続を追加]をクリックし、データベースドライバとしてTiDBを選択します。

      VS Code SQLTools: add new connection

    6. 設定画面で、以下の接続パラメータを設定します。

      • 接続名:この接続に分かりやすい名前を付けてください。

      • 接続グループ:(オプション)この接続グループに分かりやすい名前を付けます。同じグループ名を持つ接続はグループ化されます。

      • 接続方法サーバーとポートを選択してください。

      • サーバーアドレス: 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ルート証明書管理参照してください。

      VS Code SQLTools: configure connection settings for TiDB Cloud Starter

    7. 「接続テスト」をクリックして、対象のTiDB Cloud StarterまたはEssentialインスタンスへの接続を検証してください。

      1. ポップアップウィンドウで「許可」をクリックします。

      2. SQLToolsDriver認証情報ダイアログで、手順4で作成したパスワードを入力します。

        VS Code SQLTools: enter password to connect to TiDB Cloud Starter

    8. 接続テストが成功すると、「接続に成功しました!」というメッセージが表示されます。 「接続を保存」をクリックして、接続設定を保存してください。

    1. 私のTiDBページに移動し、対象のTiDB Cloud Dedicatedクラスタの名前をクリックして概要ページに移動します。

    2. 右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。

    3. 接続ダイアログで、「接続タイプ」ドロップダウンリストから「パブリック」を選択し、 「CA証明書」をクリックしてCA証明書をダウンロードします。

      IP アクセス リストを設定していない場合は、最初の接続の前に、 [IP アクセス リストの設定] をクリックするか、「IP アクセス リストを設定する」の手順に従ってIPアクセスリストを設定する

      TiDB Cloud Dedicated は、パブリック接続タイプに加えて、プライベート エンドポイントおよびVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud Dedicatedクラスタに接続します参照してください。

    4. VS Codeを起動し、ナビゲーションペインでSQLTools拡張機能を選択します。 [接続]セクションで[新しい接続を追加]をクリックし、データベースドライバとしてTiDBを選択します。

      VS Code SQLTools: add new connection

    5. 設定画面で、以下の接続パラメータを設定します。

      • 接続名:この接続に分かりやすい名前を付けてください。

      • 接続グループ:(オプション)この接続グループに分かりやすい名前を付けます。同じグループ名を持つ接続はグループ化されます。

      • 接続方法サーバーとポートを選択してください。

      • サーバーアドレス: TiDB Cloud接続ダイアログからhostパラメータを入力します。

      • ポート: TiDB Cloud接続ダイアログからportパラメータを入力します。

      • データベース:接続したいデータベースを入力してください。

      • ユーザー名: TiDB Cloud接続ダイアログからuserパラメータを入力してください。

      • パスワードモード: SQLToolsDriver認証情報を選択します。

      • MySQLドライバ固有のオプション領域で、以下のパラメータを設定します。

        • 認証プロトコルデフォルトを選択してください。
        • SSL無効を選択してください。

      VS Code SQLTools: configure connection settings for TiDB Cloud Dedicated

    6. 「接続テスト」をクリックして、 TiDB Cloud Dedicatedクラスターへの接続を検証してください。

      1. ポップアップウィンドウで「許可」をクリックします。
      2. SQLToolsDriver認証情報ダイアログで、 TiDB Cloud Dedicatedクラスタのパスワードを入力します。

      VS Code SQLTools: enter password to connect to TiDB Cloud Dedicated

    7. 接続テストが成功すると、「接続に成功しました!」というメッセージが表示されます。 「接続を保存」をクリックして、接続設定を保存してください。

    1. VS Codeを起動し、ナビゲーションペインでSQLTools拡張機能を選択します。 [接続]セクションで[新しい接続を追加]をクリックし、データベースドライバとしてTiDBを選択します。

      VS Code SQLTools: add new connection

    2. 設定画面で、以下の接続パラメータを設定します。

      • 接続名:この接続に分かりやすい名前を付けてください。

      • 接続グループ:(オプション)この接続グループに分かりやすい名前を付けます。同じグループ名を持つ接続はグループ化されます。

      • 接続方法サーバーとポートを選択してください。

      • サーバーアドレス:TiDBセルフマネージドクラスタのIPアドレスまたはドメイン名を入力してください。

      • ポート:TiDBセルフマネージドクラスタのポート番号を入力してください。

      • データベース:接続したいデータベースを入力してください。

      • ユーザー名:TiDBセルフマネージドクラスタに接続するために使用するユーザー名を入力してください。

      • パスワードモード

        • パスワードが空欄の場合は、 「空欄のパスワードを使用する」を選択してください。
        • それ以外の場合は、 「SQLToolsDriver資格情報」を選択してください。
      • MySQLドライバ固有のオプション領域で、以下のパラメータを設定します。

        • 認証プロトコルデフォルトを選択してください。
        • SSL無効を選択してください。

      VS Code SQLTools: configure connection settings for TiDB Self-Managed

    3. 「接続テスト」をクリックして、TiDBセルフマネージドクラスタへの接続を検証してください。

      パスワードが空欄でない場合は、ポップアップウィンドウで「許可」をクリックし、TiDBセルフマネージドクラスタのパスワードを入力してください。

      VS Code SQLTools: enter password to connect to TiDB Self-Managed

    4. 接続テストが成功すると、「接続に成功しました!」というメッセージが表示されます。 「接続を保存」をクリックして、接続設定を保存してください。

    次のステップ

    お困りですか?

    このページは役に立ちましたか?