新Publication of @aurabase/aurabase-js v0.7.5 NPM Packages & Rust Crate v0.1.2查看变更日志 →

实时

实时数据,直接来自您的数据库。

一个 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()

包含什么

一切会动的东西都是活的。 在一个连接上。

数据库

数据库变更

订阅表上发生的插入、更新和删除操作。

过滤器

柱过滤器

仅接收您关心的行,例如 room_id=eq.42。服务器在发送事件之前应用过滤器。

消息传递

广播

在通道上的客户端之间发送消息,并带有可选的服务器确认。

存在感

谁在线

跟踪频道上的用户并在他们加入、离开或更新其状态时做出反应。

安全性

私人频道

行级安全策略决定谁可以加入私有频道,并在令牌刷新时再次检查。

安全性

仅限私人项目

无论客户要求什么,都要求项目的每个渠道都是私有的。

服务器端

通过 HTTP 广播

通过一个请求从服务器或边缘功能进行发布。

可靠性

自动重连

心跳检测到死连接,客户端通过退避和抖动重新连接,然后重新订阅其通道。

可观察性

清晰的连接和通道状态

跟踪连接状态,获取失败阶段的传输错误,并了解通道被拒绝的原因。

它是如何运作的

从屏幕的变化。

  1. 1

    连接

    SDK 使用用户的令牌打开一个 WebSocket。

  2. 2

    订阅

    加入频道;服务器检查访问并确认。

  3. 3

    接收

    数据库更改、广播和存在到达该通道。

  4. 4

    恢复

    如果链接断开,SDK 会重新连接并重新订阅。

端点

两条路线。 其他一切都是渠道。

在每个请求中发送项目的 API 密钥或用户的令牌。

方法端点描述
GET/v1/realtime/ws打开 WebSocket 连接。通道在其上复用。
POST/v1/realtime/broadcast通过 HTTP 发送广播,无需 WebSocket。

问题

很高兴知道。

我如何接收数据库更改?+
在频道上订阅 postgres_changes 以及您想要的架构、表和事件。添加过滤器以仅接收匹配的行。
谁可以看到私人频道?+
行级安全策略根据用户订阅时的令牌来决定。策略拒绝的令牌会出现通道错误。
我可以从我的服务器发送消息吗?+
是的。 httpBroadcast() 通过 HTTP 发送广播。当您在没有用户会话的情况下调用通道时,请在通道前添加您的项目 ID。
连接断开时会发生什么?+
SDK 会自动重新连接并重新订阅您的频道。连接断开时发送的事件不保证能够传递,因此请重新阅读状态,您不能错过。
为什么我必须在发送之前订阅?+
频道的访问规则是在您订阅时计算的。在您未订阅的频道上发送会被拒绝,并且 SDK 会报告该情况而不发送任何内容。
删除过滤器会看到哪些事件?+
老排。它携带哪些列取决于表的副本标识:默认为主键,所有列都具有完整副本标识。

准备好上线了吗?

让您的应用程序实时做出反应。

每个项目都包含实时功能。无需信用卡。