重要

このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

TiDB Cloudと Zapier を統合する

ザピエルは、コード不要の自動化ツールで、何千ものアプリやサービスが関与するワークフローを簡単に作成できます。

Zapier でTiDB Cloudアプリ使用すると、次のことが可能になります。

MySQL 互換の HTAP データベースである TiDB を使用します。ローカルで構築する必要はありません。
TiDB Cloudの管理が簡単になります。
TiDB Cloud を5000 以上のアプリに接続し、ワークフローを自動化します。

このガイドでは、Zapier 上のTiDB Cloudアプリの概要とその使用方法の例を示します。

テンプレートを使ったクイックスタート

ザップテンプレートは、公開されている Zapier 統合用に、事前に選択されたアプリとコアフィールドを備えた既製の統合または Zaps です。

このセクションでは、例として「新しい Github グローバルイベントを TiDB 行に追加」テンプレートを使用してワークフローを作成します。このワークフローでは、GitHub アカウントから新しいグローバルイベント (任意のリポジトリ上で、あなたから、またはあなたへのGitHubイベントのイベントが発生する) が作成されるたびに、Zapier は新しい行をTiDB Cloudクラスターに追加します。

前提条件

始める前に、次のものが必要です。

回答ザピアアカウント．
回答GitHub アカウント．
A TiDB Cloudアカウントと TiDBTiDB Cloud上の TiDB サーバーレスクラスター。詳細については、 TiDB Cloudクイックスタートを参照してください。

ステップ 1: テンプレートを取得する

Zapier 上のTiDB Cloudアプリに進みます。 [Add new Github global events to TiDB rows]テンプレートを選択し、 [Try it]をクリックします。次に、エディターページに入ります。

ステップ 2: トリガーを設定する

エディターページでは、トリガーとアクションを確認できます。トリガーをクリックして設定します。

アプリとイベントを選択
テンプレートにはデフォルトでアプリとイベントが設定されているため、ここでは何もする必要はありません。 [続行]をクリックします。
アカウントを選択してください
TiDB Cloudに接続する GitHub アカウントを選択します。新しいアカウントを接続するか、既存のアカウントを選択できます。設定が完了したら、 [続行]をクリックします。
トリガーを設定する
テンプレートにはデフォルトでトリガーが設定されています。 [続行]をクリックします。
テストトリガー
[トリガーのテスト]をクリックします。トリガーが正常に設定されると、GitHub アカウントから新しいグローバルイベントのデータを確認できます。 [続行]をクリックします。

ステップ 3: `Find Table in TiDB Cloud`アクションを設定する

アプリとイベントを選択
テンプレートで設定されたデフォルト値Find Tableそのまま使用します。 [続行]をクリックします。
アカウントを選択してください
1. 「サインイン」ボタンをクリックすると、新しいログインページにリダイレクトされます。
2. ログインページで、公開キーと秘密キーを入力します。 TiDB CloudAPI キーを取得するには、 TiDB CloudAPI ドキュメントの手順に従ってください。
3. [続行]をクリックします。
アクションを設定する
このステップでは、イベントデータを保存するためにTiDB Cloudクラスター内のテーブルを指定する必要があります。まだテーブルがない場合は、この手順でテーブルを作成できます。
1. ドロップダウンリストからプロジェクト名とクラスター名を選択します。クラスターの接続情報が自動的に表示されます。
2. パスワードを入力してください。
3. ドロップダウンリストからデータベースを選択します。
  Zapier は、入力したパスワードを使用してTiDB Cloudからデータベースにクエリを実行します。クラスター内にデータベースが見つからない場合は、パスワードを再入力してページを更新します。
4. [検索するテーブル] ボックスにgithub_global_eventと入力します。テーブルが存在しない場合、テンプレートは次の DDL を使用してテーブルを作成します。 [続行]をクリックします。
テストアクション
[アクションのテスト]をクリックすると、Zapier によってテーブルが作成されます。テストをスキップすることもできます。このワークフローが初めて実行されるときにテーブルが作成されます。

ステップ 4: `Create Row in TiDB Cloud`アクションを設定する

アプリとイベントを選択
テンプレートで設定されたデフォルト値をそのまま使用します。 [続行]をクリックします。
アカウントを選択してください
Find Table in TiDB Cloudアクションを設定するときに選択したアカウントを選択します。 [続行]をクリックします。
アクションを設定する
1. 前のステップと同様に、 「プロジェクト名」 、 「クラスタ名」 、 「TiDB パスワード」 、および「データベース名」を入力します。
2. [テーブル名]で、ドロップダウンリストからgithub_global_eventテーブルを選択します。テーブルの列が表示されます。
3. [列]ボックスで、トリガーから対応するデータを選択します。すべての列に入力し、 [続行]をクリックします。

テストアクション

[テストアクション]をクリックして、テーブルに新しい行を作成します。 TiDB Cloudクラスターを確認すると、データが正常に書き込まれていることがわかります。

mysql> SELECT * FROM test.github_global_event;
+-------------+-------------+------------+-----------------+----------------------------------------------+--------+---------------------+
| id          | type        | actor      | repo_name       | repo_url                                     | public | created_at          |
+-------------+-------------+------------+-----------------+----------------------------------------------+--------+---------------------+
| 25324462424 | CreateEvent | shiyuhang0 | shiyuhang0/docs | https://api.github.com/repos/shiyuhang0/docs | True   | 2022-11-18 08:03:14 |
+-------------+-------------+------------+-----------------+----------------------------------------------+--------+---------------------+
1 row in set (0.17 sec)

ステップ 5: ザップを公開する

「公開」をクリックしてザップを公開します。ホームページでザップが実行されていることがわかります。

Publish the zap

このザップにより、すべてのグローバルイベントが GitHub アカウントからTiDB Cloudに自動的に記録されます。

トリガーとアクション

トリガーとアクションは Zapier の重要な概念です。さまざまなトリガーとアクションを組み合わせることで、さまざまな自動化ワークフローを作成できます。

このセクションでは、Zapier 上のTiDB Cloud App によって提供されるトリガーとアクションを紹介します。

トリガー

次の表に、 TiDB Cloud App でサポートされるトリガーを示します。

引き金	説明
新しいクラスタ	新しいクラスターが作成されるときにトリガーされます。
新しいテーブル	新しいテーブルが作成されるときにトリガーされます。
新しい行	新しい行が作成されたときにトリガーされます。最近の 10000 行のみをフェッチします。
新しい行 (カスタムクエリ)	指定したカスタムクエリから新しい行が返されたときにトリガーされます。

行動

次の表に、 TiDB Cloud App でサポートされるアクションを示します。一部のアクションには追加のリソースが必要なので、アクションを使用する前に対応するリソースを準備する必要があることに注意してください。

アクション	説明	リソース
クラスタの検索	既存の TiDB サーバーレスクラスターまたは TiDB 専用クラスターを検索します。	なし
クラスタの作成	新しいクラスターを作成します。 TiDB サーバーレスクラスターの作成のみをサポートします。	なし
データベースの検索	既存のデータベースを検索します。	TiDB サーバーレスクラスター
データベースの作成	新しいデータベースを作成します。	TiDB サーバーレスクラスター
テーブルの検索	既存のテーブルを検索します。	TiDB サーバーレスクラスターとデータベース
テーブルの作成	新しいテーブルを作成します。	TiDB サーバーレスクラスターとデータベース
行の作成	新しい行を作成します。	TiDB サーバーレスクラスター、データベース、テーブル
行を更新	既存の行を更新します。	TiDB サーバーレスクラスター、データベース、テーブル
行の検索	ルックアップ列を介してテーブル内の行を検索します。	TiDB サーバーレスクラスター、データベース、テーブル
行の検索 (カスタムクエリ)	指定したカスタムクエリを介してテーブル内の行を検索します。	TiDB サーバーレスクラスター、データベース、テーブル

TiDB Cloudアプリテンプレート

TiDB Cloud には、 Zapier で直接使用できるテンプレートがいくつか用意されています。すべてのテンプレートがTiDB Cloudアプリページで見つかります。

ここではいくつかの例を示します。

FAQ

Zapier でTiDB Cloudアカウントを設定するにはどうすればよいですか?

Zapier では、 TiDB Cloudアカウントに接続するためにTiDB CloudAPI キーが必要です。 Zapier では、 TiDB Cloudのログインアカウントは必要ありません。

TiDB CloudAPI キーを取得するには、 TiDB CloudAPI ドキュメントに従ってください。

TiDB Cloudトリガーはどのように重複除外を実行しますか?

Zapier トリガーは、ポーリング API 呼び出しと連携して、新しいデータを定期的にチェックできます (間隔は Zapier プランによって異なります)。

TiDB Cloudトリガーは、多くの結果を返すポーリング API 呼び出しを提供します。ただし、結果のほとんどは以前に Zapier によって確認されたものであり、結果のほとんどが重複しています。

API 内の項目が複数の異なるポーリングに存在する場合、アクションを複数回トリガーしたくないため、 TiDB Cloudトリガーはidフィールドでデータの重複を排除します。

New ClusterおよびNew Tableトリガーは、単にcluster_idまたはtable_id idフィールドとして使用して重複排除を実行します。 2 つのトリガーに対しては何もする必要はありません。

新しい行トリガー

New Rowトリガーでは、フェッチごとに 10,000 件の結果が制限されます。したがって、10,000 件の結果に新しい行が含まれていない場合、Zapier をトリガーできません。

これを回避する 1 つの方法は、トリガーでOrder By構成を指定することです。たとえば、行を作成時間で並べ替えると、新しい行は常に 10,000 件の結果に含まれます。

New Rowトリガーは、重複排除を行うためのidフィールドを生成する柔軟な戦略も使用します。トリガーは、次の順序でidフィールドを生成します。

結果にid列が含まれる場合は、 id列を使用します。
トリガー設定でDedupe Key指定する場合は、 Dedupe Key使用します。
テーブルに主キーがある場合は、主キーを使用します。複数の主キーがある場合は、最初の列を使用します。
テーブルに一意のキーがある場合は、その一意のキーを使用します。
表の最初の列を使用します。

新しい行(カスタムクエリ)トリガー

New Row (Custom Query)トリガーは、フェッチごとに 1,000,000 件の結果を制限します。 1,000,000 は大きな数であり、システム全体を保護するためにのみ設定されています。クエリにはORDER BYとLIMITを含めることをお勧めします。

重複排除を実行するには、クエリ結果に一意の ID フィールドが必要です。そうしないと、 You must return the results with id fieldエラーが発生します。

カスタムクエリが 30 秒以内に実行されるようにしてください。そうしないと、タイムアウトエラーが発生します。

`find or create`アクションを使用するにはどうすればよいですか?

Find or createアクションを使用すると、リソースが存在しない場合にリソースを作成できます。以下に例を示します。

アクションをFind Table選択してください
set up actionステップで、 Create TiDB Cloud Table if it doesn’t exist yet?ボックスにチェックを入れてfind and createを有効にします。

このワークフローは、テーブルがまだ存在しない場合は作成します。アクションをテストすると、テーブルが直接作成されることに注意してください。