GetBranchSchema - 获取分支 Schema
获取 Supabase 分支的数据库 Schema。
接口说明
该接口用于查询指定分支中指定数据库的 Schema SQL 内容。系统库 postgres、template0、template1 不支持查询。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。 |
cn-beijing |
| ProjectId |
string |
是 |
主分支对应的 Supabase 项目 ID。 |
spb-xxxx |
| BranchId |
string |
是 |
分支 ID，用于唯一标识一个 Supabase 分支。 |
br-xxxx |
| DBName |
string |
是 |
数据库名称。系统库 postgres、template0、template1 不支持查询 Schema。 |
neondb |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据对象。 |
||
| RequestId |
string |
请求 ID。 |
ABB39CC3-4488-4857-905D-2E4A051D**** |
| Sql |
string |
Schema SQL 内容。 |
CREATE TABLE public.example(id int); |
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
"Sql": "CREATE TABLE public.example(id int);"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。