SDK de JavaScript: referencia de base de datos
Cada método de aura.db y del generador de consultas encadenables, con su firma.
6 min leer·Nivel referencia·Revisado el 12 oct 2026
Este texto en inglés se generó automáticamente a partir del original en francés y aún no ha sido revisado.
Esta página fue traducida automáticamente. La versión en inglés es autorizada.
#
clase
Servicio de base de datos
| Método | Descripción |
|---|---|
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> | Inicie una consulta en una mesa. |
sql<T = unknown>(query: string, params?: unknown[], options?: RawSqlOptions): Promise<AuraResponse<T>> | Ejecuta una consulta SQL sin formato (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> | Llama a una función Postgres expuesta por PostgREST (POST|GET|HEAD /rpc/{fn}). |
schema(): Promise<AuraResponse<{ tables: SchemaTable[]; functions: SchemaFunction[]; enums: SchemaEnum[]; views: SchemaTable[]; }>> | Obtenga el esquema (tablas y columnas, funciones Postgres expuestas a través de PostgREST, tipos de enumeración y vistas) para el proyecto actual. |
listFunctions(): Promise<AuraResponse<PgFunctionInfo[]>> | Enumera las funciones del esquema del proyecto (GET /v1/db/functions). |
createFunction(definition: CreatePgFunctionRequest): Promise<AuraResponse<null>> | Crea o reemplaza una función Postgres (POST /v1/db/functions). Requiere una clave service_role. PostgreSQL solo proyectos. |
dropFunction(name: string): Promise<AuraResponse<null>> | Elimina una característica del esquema del proyecto (DELETE /v1/db/functions/{name}). Requiere una clave service_role. |
listTriggers(table: PgRelationName<Schema>): Promise<AuraResponse<PgTriggerInfo[]>> | Enumera los desencadenantes de una tabla (GET /v1/db/{table}/triggers). |
createTrigger(table: PgRelationName<Schema>, definition: CreatePgTriggerRequest): Promise<AuraResponse<null>> | Crea un disparador en una tabla (POST /v1/db/{table}/triggers). Requiere una clave service_role. PostgreSQL proyectos únicamente. |
dropTrigger(table: PgRelationName<Schema>, name: string): Promise<AuraResponse<null>> | Elimina un disparador de una tabla (DELETE /v1/db/{table}/triggers/{name}). Requiere service_role. |
#
clase
AuraQueryBuilder
Generador de consultas encadenables que se compila en parámetros de consulta de URL que coinciden con el formato QueryOptions/FilterOp del backend.
| Método | Descripción |
|---|---|
insert(body: Relation extends { Insert: infer I; } ? I | I[] : never): this | Inserta una fila o una matriz de filas. |
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> | Actualiza filas: update(body) objetivo de filtros, o update(id, body) para una fila por identificador. |
delete(id?: string): AuraFilterBuilder<Schema, Relation['Row'], RelationName, Relation['Relationships'], Relation['Row'][], ClientOptions, false> | Elimina filas: objetivo de filtros o una fila por identificador con 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> | Inserta o actualiza (upsert) una fila o una matriz de filas. options.onConflict nombra la columna de conflicto (id de forma predeterminada). |
#
clase
Generador de filtros de aura
Todos los filtros PostgREST (eq, neq, ... ilikeAnyOf).
| Método | Descripción |
|---|---|
eq<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtra filas donde column es igual a value. |
neq<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtra filas donde column es diferente de value. |
gt<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtra filas donde column es estrictamente mayor que value. |
gte<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtra filas donde column es mayor o igual que value. |
lt<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtra filas donde column es estrictamente menor que value. |
lte<C extends keyof Row & string>(column: C, value: Row[C]): this | Filtra filas donde column es menor o igual que value. |
like(column: keyof Row & string, pattern: string): this | Filtrar por patrón LIKE, distingue entre mayúsculas y minúsculas (% reemplaza una secuencia de caracteres). |
ilike(column: keyof Row & string, pattern: string): this | Filtrar por patrón ILIKE, no distingue entre mayúsculas y minúsculas. |
is(column: keyof Row & string, value: 'null' | 'true' | 'false' | 'unknown' | 'not.null'): this | Filtro ES NULO o NO ES NULO. |
in<C extends keyof Row & string>(column: C, values: Row[C][]): this | Filtra filas cuyo column es uno de values. |
or(filters: Array<{ column: string; op: string; value: unknown; }>): this | Agregue un grupo OR: or=(col1.eq.val1,col2.gt.val2) |
notIn<C extends keyof Row & string>(column: C, values: Row[C][]): this | Filtra filas donde column no es igual a ninguna de values. |
contains(column: keyof Row & string, value: unknown): this | Filtra filas cuya columna (tabla, JSON o rango) contiene value (operador @>). |
containedBy(column: keyof Row & string, value: unknown): this | Filtra filas cuya columna (matriz, JSON o rango) está contenida en value (operador <@). |
overlaps(column: keyof Row & string, value: unknown): this | Filtra filas cuya columna (matriz o rango) tiene al menos un elemento en común con value (operador &&). |
rangeGt(column: keyof Row & string, range: string): this | Intervalo: filtra los rangos ubicados estrictamente a la derecha de range (operador >>). |
rangeGte(column: keyof Row & string, range: string): this | Rango: filtra rangos que no se extienden a la izquierda de range (operador &>). |
rangeLt(column: keyof Row & string, range: string): this | Intervalo: filtra rangos ubicados estrictamente a la izquierda de range (operador <<). |
rangeLte(column: keyof Row & string, range: string): this | Rango: filtra rangos que no se extienden a la derecha de range (operador &<). |
rangeAdjacent(column: keyof Row & string, range: string): this | Rango: filtra rangos adyacentes a range (operador -|-). |
isDistinct(column: keyof Row & string, value: unknown): this | Filtra filas donde column es distinta de value, tratando NULL como un valor (IS DISTINCT FROM). |
not(column: string, op: string, value: unknown): this | Niega un filtro: not('status', 'eq', 'done') es equivalente a status diferente de done. |
filter(column: string, op: string, value: unknown): this | Agrega un filtro con un operador PostgREST sin formato (eq, gt, cs…), para casos no cubiertos por un método dedicado. |
match(query: Record<string, unknown>): this | Filtrar por igualdad en varias columnas al mismo tiempo: match({ a: 1, b: 2 }). |
textSearch(column: keyof Row & string, query: string, options?: { type?: 'plain' | 'phrase' | 'websearch'; config?: string; }): this | Búsqueda de texto completo. options.type elige la consulta: 'plain', 'phrase' o 'websearch' (de lo contrario, sintaxis nativa de tsquery); options.config establece la configuración del idioma. |
likeAllOf(column: keyof Row & string, patterns: string[]): this | Filtro LIKE: la columna debe coincidir con TODOS los patrones. |
likeAnyOf(column: keyof Row & string, patterns: string[]): this | Filtro LIKE: la columna debe coincidir AL MENOS CON UNO de los patrones. |
ilikeAllOf(column: keyof Row & string, patterns: string[]): this | Filtro ILIKE (no distingue entre mayúsculas y minúsculas): la columna debe coincidir con TODOS los patrones. |
ilikeAnyOf(column: keyof Row & string, patterns: string[]): this | Filtro ILIKE (no distingue entre mayúsculas y minúsculas): la columna debe coincidir con AL MENOS UNO de los patrones. |
#
clase
AuraTransformBuilder
Modificadores de selección, clasificación, paginación y cardinalidad de columnas (single/maybeSingle/count).
| Método | Descripción |
|---|---|
select<Query extends string = '*', NewResultOne = GetResult<Schema, Row, RelationName, Relationships, Query, ClientOptions>>(columns?: Query, options?: SelectOptions): AuraFilterBuilder<Schema, Row, RelationName, Relationships, NewResultOne[], ClientOptions, ThrowOnError> | Seleccione columnas y, opcionalmente, incruste recursos relacionados (paridad PostgREST). |
order(column: string, directionOrOptions?: 'asc' | 'desc' | OrderOptions): this | Ordenar en una columna. |
limit(n: number): this | Limita el número de filas devueltas. |
offset(n: number): this | Ignora las primeras n filas (paginación por turnos). |
range(from: number, to: number): this | Páginas por intervalo de índice [desde, hasta] (inclusive, base 0). |
cursor(cursor: string): this | Paginación del conjunto de claves: pase el next_cursor opaco de la página anterior (preferible a offset en tablas grandes: estable, sin dup/skip). |
count(mode?: CountMode): this | Solicita el número total de filas coincidentes (predeterminado 'exact' o 'estimated'), devueltas en count. |
single<ResultOne = Result extends (infer U)[] ? U : Result>(): AuraPostgrestBuilder<ClientOptions, ResultOne, ThrowOnError> | Espera exactamente una fila y devuelve el objeto en sí; 0 o varias filas dan el error PGRST116. |
maybeSingle<ResultOne = Result extends (infer U)[] ? U : Result>(): AuraPostgrestBuilder<ClientOptions, ResultOne | null, ThrowOnError> | Como single(), pero 0 filas no son un error: data es entonces null. |
#
clase
AuraPostgrestBuilder
Clase base: estado compartido, constructor, ejecución HTTP (then/_execute), throwOnError y buildQueryString.
| Método | Descripción |
|---|---|
throwOnError(): this | Lanza una excepción (en lugar de devolver { error }) cuando falla la solicitud. |
buildQueryString(): string | Construye la cadena de consulta PostgREST (seleccionar, filtrar, ordenar, paginar) sin ejecutar la consulta; útil para depurar. |
then<TResult1 = AuraResponse<Result>, TResult2 = never>(onfulfilled?: ((value: AuraResponse<Result>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2> | Ejecuta la consulta: el constructor es “entoncesable”, un simple await es suficiente. |
página generada
Esta página se genera a partir de las declaraciones de tipo y los comentarios del SDK, por lo que no puede derivarse del código publicado. Para ver ejemplos resueltos, lea las guías.
Última actualización · 12 oct 2026