You need to enable JavaScript to run this app.
文档中心
AI 原生 BaaS 平台 Supabase 版

AI 原生 BaaS 平台 Supabase 版

请输入
  • 文档首页
    • AI 原生 BaaS 平台 Supabase 版SDK 参考使用 Python SDK
复制全文
下载 pdf
我的收藏
SDK 参考
使用 Python SDK
复制全文
下载 pdf
我的收藏
使用 Python SDK
本文介绍使用 AI 原生 BaaS 平台 Supabase 版的 Python SDK 的相关信息。​
下载与安装​
前提条件​
已安装 Python 2.7 或以上版本。​
说明​
您可以执行 python --version 命令检查当前 Python 的版本。​
SDK 下载地址​
AI 原生 BaaS 平台 Supabase 版 Python SDK 源码地址，请参见 SDK 源码。​
安装 SDK​
您可以使用以下任意一种方式安装 SDK：​
  • 通过 pip 安装。​
​
pip install volcengine-python-sdk​
​
  • 下载 AI 原生 BaaS 平台 Supabase 版 Python SDK 源码并通过 Setuptools 工具安装：​
​
# 执行如下命令为指定 user 安装 SDK。​
python setup.py install --user​
​
# 执行如下命令为全部 user 安装 SDK，以 root 权限把 SDK 安装到系统全局环境​
sudo python setup.py install​
​
  • 如果已经安装过 SDK，可使用如下命令升级。​
​
pip install --upgrade volcengine​
​
初始化客户端​
AI 原生 BaaS 平台 Supabase 版 Python 客户端提供了一系列接口与 Supabase 服务进行交互，用来管理 Supabase 资源。您需要先初始化 Python 客户端，才可以向 Supabase 服务发送 HTTP/HTTPS 请求。本文介绍如何初始化 Supabase Python 客户端。​
前提条件​
  • 已获取账号的 Access Key ID（简称 AK）和 Secret Access Key（简称 SK）信息。具体操作，请参见 Access Key 管理。​
  • 已获取 AI 原生 BaaS 平台 Supabase 版支持的 Region 和对应的 Host，请参见服务地址。​
  • 已下载并安装 AI 原生 BaaS 平台 Supabase 版 Python SDK。​
初始化客户端​
使用以下代码初始化客户端。​
​
import volcenginesdkaidap​
import volcenginesdkcore​
​
​
def get_aidap_client():​
configuration = volcenginesdkcore.Configuration()​
configuration.ak = "Your AK"​
configuration.sk = "Your SK"​
configuration.region = "Your Region" # 例如 cn-beijing​
configuration.host = "Your Endpoint" # AI原生BaaS平台Supabase版服务地址​
# 开启客户端侧校验：若 SDK 中某些字段是枚举，传入非法值会提前抛错。​
configuration.client_side_validation = True​
volcenginesdkcore.Configuration.set_default(configuration)​
​
return volcenginesdkaidap.AIDAPApi()​
​
代码示例​
请求超时时间设置​
使用 SDK 调用接口时，默认无超时时间限制。您可以在发起接口调用请求时，在代码的最后加上 _request_timeout 参数指定请求的超时时间（单位：秒），若未在该时间内完成，请求会立即终止并报超时错误。例如，您可以在调用 DescribeWorkspaceDetail 接口时，通过以下代码设置超时时间为 10 秒。​
​
aidap_api = get_aidap_client()​
​
resp = aidap_api.describe_workspace_detail(​
volcenginesdkaidap.DescribeWorkspaceDetailRequest(​
workspace_id=workspace_id,​
), ​
_request_timeout=10 # 设置请求超时时间为 10s​
)​
​
创建 Workspace 示例​
以下 SDK 代码中所使用的参数的定义、取值范围等信息，请参见 CreateWorkspace。​
​
from pprint import pprint​
​
import volcenginesdkaidap​
from volcenginesdkcore.rest import ApiException​
​
from client.client import get_aidap_client​
​
# 创建 workspace​
def create_workspace():​
aidap_api = get_aidap_client()​
​
request = volcenginesdkaidap.CreateWorkspaceRequest(​
workspace_name=f"test-workspace",​
engine_version="PostgreSQL_17",​
)​
​
try:​
resp = aidap_api.create_workspace(request)​
pprint(resp)​
return resp​
except ApiException as e:​
print("Exception when calling AIDAPApi -> create_workspace: %s\n" % e)​
return None​
​
本示例中的参数说明如下表所示。​
​
配置项​
说明​
取值​
WorkspaceName​
Workspace 名称。​
test-worksapce​
EngineVersion​
引擎版本。取值：​
  • PostgreSQL_17： PostgreSQL 17。​
  • veDB_MySQL_8_0：veDB MySQL 8.0。​
  • Supabase_1_24：Supabase 1.24。​
PostgreSQL_17​
​
查询 Workspace 详情​
以下 SDK 代码中所使用的参数的定义、取值范围等信息，请参见 DescribeWorkspaceDetail。​
​
from pprint import pprint​
​
import volcenginesdkaidap​
from volcenginesdkcore.rest import ApiException​
​
from client.client import get_aidap_client​
​
# 获取 worksapce 详情​
def describe_workspace_detail(workspace_id: str):​
aidap_api = get_aidap_client()​
​
try:​
resp = aidap_api.describe_workspace_detail(​
volcenginesdkaidap.DescribeWorkspaceDetailRequest(​
workspace_id=workspace_id,​
),​
_request_timeout=10​
)​
pprint(resp)​
return resp​
except ApiException as e:​
print("Exception when calling AIDAPApi->describe_workspace_detail: %s\n" % e)​
return None​
​
本示例中的参数说明如下表所示。​
​
配置项​
说明​
取值​
WorkspaceId​
Workspace id。​
test-worksapce-id​
​
最近更新时间：2026.06.23 15:59:58
这个页面对您有帮助吗？
有用
有用
无用
无用