JavaScript SDK: データベースリファレンス
aura.db およびチェーン可能なクエリ ビルダーのすべてのメソッドとそのシグネチャ。
6 分 読み取り·レベル 参照·2026/10/12 に改訂
この英語のテキストはフランス語のオリジナルから自動的に生成されたもので、まだレビューされていません。
このページは自動翻訳されました。英語版が正式です。
#
クラス
データベースサービス
| 方法 | 説明 |
|---|---|
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> | テーブルに対してクエリを開始します。 |
sql<T = unknown>(query: string, params?: unknown[], options?: RawSqlOptions): Promise<AuraResponse<T>> | 生の SQL クエリ (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> | PostgREST (POST|GET|HEAD /rpc/{fn}) によって公開される関数 Postgres を呼び出します。 |
schema(): Promise<AuraResponse<{ tables: SchemaTable[]; functions: SchemaFunction[]; enums: SchemaEnum[]; views: SchemaTable[]; }>> | 現在のプロジェクトのスキーマ (テーブルと列、 PostgRESTを介して公開される Postgres 関数、列挙型とビュー) を取得します。 |
listFunctions(): Promise<AuraResponse<PgFunctionInfo[]>> | プロジェクト スキーマ (GET /v1/db/functions) の関数をリストします。 |
createFunction(definition: CreatePgFunctionRequest): Promise<AuraResponse<null>> | Postgres (POST /v1/db/functions) 関数を作成または置換します。 service_role キーが必要です。 PostgreSQL プロジェクトのみ。 |
dropFunction(name: string): Promise<AuraResponse<null>> | プロジェクト スキーマ (DELETE /v1/db/functions/{name}) から機能を削除します。 service_role キーが必要です。 |
listTriggers(table: PgRelationName<Schema>): Promise<AuraResponse<PgTriggerInfo[]>> | テーブルのトリガーをリストします (GET /v1/db/{table}/triggers)。 |
createTrigger(table: PgRelationName<Schema>, definition: CreatePgTriggerRequest): Promise<AuraResponse<null>> | テーブルにトリガーを作成します (POST /v1/db/{table}/triggers)。 service_role キーが必要です。 PostgreSQL プロジェクトのみ。 |
dropTrigger(table: PgRelationName<Schema>, name: string): Promise<AuraResponse<null>> | テーブルからトリガーを削除します (DELETE /v1/db/{table}/triggers/{name})。 service_roleが必要です。 |
#
クラス
AuraQueryBuilder
バックエンドの QueryOptions / FilterOp 形式に一致する URL クエリ パラメーターにコンパイルするチェーン可能なクエリ ビルダー。
| 方法 | 説明 |
|---|---|
insert(body: Relation extends { Insert: infer I; } ? I | I[] : never): this | 行または行の配列を挿入します。 |
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> | 行を更新します: フィルターの対象となる update(body)、または識別子ごとに 1 行の update(id, body)。 |
delete(id?: string): AuraFilterBuilder<Schema, Relation['Row'], RelationName, Relation['Relationships'], Relation['Row'][], ClientOptions, false> | 行を削除します: フィルターの対象、または delete(id)の識別子によって 1 行。 |
upsert(body: Relation extends { Insert: infer I; } ? I | I[] : never, options?: { onConflict?: string; }): AuraFilterBuilder<Schema, Relation['Row'], RelationName, Relation['Relationships'], Relation['Row'][], ClientOptions, false> | 行または行の配列を挿入または更新 (アップサート) します。 options.onConflict は競合列に名前を付けます (デフォルトではid)。 |
#
クラス
オーラフィルタービルダー
すべての PostgREST フィルター (eq、 neq、 ... ilikeAnyOf)。
| 方法 | 説明 |
|---|---|
eq<C extends keyof Row & string>(column: C, value: Row[C]): this | column が valueと等しい行をフィルターします。 |
neq<C extends keyof Row & string>(column: C, value: Row[C]): this | column が valueと異なる行をフィルターします。 |
gt<C extends keyof Row & string>(column: C, value: Row[C]): this | column が valueより厳密に大きい行をフィルターします。 |
gte<C extends keyof Row & string>(column: C, value: Row[C]): this | column が value以上である行をフィルターします。 |
lt<C extends keyof Row & string>(column: C, value: Row[C]): this | column が valueより厳密に小さい行をフィルターします。 |
lte<C extends keyof Row & string>(column: C, value: Row[C]): this | column が value以下の行をフィルターします。 |
like(column: keyof Row & string, pattern: string): this | パターン LIKEでフィルターします。大文字と小文字は区別されます (% は一連の文字を置き換えます)。 |
ilike(column: keyof Row & string, pattern: string): this | パターン ILIKEでフィルターします (大文字と小文字は区別されません)。 |
is(column: keyof Row & string, value: 'null' | 'true' | 'false' | 'unknown' | 'not.null'): this | IS NULL または IS NOT NULL フィルター。 |
in<C extends keyof Row & string>(column: C, values: Row[C][]): this | column が valuesのいずれかである行をフィルターします。 |
or(filters: Array<{ column: string; op: string; value: unknown; }>): this | OR グループを追加します: or=(col1.eq.val1,col2.gt.val2) |
notIn<C extends keyof Row & string>(column: C, values: Row[C][]): this | column が valuesのいずれとも等しくない行をフィルターします。 |
contains(column: keyof Row & string, value: unknown): this | 列 (テーブル、JSON、または範囲) に value (演算子 @>) が含まれる行をフィルターします。 |
containedBy(column: keyof Row & string, value: unknown): this | 列 (配列、JSON、または範囲) が value (演算子 <@) に含まれる行をフィルターします。 |
overlaps(column: keyof Row & string, value: unknown): this | 列 (配列または範囲) に value (演算子 &&) と共通の要素が少なくとも 1 つある行をフィルターします。 |
rangeGt(column: keyof Row & string, range: string): this | 間隔: range (演算子 >>) の厳密に右側にある範囲をフィルターします。 |
rangeGte(column: keyof Row & string, range: string): this | 範囲: range (演算子 &>) の左側に拡張しない範囲をフィルターします。 |
rangeLt(column: keyof Row & string, range: string): this | 間隔: range (演算子 <<) の左側にある範囲をフィルターします。 |
rangeLte(column: keyof Row & string, range: string): this | 範囲: range (演算子 &<) の右側に拡張しない範囲をフィルターします。 |
rangeAdjacent(column: keyof Row & string, range: string): this | 範囲: range (演算子 -|-) に隣接する範囲をフィルターします。 |
isDistinct(column: keyof Row & string, value: unknown): this | column が valueとは異なる行をフィルターし、 NULL を値 (IS DISTINCT FROM) として扱います。 |
not(column: string, op: string, value: unknown): this | フィルターを無効にします: not('status', 'eq', 'done') は status と同等であり、 doneとは異なります。 |
filter(column: string, op: string, value: unknown): this | 専用のメソッドでカバーされない場合に備えて、生の PostgREST 演算子 (eq、 gt、 cs…) を使用したフィルターを追加します。 |
match(query: Record<string, unknown>): this | 同時に複数の列の等価性によってフィルター処理します: match({ a: 1, b: 2 })。 |
textSearch(column: keyof Row & string, query: string, options?: { type?: 'plain' | 'phrase' | 'websearch'; config?: string; }): this | 全文検索。 options.type はクエリを選択します: 'plain'、 'phrase' または 'websearch' (それ以外の場合はネイティブ tsquery 構文)。 options.config は言語構成を設定します。 |
likeAllOf(column: keyof Row & string, patterns: string[]): this | フィルタ LIKE: 列はすべてのパターンに一致する必要があります。 |
likeAnyOf(column: keyof Row & string, patterns: string[]): this | フィルタ LIKE: 列は少なくとも 1 つのパターンに一致する必要があります。 |
ilikeAllOf(column: keyof Row & string, patterns: string[]): this | フィルター ILIKE (大文字と小文字を区別しない): 列はすべてのパターンに一致する必要があります。 |
ilikeAnyOf(column: keyof Row & string, patterns: string[]): this | フィルタ ILIKE (大文字と小文字を区別しない): 列は少なくとも 1 つのパターンに一致する必要があります。 |
#
クラス
オーラトランスフォームビルダー
列の選択、並べ替え、ページネーション、およびカーディナリティ修飾子 (single/maybeSingle/count)。
| 方法 | 説明 |
|---|---|
select<Query extends string = '*', NewResultOne = GetResult<Schema, Row, RelationName, Relationships, Query, ClientOptions>>(columns?: Query, options?: SelectOptions): AuraFilterBuilder<Schema, Row, RelationName, Relationships, NewResultOne[], ClientOptions, ThrowOnError> | 列を選択し、必要に応じて関連リソース (PostgREST パリティ) を埋め込みます。 |
order(column: string, directionOrOptions?: 'asc' | 'desc' | OrderOptions): this | 列で並べ替えます。 |
limit(n: number): this | 返される行数を制限します。 |
offset(n: number): this | 最初の n 行を無視します (シフト ページング)。 |
range(from: number, to: number): this | インデックス間隔 [from、to] (両端を含む、基数 0) によるページ。 |
cursor(cursor: string): this | キーセットのページネーション: 前のページの不透明な next_cursor を渡します (大きなテーブルでは offset が望ましい: 安定しており、dup/skip なし)。 |
count(mode?: CountMode): this | 一致する行の総数 (デフォルトは 'exact'または 'estimated') を要求し、 countで返されます。 |
single<ResultOne = Result extends (infer U)[] ? U : Result>(): AuraPostgrestBuilder<ClientOptions, ResultOne, ThrowOnError> | 正確に 1 行を待機し、オブジェクト自体を返します。 0 行または複数行の場合、エラー PGRST116が発生します。 |
maybeSingle<ResultOne = Result extends (infer U)[] ? U : Result>(): AuraPostgrestBuilder<ClientOptions, ResultOne | null, ThrowOnError> | single()と似ていますが、0 行はエラーではありません。 data は nullになります。 |
#
クラス
オーラポストグレストビルダー
基本クラス: 共有状態、コンストラクター、HTTP 実行 (then/_execute)、 throwOnError および buildQueryString。
| 方法 | 説明 |
|---|---|
throwOnError(): this | リクエストが失敗した場合、( { error }を返す代わりに) 例外をスローします。 |
buildQueryString(): string | クエリを実行せずにクエリ文字列 PostgREST (選択、フィルター、並べ替え、ページネーション) を構築します。デバッグに役立ちます。 |
then<TResult1 = AuraResponse<Result>, TResult2 = never>(onfulfilled?: ((value: AuraResponse<Result>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2> | クエリを実行します。ビルダーは「thenable」なので、単純な await で十分です。 |
生成されたページ
このページは SDK の型宣言とコメントから生成されるため、公開されたコードから逸脱することはできません。実用的な例については、ガイドを参照してください。
最終更新日 · 2026/10/12