客户和服务
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 | null | 项目 API 密钥（anon 或 service_role）在 apikey 标头中发送； null（如果未提供）。 |
readonly fetchFn: typeof globalThis.fetch | 函数 fetch 用于所有查询（options.fetch的查询，否则 globalThis.fetch）。 |
readonly authStore: BaseAuthStore | 会话存储（访问令牌、刷新令牌、用户）：内存、localStorage 或 cookies，具体取决于上下文。 |
readonly retryConfig: { enabled: boolean; maxRetries: number; } | 读取瞬时错误时的请求恢复策略（GET、 HEAD）：启用或禁用，以及最大恢复次数。 |
readonly requestTimeoutMs?: number | 无信号的 JSON 请求的默认超时（毫秒）。 undefined → 核心故障（30 秒）。 |
readonly onEvent?: (event: AuraObservabilityEvent) => void | 可观察性挂钩 - 请参阅 AuraClientOptions.onEvent。 |
readonly debug?: boolean | 通过 console.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(): FunctionsService | Edge Functions 服务：使用 service_role 密钥调用和管理作业和 cron。 |
get ai(): AiService | AI 服务：对话 (chat)、嵌入、RAG（摄取、查询、命名空间）、语义搜索和会话。 |
get notifications(): NotificationsService | 通知服务：发送（电子邮件、短信、推送、Webhook）、历史记录、模板和管理。 |
| 方法 | 描述 |
|---|---|
dispose(): void | 卸载客户端：停止主动刷新（ticker + 可见性 + 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 的类型声明和注释生成的，因此它不会偏离已发布的代码。有关工作示例，请阅读指南。
最后更新· 2026年10月12日