オーラベースのロゴ
オーラベースドキュメント
ドキュメント›JavaScript SDK reference›Client and services

クライアントとサービス

SDK のエントリ ポイント: クライアントの作成方法とクライアントが公開するサービス。

6 分 読み取り·レベル 参照·2026/10/12 に改訂
この英語のテキストはフランス語のオリジナルから自動的に生成されたもので、まだレビューされていません。
このページは自動翻訳されました。英語版が正式です。
#
機能

エクスポートされた機能

機能説明
function createClient<Database = any>(baseUrl: string, apiKey: string, options?: AuraClientOptions): AuraClient<Database>新しい Aurabase クライアント インスタンスを作成します。
function createAdminClient<Database = any>(baseUrl: string, serviceRoleKey: string, options?: AuraClientOptions): AuraClient<Database>SERVER のクライアントを作成し、管理操作 (client.authAdmin: ユーザーのリスト/作成/禁止、監査の読み取り) に のみを使用します。
#
クラス

オーラクライアント

メインの Aurabase クライアント。

プロパティ説明
readonly baseUrl: stringプロジェクト URL (https://<slug>.aurabase.cloud)、末尾のバーなし。
readonly apiKey: string | nullapikey ヘッダーで送信されるプロジェクト API キー (anon または service_role)。 何も指定されなかった場合は null。
readonly fetchFn: typeof globalThis.fetch関数 fetch はすべてのクエリ ( options.fetchのクエリ、それ以外の場合は globalThis.fetch) に使用されます。
readonly authStore: BaseAuthStoreセッション ストア (アクセス トークン、リフレッシュ トークン、ユーザー): コンテキストに応じてメモリ、localStorage、または Cookie。
readonly retryConfig: { enabled: boolean; maxRetries: number; }一時的エラー時の読み取りリクエスト再開ポリシー (GET、 HEAD): 有効かどうか、および再開の最大数。
readonly requestTimeoutMs?: numberシグナルのない JSON リクエストのデフォルトのタイムアウト (ミリ秒)。 undefined → コア障害 (30 秒)。
readonly onEvent?: (event: AuraObservabilityEvent) => void可観測性フック — AuraClientOptions.onEventを参照してください。
readonly debug?: booleanconsole.debug 経由で AuraObservabilityEvent を記録します — AuraClientOptions.debugを呼び出します。
get auth(): AuthService認証サービス: 登録、接続、セッション、 MFA、 OAuth、アイデンティティ。
get authAdmin(): AuthAdminService認証管理 API (ユーザー、セッション、監査ログ、電子メール テンプレート)。
get db(): DatabaseService<Database, Schema>データベース サービス: テーブルとビューのクエリ、SQL 関数呼び出し (rpc)、生の SQL。
get storage(): StorageServiceストレージ サービス: バケット、送信、ダウンロード、署名付きおよびパブリック URL、画像変換。
get realtime(): RealtimeServiceリアルタイム サービス: チャネル、Postgres 変更、ブロードキャスト (broadcast)、およびプレゼンス。
get functions(): FunctionsServiceEdge Functions サービス: service_role キーを使用したジョブと cron の呼び出しと管理。
get ai(): AiServiceAI サービス: 会話 (chat)、埋め込み、RAG (取り込み、クエリ、名前空間)、セマンティック検索およびセッション。
get notifications(): NotificationsService通知サービス: 送信 (電子メール、SMS、プッシュ、Webhook)、履歴、テンプレート、および管理。
方法説明
dispose(): voidクライアントをマウント解除します。プロアクティブな更新 (ティッカー + 可視性 + BroadcastChannel) を停止し、リアルタイムを切断し、認証リスナーを空にします。
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>		ショートカット: データベース テーブルまたはビューをクエリします (Supabase互換 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']>ショートカット: RPC 経由でストアド プロシージャ/PostgreSQL 関数を呼び出します (Supabase互換 API)。
channel(name: string, options?: ChannelConfig): AuraChannelショートカット: Supabase互換 API を使用してリアルタイム チャネルを作成します。
removeChannel(channel: string | AuraChannel): voidショートカット: 名前または AuraChannel インスタンスでリアルタイム チャネルを削除します。
removeAllChannels(): voidショートカット: すべてのリアルタイム チャネルを削除し、購読を解除します。
getChannels(): AuraChannel[]ショートカット: すべてのアクティブなリアルタイム チャネルをリストします。
生成されたページ

このページは SDK の型宣言とコメントから生成されるため、公開されたコードから逸脱することはできません。実用的な例については、ガイドを参照してください。