NIEUWPublication of @aurabase/aurabase-js v0.7.5 NPM Packages & Rust Crate v0.1.2Zie de changelog →

Realtime

Live data, rechtstreeks uit uw database.

Eén WebSocket-verbinding draagt ​​databasewijzigingen, uitgezonden berichten en aanwezigheid over. Privékanalen volgen dezelfde beveiliging op rijniveau als uw tabellen.

3
kanaal typen
25 s
hartslag interval
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()

Wat is inbegrepen

Alles wat beweegt leeft. Op één verbinding.

Database

Databasewijzigingen

Abonneer u op invoegingen, updates en verwijderingen op een tafel zodra ze plaatsvinden.

Filters

Kolomfilters

Ontvang alleen de rijen die u interesseren, zoals room_id=eq.42. De server past het filter toe voordat de gebeurtenis wordt verzonden.

Berichten

Uitzending

Verzend berichten tussen clients op een kanaal, met optionele serverbevestiging.

Aanwezigheid

Wie is er online

Volg gebruikers op een kanaal en reageer wanneer ze lid worden, weggaan of hun status bijwerken.

Beveiliging

Privékanalen

Beveiligingsbeleid op rijniveau bepaalt wie lid kan worden van een privékanaal en wordt opnieuw gecontroleerd wanneer het token wordt vernieuwd.

Beveiliging

Alleen particuliere projecten

Vereisen dat elk kanaal van een project privé is, waar de klant ook om vraagt.

Serverzijde

Uitgezonden via HTTP

Publiceer vanaf een server of een edge-functie met één verzoek.

Betrouwbaarheid

Automatische herverbinding

Een hartslag detecteert dode verbindingen, en de client maakt opnieuw verbinding met back-off en jitter, en abonneert zich vervolgens opnieuw op de kanalen.

Waarneembaarheid

Duidelijke verbindings- en kanaalstatussen

Volg de verbindingsstatus, krijg transportfouten met de fase die mislukte en kijk waarom een kanaal werd geweigerd.

Hoe het werkt

Van een wijziging aan uw scherm.

  1. 1

    Verbinden

    De SDK opent één WebSocket met het token van de gebruiker.

  2. 2

    Abonneer u

    Word lid van een kanaal; de server controleert de toegang en bevestigt.

  3. 3

    Ontvang

    Databasewijzigingen, uitzendingen en aanwezigheid arriveren op dat kanaal.

  4. 4

    Herstellen

    Als de link wegvalt, maakt de SDK opnieuw verbinding en abonneert zich opnieuw.

Eindpunten

Twee trajecten. Al het andere is een kanaal.

Stuur bij elk verzoek de API-sleutel van uw project of het token van de gebruiker.

MethodeEindpuntBeschrijving
GET/v1/realtime/wsOpen de WebSocket-verbinding. Kanalen worden er overheen gemultiplext.
POST/v1/realtime/broadcastVerzend een uitzending via HTTP, zonder WebSocket.

Vragen

Goed om te weten.

Hoe ontvang ik databasewijzigingen?+
Abonneer u op postgres_changes op een kanaal met het gewenste schema, de tabel en het evenement. Voeg een filter toe om alleen overeenkomende rijen te ontvangen.
Wie kan een privékanaal zien?+
Beveiligingsbeleid op rijniveau bepaalt dit op basis van het token van de gebruiker wanneer deze zich abonneert. Een token dat door het beleid wordt geweigerd, krijgt een kanaalfout.
Kan ik berichten verzenden vanaf mijn server?+
Ja. httpBroadcast() verzendt een uitzending via HTTP. Voeg uw project-ID aan het kanaal toe als u het oproept zonder een gebruikerssessie.
Wat gebeurt er als de verbinding wegvalt?+
De SDK maakt automatisch opnieuw verbinding en abonneert uw kanalen opnieuw. Gebeurtenissen die zijn verzonden terwijl de verbinding was verbroken, worden niet gegarandeerd afgeleverd, dus lees de staat opnieuw die u niet kunt missen.
Waarom moet ik me abonneren voordat ik kan verzenden?+
Toegangsregels voor een kanaal worden berekend wanneer u zich abonneert. Verzenden op een kanaal waarop u niet bent geabonneerd, wordt geweigerd en de SDK rapporteert dit zonder iets te verzenden.
Welke gebeurtenissen ziet een verwijderfilter?+
De oude rij. Welke kolommen daarin staan, hangt af van de replica-identiteit van de tabel: standaard de primaire sleutel, alle kolommen met volledige replica-identiteit.

Klaar om live te gaan?

Laat uw app in realtime reageren.

Realtime is bij elk project inbegrepen. Geen creditcard vereist.