NEUPublication of @aurabase/aurabase-js v0.7.5 NPM Packages & Rust Crate v0.1.2Siehe Changelog →

Echtzeit

Live-Daten direkt aus Ihrer Datenbank.

Eine WebSocket-Verbindung überträgt Datenbankänderungen, Broadcast-Nachrichten und Anwesenheit. Private Kanäle unterliegen der gleichen Sicherheit auf Zeilenebene wie Ihre Tabellen.

3
Kanaltypen
25 s
Herzschlagintervall
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()

Was ist enthalten?

Alles, was sich live bewegt. Auf einer Verbindung.

Datenbank

Datenbankänderungen

Abonnieren Sie Einfügungen, Aktualisierungen und Löschungen in einer Tabelle, sobald diese erfolgen.

Filter

Spaltenfilter

Erhalten Sie nur die Zeilen, die Sie interessieren, z. B. „room_id=eq.42“. Der Server wendet den Filter an, bevor er das Ereignis sendet.

Nachrichten

Ausstrahlung

Senden Sie Nachrichten zwischen Clients auf einem Kanal, mit optionaler Serverbestätigung.

Präsenz

Wer ist online?

Verfolgen Sie Benutzer auf einem Kanal und reagieren Sie, wenn sie beitreten, ihn verlassen oder ihren Status aktualisieren.

Sicherheit

Private Kanäle

Sicherheitsrichtlinien auf Zeilenebene entscheiden, wer einem privaten Kanal beitreten kann, und werden erneut überprüft, wenn das Token aktualisiert wird.

Sicherheit

Nur private Projekte

Erfordern Sie, dass jeder Kanal eines Projekts privat ist, ganz gleich, was der Kunde verlangt.

Serverseitig

Über HTTP übertragen

Veröffentlichen Sie mit einer Anfrage von einem Server oder einer Edge-Funktion.

Zuverlässigkeit

Automatische Wiederverbindung

Ein Heartbeat erkennt tote Verbindungen, und der Client stellt die Verbindung mit Backoff und Jitter wieder her und abonniert dann seine Kanäle erneut.

Beobachtbarkeit

Klare Verbindungs- und Kanalzustände

Verfolgen Sie den Verbindungsstatus, erhalten Sie Transportfehler mit der fehlgeschlagenen Phase und sehen Sie, warum ein Kanal abgelehnt wurde.

Wie es funktioniert

Von einer Änderung an Ihrem Bildschirm.

  1. 1

    Verbinden

    Das SDK öffnet einen WebSocket mit dem Token des Benutzers.

  2. 2

    Abonnieren

    Treten Sie einem Kanal bei; Der Server prüft den Zugriff und bestätigt ihn.

  3. 3

    Empfangen

    Datenbankänderungen, Broadcasts und Präsenz kommen auf diesem Kanal an.

  4. 4

    Erholen

    Wenn die Verbindung unterbrochen wird, stellt das SDK die Verbindung wieder her und abonniert erneut.

Endpunkte

Zwei Routen. Alles andere ist ein Kanal.

Senden Sie bei jeder Anfrage den API-Schlüssel Ihres Projekts oder das Token des Benutzers.

MethodeEndpunktBeschreibung
GET/v1/realtime/wsÖffnen Sie die WebSocket-Verbindung. Darüber werden Kanäle gemultiplext.
POST/v1/realtime/broadcastSenden Sie einen Broadcast über HTTP, ohne WebSocket.

Fragen

Gut zu wissen.

Wie erhalte ich Datenbankänderungen?+
Abonnieren Sie postgres_changes auf einem Kanal mit dem gewünschten Schema, der gewünschten Tabelle und dem gewünschten Ereignis. Fügen Sie einen Filter hinzu, um nur übereinstimmende Zeilen zu erhalten.
Wer kann einen privaten Kanal sehen?+
Sicherheitsrichtlinien auf Zeilenebene entscheiden darüber anhand des Tokens des Benutzers, wenn er sich anmeldet. Ein von der Richtlinie abgelehntes Token erhält einen Kanalfehler.
Kann ich Nachrichten von meinem Server senden?+
Ja. httpBroadcast() sendet einen Broadcast über HTTP. Stellen Sie dem Kanal Ihre Projekt-ID voran, wenn Sie ihn ohne Benutzersitzung aufrufen.
Was passiert, wenn die Verbindung unterbrochen wird?+
Das SDK stellt automatisch die Verbindung wieder her und abonniert Ihre Kanäle erneut. Es ist nicht garantiert, dass Ereignisse, die gesendet werden, während die Verbindung unterbrochen war, zugestellt werden. Lesen Sie den Status also noch einmal durch, damit Sie ihn nicht verpassen dürfen.
Warum muss ich mich vor dem Senden anmelden?+
Zugriffsregeln für einen Kanal werden beim Abonnieren berechnet. Das Senden auf einem Kanal, den Sie nicht abonniert haben, wird abgelehnt und das SDK meldet dies, ohne etwas zu senden.
Welche Ereignisse sieht ein Löschfilter?+
Die alte Reihe. Welche Spalten darin enthalten sind, hängt von der Replikatidentität der Tabelle ab: standardmäßig der Primärschlüssel, alle Spalten mit vollständiger Replikatidentität.

Bereit, live zu gehen?

Lassen Sie Ihre App in Echtzeit reagieren.

Echtzeit ist in jedem Projekt enthalten. Keine Kreditkarte erforderlich.