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

リアルタイム

データベースから直接取得したライブデータ。

1 つの WebSocket 接続は、データベースの変更、ブロードキャスト メッセージ、およびプレゼンスを伝送します。プライベート チャネルは、テーブルと同じ行レベルのセキュリティに従います。

3
チャンネルタイプ
25 s
ハートビート間隔
realtime.tsTS
import { createClient } from '@aurabase/aurabase-js'
const aura = createClient(
'https://my-project.aurabase.cloud',
'aura_anon_xxx',
)
aura
.channel('room')
.on(
'postgres_changes',
{
event: 'INSERT',
schema: 'public',
table: 'messages',
filter: 'room_id=eq.42',
},
(payload) => console.log(payload),
)
.subscribe()

含まれるもの

動くものはすべて生きています。 1 つの接続上。

データベース

データベースの変更

テーブルに対する挿入、更新、削除が発生したときにサブスクライブします。

フィルター

列フィルター

room_id=eq.42 など、関心のある行のみを受信します。サーバーはイベントを送信する前にフィルターを適用します。

メッセージング

ブロードキャスト

オプションのサーバー確認応答を使用して、チャネル上のクライアント間でメッセージを送信します。

存在感

誰がオンラインですか

チャネル上のユーザーを追跡し、ユーザーが参加、脱退、または状態を更新したときに反応します。

セキュリティ

プライベートチャンネル

行レベルのセキュリティ ポリシーは、誰がプライベート チャネルに参加できるかを決定し、トークンが更新されるときに再度チェックされます。

セキュリティ

プライベート限定プロジェクト

クライアントの要求が何であれ、プロジェクトのすべてのチャネルをプライベートにする必要があります。

サーバー側

HTTP 経由でブロードキャストする

1 回のリクエストでサーバーまたはエッジ機能から発行します。

信頼性

自動再接続

ハートビートによって切断された接続が検出され、クライアントはバックオフとジッターを使用して再接続し、チャネルを再サブスクライブします。

可観測性

接続とチャネルの状態をクリアする

接続状態を追跡し、失敗したフェーズでトランスポート エラーを取得し、チャネルが拒否された理由を確認します。

仕組み

画面の変化から。

  1. 1

    接続する

    SDK はユーザーのトークンを使用して 1 つの WebSocket を開きます。

  2. 2

    購読する

    チャンネルに参加してください。サーバーはアクセスをチェックして確認します。

  3. 3

    受信

    データベースの変更、ブロードキャスト、およびプレゼンスがそのチャネルに到着します。

  4. 4

    回復する

    リンクが切断された場合、SDK は再接続して再サブスクライブします。

エンドポイント

2つのルート。 それ以外はすべてチャネルです。

各リクエストとともにプロジェクトの API キーまたはユーザーのトークンを送信します。

方法エンドポイント説明
GET/v1/realtime/wsWebSocket 接続を開きます。チャネルはその上で多重化されます。
POST/v1/realtime/broadcastWebSocket を使用せずに、HTTP 経由でブロードキャストを送信します。

質問

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

データベースの変更を受け取るにはどうすればよいですか?+
必要なスキーマ、テーブル、イベントを含むチャネルで postgres_changes をサブスクライブします。一致する行のみを受信するフィルターを追加します。
誰がプライベート チャンネルを見ることができますか?+
行レベルのセキュリティ ポリシーは、ユーザーがサブスクライブするときのトークンからそれを決定します。ポリシーがトークンを拒否すると、チャネル エラーが発生します。
自分のサーバーからメッセージを送信できますか?+
はい。 httpBroadcast() は HTTP 経由でブロードキャストを送信します。ユーザー セッションなしでチャネルを呼び出す場合は、プロジェクト ID をチャネルの前に付けます。
接続が切断されるとどうなりますか?+
SDK は自動的に再接続し、チャンネルを再登録します。接続がダウンしている間に送信されたイベントは配信されることが保証されていないため、状態を再読み取りすることを見逃すわけにはいきません。
送信する前に購読する必要があるのはなぜですか?+
チャンネルのアクセス ルールは、購読時に計算されます。登録していないチャンネルでの送信は拒否され、SDK は何も送信せずにそのことを報告します。
削除フィルターではどのイベントが表示されますか?+
古い列。どの列を保持するかはテーブルのレプリカ ID によって異なります。デフォルトでは主キーであり、すべての列が完全なレプリカ ID を持ちます。

ライブの準備はできましたか?

アプリをリアルタイムで反応させます。

リアルタイムはすべてのプロジェクトに含まれています。クレジットカードは必要ありません。