データアプリを管理する
Data Service のデータ アプリ (ベータ版) は、特定のアプリケーションのデータにアクセスするために使用できるエンドポイントのコレクションです。 API キーを使用して認証設定を構成し、データ アプリのエンドポイントへのアクセスを制限できます。
このドキュメントでは、 TiDB Cloudコンソールでデータ アプリを管理する方法について説明します。 データサービスページでは、すべてのデータ アプリ、エンドポイント、API キーを管理できます。
データアプリを作成する
プロジェクトのデータ アプリを作成するには、次の手順を実行します。
プロジェクトのデータサービスページで、 をクリックします。
左側のペインでDataApp を作成します。 ヒント：
これがプロジェクト内の最初のデータ アプリの場合は、ページの中央にある[データ アプリの作成]をクリックします。
名前と説明を入力し、データ アプリがアクセスするクラスターを選択します。
(オプション) データ アプリのエンドポイントを優先する GitHub リポジトリとブランチに自動的にデプロイするには、 [GitHub に接続]を有効にして、次の手順を実行します。
[GitHub にインストール] をクリックし、画面上の指示に従ってTiDB Cloud Data Serviceをアプリケーションとしてターゲット リポジトリにインストールします。
「承認」をクリックして、GitHub 上のアプリケーションへのアクセスを承認します。
データ アプリの構成ファイルを保存するターゲット リポジトリ、ブランチ、ディレクトリを指定します。
注記：
- ディレクトリはスラッシュ (
/) で始まる必要があります。たとえば、/mydata。指定したディレクトリがターゲット リポジトリおよびブランチに存在しない場合は、自動的に作成されます。 - リポジトリ、ブランチ、ディレクトリの組み合わせによって構成ファイルのパスが識別されます。このパスはデータ アプリ間で一意である必要があります。指定したパスがすでに別のデータ アプリで使用されている場合は、代わりに新しいパスを指定する必要があります。そうしないと、現在のデータ アプリのTiDB Cloudコンソールで構成されたエンドポイントによって、指定したパス内のファイルが上書きされます。
- 指定したパスに別のデータ アプリからコピーされた構成ファイルが含まれており、これらのファイルを現在のデータ アプリにインポートする場合は、 既存のデータ アプリの構成をインポートするを参照してください。
- ディレクトリはスラッシュ (
[データ アプリの作成]をクリックします。
新しく作成されたデータ アプリがリストの先頭に追加されます。新しいデータ アプリにはデフォルトの
untitled endpointが作成されます。データ アプリを GitHub に接続するように構成している場合は、指定した GitHub ディレクトリを確認してください。 データアプリ構成ファイル
tidb-cloud-data-serviceまでにディレクトリにコミットされていることがわかります。これは、データ アプリが GitHub に正常に接続されていることを意味します。新しいデータ アプリでは、自動同期とデプロイメントおよびドラフトのレビューがデフォルトで有効になっているため、 TiDB Cloudコンソールと GitHub の間でデータ アプリの変更を簡単に同期し、デプロイ前に変更をレビューできます。 GitHub 統合の詳細については、 データ アプリの変更を GitHub で自動的にデプロイを参照してください。
データアプリを構成する
データ アプリの名前、バージョン、または説明を編集し、その GitHub 接続、リンクされたデータ ソース、API キー、エンドポイント、デプロイメントを管理できます。
データアプリのプロパティを編集する
データ アプリの名前、バージョン、説明を編集できます。データ アプリのプロパティを編集するには、次の手順を実行します。
- プロジェクトのデータサービスページに移動します。
- 左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。
- [データ アプリのプロパティ]領域で、 、アプリ名、バージョン、または説明を変更し、 [確認]をクリックします。
GitHub接続を管理する
詳細については、 GitHub を使用して自動的にデプロイを参照してください。
リンクされたデータソースを管理する
データ アプリのリンクされたクラスターを追加または削除できます。
クラスターをデータ アプリにリンクするには、次の手順を実行します。
- プロジェクトのデータサービスページに移動します。
- 左側のペインでターゲット データ アプリを見つけ、ターゲット データ アプリの名前をクリックして詳細を表示します。
- [リンクされたデータ ソース]領域で、 [クラスタの追加]をクリックします。
- 表示されたダイアログ ボックスで、リストからクラスタを選択し、 [追加]をクリックします。
データ アプリからリンクされたクラスターを削除するには、次の手順を実行します。
プロジェクトのデータサービスページに移動します。
左側のペインでターゲット データ アプリを見つけ、ターゲット データ アプリの名前をクリックして詳細を表示します。
[リンク データ ソース]領域で、データ アプリから削除するターゲットのリンク クラスターを見つけて、 [アクション]列の[削除]をクリックします。
表示されたダイアログボックスで、削除を確認します。
リンクされたクラスターを削除した後、クラスターは削除されませんが、データ アプリの既存のエンドポイントはクラスターにアクセスできなくなります。
APIキーを管理する
詳細については、 APIキーを管理するを参照してください。
エンドポイントを管理する
詳細については、 エンドポイントを管理するを参照してください。
導入の管理
デプロイメントを管理するには、次の手順を実行します。
プロジェクトのデータサービスページに移動します。
左側のペインでターゲット データ アプリを見つけ、ターゲット データ アプリの名前をクリックして詳細を表示します。
「デプロイメントコンフィグレーション」領域で、 「構成」をクリックします。デプロイメント構成のダイアログが表示されます。
ダイアログで、 「自動同期と展開」および「ドラフトの確認」の希望の設定を選択します。
自動同期と展開
- このオプションは、データ アプリが GitHub に接続されている場合にのみ有効にできます。詳細については、 GitHub を使用して自動的にデプロイを参照してください。
- これを有効にすると、指定した GitHub ディレクトリで行われた変更を自動的にTiDB Cloudにデプロイでき、 TiDB Cloudコンソールで行われた変更も同様に GitHub にプッシュできます。データ アプリのデプロイ履歴で、対応するデプロイとコミットの情報を見つけることができます。
- これを無効にすると、指定した GitHub ディレクトリで行われた変更はTiDB Cloudにデプロイされず、 TiDB Cloudコンソールで行われた変更も GitHub にプッシュされません。
レビュー草案
- 有効にすると、展開前にTiDB Cloudコンソールで行ったデータ アプリの変更を確認できます。レビューに基づいて、変更をデプロイするか破棄することができます。
- これを無効にすると、 TiDB Cloudコンソールで行ったデータ アプリの変更が直接デプロイされます。
「アクション」列では、必要に応じて変更を編集または再デプロイできます。
OpenAPI仕様を使用する
Data Service (ベータ) は、データ アプリごとに OpenAPI 仕様 3.0 の生成をサポートしており、これにより、標準化された形式でエンドポイントと対話できるようになります。この仕様を使用して、標準化された OpenAPI ドキュメント、クライアント SDK、およびサーバースタブを生成できます。
OpenAPI仕様をダウンロードする
データ アプリの OpenAPI 仕様を JSON または YAML 形式でダウンロードするには、次の手順を実行します。
プロジェクトのデータサービスページに移動します。
左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。
「API 仕様」領域で「ダウンロード」をクリックし、 「JSON」または「YAML」を選択します。
OpenAPI 仕様を初めてダウンロードする場合は、プロンプトが表示されたらリクエストを承認する必要があります。
次に、OpenAPI 仕様がローカル マシンにダウンロードされます。
OpenAPI ドキュメントをビュー
Data Service (ベータ版) は、各データ アプリに対して自動生成された OpenAPI ドキュメントを提供します。ドキュメントでは、エンドポイント、パラメーター、応答を表示し、エンドポイントを試すことができます。
OpenAPI ドキュメントにアクセスするには、次の手順を実行します。
プロジェクトのデータサービスページに移動します。
左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。
ページの右上隅にある[API ドキュメントのビュー]をクリックします。
OpenAPI 仕様を初めて使用する場合は、プロンプトが表示されたらリクエストを承認する必要があります。
次に、OpenAPI ドキュメントが新しいタブで開きます。ドキュメントでは、次の情報を確認できます。
- データ アプリの名前、バージョン、説明。
- タグによってグループ化されたエンドポイント。
(オプション) エンドポイントを試すには、次の手順を実行します。
[承認]をクリックし、表示されたダイアログ ボックスにデータ アプリの公開キーをユーザー名として入力し、秘密キーをパスワードとして入力します。
詳細については、 APIキーを管理するを参照してください。
ターゲット エンドポイントを見つけて、必要なパラメータを指定して、 [試してみる]をクリックします。応答は[応答本文]領域で確認できます。
OpenAPI ドキュメントの使用方法の詳細については、 Swagger UIを参照してください。
データアプリを削除する
注記：
データ アプリを削除する前に、すべてのエンドポイントがオンラインになっていないことを確認してください。そうしないと、データ アプリを削除できません。エンドポイントのデプロイを解除するには、 エンドポイントのデプロイを解除するを参照してください。
データ アプリを削除するには、次の手順を実行します。
プロジェクトのデータサービスページに移動します。
左側のペインでターゲット データ アプリを見つけ、ターゲット データ アプリの名前をクリックして詳細を表示します。
[危険ゾーン]領域で、 [データ アプリの削除] をクリックします。確認のダイアログボックスが表示されます。
<organization name>/<project name>/<data app name>を入力し、 [理解しました、削除]をクリックします。データ アプリが削除されると、データ アプリ内の既存のエンドポイントと API キーも削除されます。このデータ アプリが GitHub に接続されている場合、アプリを削除しても、対応する GitHub リポジトリ内のファイルは削除されません。