Kunde und Dienstleistungen
Der Einstiegspunkt des SDK: wie der Client erstellt wird und welche Dienste er verfügbar macht.
6 Min. gelesen·Ebene Referenz·Überarbeitet am 12.10.2026
Dieser englische Text wurde automatisch aus dem französischen Original generiert und wurde noch nicht überprüft.
Diese Seite wurde automatisch übersetzt. Maßgeblich ist die englische Version.
#
Funktionen
Exportierte Funktionen
| Funktion | Beschreibung |
|---|---|
function createClient<Database = any>(baseUrl: string, apiKey: string, options?: AuraClientOptions): AuraClient<Database> | Erstellen Sie eine neue Aurabase-Clientinstanz. |
function createAdminClient<Database = any>(baseUrl: string, serviceRoleKey: string, options?: AuraClientOptions): AuraClient<Database> | Erstellt einen Client für SERVER, verwendet nur für Verwaltungsvorgänge (client.authAdmin: Benutzer auflisten/erstellen/sperren, Audit lesen). |
#
Klasse
AuraClient
Haupt-Aurabase-Client.
| Eigentum | Beschreibung |
|---|---|
readonly baseUrl: string | Projekt-URL (https://<slug>.aurabase.cloud), ohne abschließende Leiste. |
readonly apiKey: string | null | Projekt-API-Schlüssel (anon oder service_role), der im Header apikey gesendet wird; null, wenn keine angegeben wurde. |
readonly fetchFn: typeof globalThis.fetch | Funktion fetch wird für alle Abfragen verwendet (die von options.fetch, andernfalls globalThis.fetch). |
readonly authStore: BaseAuthStore | Sitzungsspeicher (Zugriffstoken, Aktualisierungstoken, Benutzer): Speicher, localStorage oder Cookies je nach Kontext. |
readonly retryConfig: { enabled: boolean; maxRetries: number; } | Richtlinie zur Wiederaufnahme der Anforderung lesen (GET, HEAD) bei vorübergehendem Fehler: aktiviert oder nicht und maximale Anzahl von Wiederaufnahmen. |
readonly requestTimeoutMs?: number | Standard-Timeout (ms) für JSON-Anfragen ohne Signal. undefined → Kernfehler (30s). |
readonly onEvent?: (event: AuraObservabilityEvent) => void | Observability-Hook – siehe AuraClientOptions.onEvent. |
readonly debug?: boolean | Journalisieren Sie jedes Mal AuraObservabilityEvent über console.debug – siehe AuraClientOptions.debug. |
get auth(): AuthService | Authentifizierungsdienst: Registrierung, Verbindung, Sitzung, MFA, OAuth, Identitäten. |
get authAdmin(): AuthAdminService | Authentifizierungsverwaltungs-API (Benutzer, Sitzungen, Prüfprotokoll, E-Mail-Vorlagen). |
get db(): DatabaseService<Database, Schema> | Datenbankdienst: Abfragen von Tabellen und Ansichten, SQL-Funktionsaufrufe (rpc), Roh-SQL. |
get storage(): StorageService | Speicherdienst: Buckets, Senden, Herunterladen, signierte und öffentliche URLs, Bildtransformationen. |
get realtime(): RealtimeService | Echtzeitdienst: Kanäle, Postgres Änderungen, Übertragung (broadcast) und Präsenz. |
get functions(): FunctionsService | Edge Functions-Dienst: Aufruf und Verwaltung von Jobs und Cron mit einem service_role-Schlüssel. |
get ai(): AiService | KI-Dienst: Konversation (chat), Einbettungen, RAG (Aufnahme, Abfragen, Namespaces), semantische Suche und Sitzungen. |
get notifications(): NotificationsService | Benachrichtigungsdienst: Versand (E-Mail, SMS, Push, Webhook), Verlauf, Vorlagen und Verwaltung. |
| Methode | Beschreibung |
|---|---|
dispose(): void | Hebt die Bereitstellung des Clients auf: stoppt die proaktive Aktualisierung (Ticker + Sichtbarkeit + BroadcastChannel), trennt die Verbindung in Echtzeit und leert Authentifizierungs-Listener. |
from<TableName extends string & keyof Schema['Tables'], Table extends Schema['Tables'][TableName]>(table: TableName): AuraQueryBuilder<Schema, Table, TableName, AuraClientOptionsT>from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(view: ViewName): AuraQueryBuilder<Schema, View, ViewName, AuraClientOptionsT>from(table: string): AuraQueryBuilder<any, any, any, AuraClientOptionsT> | Abkürzung: Fragen Sie eine Datenbanktabelle oder -ansicht ab (Supabase-kompatible API). |
rpc<FnName extends string = string, Args extends Record<string, unknown> = Record<string, unknown>>(fn: FnName, args?: Args, options?: Parameters<DatabaseService<Database, Schema>['rpc']>[2]): ReturnType<DatabaseService<Database, Schema>['rpc']> | Abkürzung: Rufen Sie eine gespeicherte Prozedur / PostgreSQL-Funktion über RPC auf (Supabase-kompatible API). |
channel(name: string, options?: ChannelConfig): AuraChannel | Abkürzung: Erstellen Sie einen Echtzeitkanal mit einer Supabase-kompatiblen API. |
removeChannel(channel: string | AuraChannel): void | Verknüpfung: Entfernen Sie einen Echtzeitkanal nach Name oder AuraChannel-Instanz. |
removeAllChannels(): void | Kurzbefehl: Alle Echtzeitkanäle entfernen und abmelden. |
getChannels(): AuraChannel[] | Verknüpfung: Alle aktiven Echtzeitkanäle auflisten. |
Generierte Seite
Diese Seite wird aus den Typdeklarationen und Kommentaren des SDK generiert, sodass sie nicht vom veröffentlichten Code abweichen kann. Ausgearbeitete Beispiele finden Sie in den Leitfäden.
Zuletzt aktualisiert · 12.10.2026