新しいPublication of @aurabase/aurabase-js v0.7.5 NPM Packages & Rust Crate v0.1.2変更履歴を参照 →

Edge Functions

データの隣にあるサーバー コード。

Deno 関数を作成し、型付きエラーとタイムアウトを指定して SDK から呼び出し、オンデマンドでバックグラウンドまたはスケジュールに従って実行します。

Deno
ランタイム
3
実行方法: オンデマンド、ジョブ、cron
functions.tsTS
import { createClient } from '@aurabase/aurabase-js'
const aura = createClient(
'https://my-project.aurabase.cloud',
'aura_anon_xxx',
)
const { data, error } = await aura.functions.invoke<{ ok: boolean }>(
'hello-world',
{ body: { name: 'Ada' } },
)
if (error) throw error

含まれるもの

コードを実行するためのすべて。 サーバーを管理する必要はありません。

ランタイム

デノ関数

Deno.serve と TypeScript を使用して、標準のリクエスト ハンドラーとレスポンス ハンドラーを作成します。

呼び出し

SDKから呼び出す

メソッド、パス、ヘッダー、本体を含む名前で関数を呼び出します。

ルーティング

関数内のサブルート

1 つの関数で複数のパスとメソッドを処理できます。

制御

タイムアウトとキャンセル

タイムアウトを設定するか、AbortSignal を渡します。どちらも同じタイムアウト エラーを報告します。

エラー

入力エラー

関数がリレー障害から返されたエラーを通知することで、再試行する前に関数が実行されたかどうかがわかります。

応答

JSON、テキスト、Blob、または ArrayBuffer

応答本文をデコードする方法を選択します。

背景

非同期ジョブ

ジョブをステータスごとにリストし、ジョブの後にその ID を指定します。

スケジュール

Cron ジョブ

ペイロードを使用して cron スケジュールで関数を実行します。

デプロイ

CLI または Studio からデプロイする

aura CLI、Studio、または HTTP API を使用して関数を出荷します。

仕組み

ハンドラーから呼び出しへ。

  1. 1

    書く

    リクエストを読み取り、レスポンスを返す Deno.serve ハンドラーを作成します。

  2. 2

    デプロイ

    aura 関数のデプロイと一緒に、または Studio から出荷します。

  3. 3

    呼び出す

    aura.functions.invoke を使用して名前で呼び出します。

  4. 4

    スケジュール

    必要に応じて、cron スケジュールで実行します。

REST API

プレーンな HTTP をお好みですか? すべてここにあります。

SDK は、これらのルート上の薄い層です。リクエストごとにプロジェクトの API キーを送信します。

方法エンドポイント説明
GET/v1/functionsプロジェクトの機能をリストします。
GET/v1/functions/{name}1 つの関数の詳細を読みます。
POST/v1/functions/{name}/invokeメソッド、パス、ヘッダー、本体を使用して関数を実行します。
GET/v1/functions/jobs非同期ジョブをステータスでフィルタリングしてリストします。
GET/v1/functions/jobs/{id}一つの仕事を読んでください。
GET/v1/functions/cronスケジュールされたジョブをリストします。
POST/v1/functions/croncron 式を使用して関数をスケジュールします。
DELETE/v1/functions/cron/{name}スケジュールされたジョブを削除します。

質問

知っておいてよかったです。

関数はどのランタイムを使用しますか?+
デノ。関数は、TypeScript または JavaScript で記述された Deno.serve ハンドラーです。
関数をデプロイするにはどうすればよいですか?+
aura 関数を実行して、CLI を使用して <name> をデプロイするか、Studio または HTTP API を使用します。 SDK は関数を呼び出しますが、デプロイはしません。
関数はその応答をストリーミングできますか?+
いいえ。SDK は、選択した応答タイプに関係なく、応答全体が解決されるまで待機します。
失敗した通話を再試行しても安全ですか?+
503 の後、関数は実行されなかったため、再試行しても安全です。 504 の後は開始され、副作用があった可能性があるため、冪等な操作のみを再試行してください。
行事をスケジュールできますか?+
はい。名前、cron 式、および呼び出す関数を指定して cron ジョブを作成します。 SDK からジョブを一覧表示したり、削除したりできます。
関数が実行されるリージョンを選択できますか?+
現時点ではそうではありません。機能の地域選択はできません。

コードを実行する準備はできましたか?

最初の関数を今すぐ出荷してください。

関数はすべてのプロジェクトに含まれています。クレジットカードは必要ありません。