用語集
Synqlet で使う主要な用語と、その関係をまとめます。全体像は全体構成も参照してください。
| 用語 | 説明 |
|---|---|
| 組織 | データの管理単位。すべてのデータは組織に属します。 |
| フロー | トリガーをきっかけに複数のノードを順に実行するワークフロー。→ フローとは |
| トリガー | フローを開始するきっかけ。定期実行 / HTTPリクエスト / フォームの3種類。→ トリガー |
| ノード | フローを構成する処理ステップ。主に スクリプトノード(TypeScript で処理を書く)。→ スクリプトを書く |
| ファンクション | フローから再利用できる共通ロジック(スクリプト)。→ ファンクション |
| ランナー | フロー / ファンクションを実行する実行環境。Deno で動作。→ ランナー |
| 環境変数 | 実行時に参照する設定値・シークレット。→ 環境変数 |
| 認証情報 | 外部サービス連携の認証情報(OAuth / APIキーなど)。→ 認証情報 |
| リビジョン | フロー / ファンクションのバージョン。アクティブ化で公開、過去版へロールバック可能。→ フローのリビジョン |
| ジョブ | 実行履歴。フロージョブ(フローの実行)とランナージョブ(ランナー上の実行単位)。→ ジョブ |
| APIキー | 外部から REST API を呼ぶための鍵(X-API-Key)。→ APIキーの発行 |
要素の関係(ざっくり)
Section titled “要素の関係(ざっくり)”- 組織 に、フロー・ファンクション・ランナー・環境変数・認証情報・APIキーが属します。
- フロー は トリガー で始まり、ノード(スクリプト)を順に実行します。
- ノード(スクリプト)は ファンクション・環境変数・認証情報 を参照できます。
- フローを実行すると フロージョブ が、ノードがランナーで実行されると ランナージョブ が記録されます。
- 実行は ランナー(Deno)上で行われます。
- 完成したフロー / ファンクションは リビジョン として公開します。