JavaScript SDK: databasereferentie
Elke methode van aura.db en van de koppelbare querybuilder, met zijn handtekening.
6 min lezen·Niveau referentie·Herzien op 12 okt 2026
Deze Engelse tekst is automatisch gegenereerd op basis van het Franse origineel en is nog niet beoordeeld.
Deze pagina is automatisch vertaald. De Engelse versie is gezaghebbend.
#
Klasse
DatabaseService
| Methode | Beschrijving |
|---|---|
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> | Start een query op een tabel. |
sql<T = unknown>(query: string, params?: unknown[], options?: RawSqlOptions): Promise<AuraResponse<T>> | Voert een onbewerkte SQL-query uit (POST /v1/db/raw). |
rpc<FnName extends string, Args extends RpcArgsFor<Schema, FnName> = RpcArgsFor<Schema, FnName>, Fn extends { Row: Record<string, unknown>; Result: unknown; RelationName: unknown; Relationships: unknown; } = RpcResultFor<Schema, FnName, Args>>(fn: FnName, args?: Args, options?: RpcOptions): AuraFilterBuilder<Schema, Fn['Row'], Fn['RelationName'], Fn['Relationships'], Fn['Result'], AuraClientOptionsT> | Roept een functie Postgres aan die wordt weergegeven door PostgREST (POST|GET|HEAD /rpc/{fn}). |
schema(): Promise<AuraResponse<{ tables: SchemaTable[]; functions: SchemaFunction[]; enums: SchemaEnum[]; views: SchemaTable[]; }>> | Haal het schema op (tabellen en kolommen, Postgres functies weergegeven via PostgREST, opsommingstypen en weergaven) voor het huidige project. |
listFunctions(): Promise<AuraResponse<PgFunctionInfo[]>> | Geeft een overzicht van de functies van het projectschema (GET /v1/db/functions). |
createFunction(definition: CreatePgFunctionRequest): Promise<AuraResponse<null>> | Creëert of vervangt een Postgres (POST /v1/db/functions) functie. Vereist een service_role sleutel. Alleen PostgreSQL projecten. |
dropFunction(name: string): Promise<AuraResponse<null>> | Verwijdert een functie uit het projectschema (DELETE /v1/db/functions/{name}). Vereist een service_role sleutel. |
listTriggers(table: PgRelationName<Schema>): Promise<AuraResponse<PgTriggerInfo[]>> | Geeft een overzicht van de triggers van een tabel (GET /v1/db/{table}/triggers). |
createTrigger(table: PgRelationName<Schema>, definition: CreatePgTriggerRequest): Promise<AuraResponse<null>> | Creëert een trigger voor een tabel (POST /v1/db/{table}/triggers). Vereist een service_role sleutel. Alleen PostgreSQL projecten. |
dropTrigger(table: PgRelationName<Schema>, name: string): Promise<AuraResponse<null>> | Verwijdert een trigger uit een tabel (DELETE /v1/db/{table}/triggers/{name}). Vereist service_role. |
#
Klasse
AuraQueryBuilder
Koppelbare querybuilder die compileert naar URL-queryparameters die overeenkomen met de QueryOptions/FilterOp-indeling van de backend.
| Methode | Beschrijving |
|---|---|
insert(body: Relation extends { Insert: infer I; } ? I | I[] : never): this | Voegt een rij of een array van rijen in. |
update(id: string, body: Relation extends { Update: infer U; } ? U : never): AuraFilterBuilder<Schema, Relation['Row'], RelationName, Relation['Relationships'], Relation['Row'][], ClientOptions, false>update(body: Relation extends { Update: infer U; } ? U : never): AuraFilterBuilder<Schema, Relation['Row'], RelationName, Relation['Relationships'], Relation['Row'][], ClientOptions, false> | Werkt rijen bij: update(body) getarget door filters, of update(id, body) voor één rij per ID. |
delete(id?: string): AuraFilterBuilder<Schema, Relation['Row'], RelationName, Relation['Relationships'], Relation['Row'][], ClientOptions, false> | Verwijdert rijen: getarget door filters, of één rij op basis van ID met delete(id). |
upsert(body: Relation extends { Insert: infer I; } ? I | I[] : never, options?: { onConflict?: string; }): AuraFilterBuilder<Schema, Relation['Row'], RelationName, Relation['Relationships'], Relation['Row'][], ClientOptions, false> | Voegt een rij of een reeks rijen in of werkt deze bij (upsert). options.onConflict noemt de conflictkolom (standaard id). |
#
Klasse
AuraFilterBuilder
Alle PostgREST-filters (eq, neq, ... ilikeAnyOf).
| Methode | Beschrijving |
|---|---|
eq<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtert rijen waarbij column gelijk is aan value. |
neq<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtert rijen waarin column verschilt van value. |
gt<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtert rijen waarbij column strikt groter is dan value. |
gte<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtert rijen waarin column groter is dan of gelijk is aan value. |
lt<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtert rijen waarbij column strikt kleiner is dan value. |
lte<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtert rijen waarbij column kleiner is dan of gelijk is aan value. |
like(column: keyof Row & string, pattern: string): this | Filter op patroon LIKE, hoofdlettergevoelig (% vervangt een reeks tekens). |
ilike(column: keyof Row & string, pattern: string): this | Filter op patroon ILIKE, niet hoofdlettergevoelig. |
is(column: keyof Row & string, value: 'null' | 'true' | 'false' | 'unknown' | 'not.null'): this | IS NULL- of IS NOT NULL-filter. |
in<C extends keyof Row & string>(column: C, values: Row[C][]): this | Filtert rijen waarvan column een van de values is. |
or(filters: Array<{ column: string; op: string; value: unknown; }>): this | Voeg een OR-groep toe: or=(col1.eq.val1,col2.gt.val2) |
notIn<C extends keyof Row & string>(column: C, values: Row[C][]): this | Filtert rijen waarin column niet gelijk is aan een van values. |
contains(column: keyof Row & string, value: unknown): this | Filtert rijen waarvan de kolom (tabel, JSON of bereik) value bevat (operator @>). |
containedBy(column: keyof Row & string, value: unknown): this | Filtert rijen waarvan de kolom (array, JSON of bereik) zich in value bevindt (operator <@). |
overlaps(column: keyof Row & string, value: unknown): this | Filtert rijen waarvan de kolom (matrix of bereik) ten minste één element gemeen heeft met value (operator &&). |
rangeGt(column: keyof Row & string, range: string): this | Interval: filtert de bereiken strikt rechts van range (operator >>). |
rangeGte(column: keyof Row & string, range: string): this | Bereik: filtert bereiken die zich niet links van range uitstrekken (operator &>). |
rangeLt(column: keyof Row & string, range: string): this | Interval: filtert bereiken strikt links van range (operator <<). |
rangeLte(column: keyof Row & string, range: string): this | Bereik: filtert bereiken die zich niet rechts van range uitstrekken (operator &<). |
rangeAdjacent(column: keyof Row & string, range: string): this | Bereik: filtert bereiken grenzend aan range (operator -|-). |
isDistinct(column: keyof Row & string, value: unknown): this | Filtert rijen waarin column verschillend is van value, waarbij NULL als een waarde (IS DISTINCT FROM) wordt behandeld. |
not(column: string, op: string, value: unknown): this | Negeert een filter: not('status', 'eq', 'done') is gelijk aan status en verschilt van done. |
filter(column: string, op: string, value: unknown): this | Voegt een filter toe met een onbewerkte operator PostgREST (eq, gt, cs…), voor gevallen die niet door een speciale methode worden gedekt. |
match(query: Record<string, unknown>): this | Filter op gelijkheid op meerdere kolommen tegelijk: match({ a: 1, b: 2 }). |
textSearch(column: keyof Row & string, query: string, options?: { type?: 'plain' | 'phrase' | 'websearch'; config?: string; }): this | Zoeken in volledige tekst. options.type kiest de query: 'plain', 'phrase' of 'websearch' (anders native tsquery syntaxis); options.config stelt de taalconfiguratie in. |
likeAllOf(column: keyof Row & string, patterns: string[]): this | Filter LIKE: de kolom moet overeenkomen met ALLE patronen. |
likeAnyOf(column: keyof Row & string, patterns: string[]): this | Filter LIKE: de kolom moet overeenkomen met TEN MINSTE ÉÉN van de patronen. |
ilikeAllOf(column: keyof Row & string, patterns: string[]): this | Filter ILIKE (niet hoofdlettergevoelig): de kolom moet overeenkomen met ALLE patronen. |
ilikeAnyOf(column: keyof Row & string, patterns: string[]): this | Filter ILIKE (niet hoofdlettergevoelig): de kolom moet overeenkomen met TEN MINSTE ÉÉN van de patronen. |
#
Klasse
AuraTransformBuilder
Kolomselectie, sortering, paginering en kardinaliteitsmodificatoren (single/maybeSingle/count).
| Methode | Beschrijving |
|---|---|
select<Query extends string = '*', NewResultOne = GetResult<Schema, Row, RelationName, Relationships, Query, ClientOptions>>(columns?: Query, options?: SelectOptions): AuraFilterBuilder<Schema, Row, RelationName, Relationships, NewResultOne[], ClientOptions, ThrowOnError> | Selecteer kolommen en sluit optioneel gerelateerde bronnen in (PostgREST pariteit). |
order(column: string, directionOrOptions?: 'asc' | 'desc' | OrderOptions): this | Sorteer op een kolom. |
limit(n: number): this | Beperkt het aantal geretourneerde rijen. |
offset(n: number): this | Negeert de eerste n rijen (shift paging). |
range(from: number, to: number): this | Pagina's op indexinterval [van, tot] (inclusief, basis 0). |
cursor(cursor: string): this | Keyset-paginering: geef de ondoorzichtige next_cursor van de vorige pagina door (bij voorkeur boven offset op grote tabellen: stabiel, zonder dup/skip). |
count(mode?: CountMode): this | Vraagt het totale aantal overeenkomende rijen op (standaard 'exact' of 'estimated'), geretourneerd in count. |
single<ResultOne = Result extends (infer U)[] ? U : Result>(): AuraPostgrestBuilder<ClientOptions, ResultOne, ThrowOnError> | Wacht precies één rij en retourneert het object zelf; 0 of meerdere rijen geven de fout PGRST116. |
maybeSingle<ResultOne = Result extends (infer U)[] ? U : Result>(): AuraPostgrestBuilder<ClientOptions, ResultOne | null, ThrowOnError> | Zoals single(), maar 0 rijen zijn geen fout: data is dan null. |
#
Klasse
AuraPostgrestBuilder
Basisklasse: gedeelde status, constructor, HTTP-uitvoering (then/_execute), throwOnError en buildQueryString.
| Methode | Beschrijving |
|---|---|
throwOnError(): this | Genereert een uitzondering (in plaats van { error } terug te geven) wanneer de aanvraag mislukt. |
buildQueryString(): string | Creëert de queryreeks PostgREST (selecteren, filters, sorteren, paginering) zonder de query uit te voeren; handig voor het debuggen. |
then<TResult1 = AuraResponse<Result>, TResult2 = never>(onfulfilled?: ((value: AuraResponse<Result>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2> | Voert de vraag uit: de builder is “danable”, een simpele await is voldoende. |
Gegenereerde pagina
Deze pagina wordt gegenereerd op basis van de typedeclaraties en opmerkingen van de SDK, zodat deze niet kan afwijken van de gepubliceerde code. Lees de handleidingen voor uitgewerkte voorbeelden.
Laatst bijgewerkt · 12 okt 2026