Skip to content

PyGWalker 云 API

当 live PyGWalker 会话需要通过 Kanaries cloud 运行数据查询时，使用 computation="cloud"。当你需要直接创建或打开 Kanaries cloud 资产时，使用 cloud helper API。

import pygwalker as pyg
 
walker = pyg.walk(
    df,
    spec_path="./gw_config.json",
    computation="cloud",
    kanaries_api_key="...",
)

create_cloud_dataset

create_cloud_dataset 上传数据集，并返回云端 dataset ID。

from pygwalker.api.kanaries_cloud import create_cloud_dataset
 
dataset_id = create_cloud_dataset(
    df,
    name="sales_dataset",
    is_public=False,
    kanaries_api_key="...",
)

签名：

create_cloud_dataset(
    dataset,
    *,
    name=None,
    is_public=False,
    kanaries_api_key="",
) -> str

dataset 可以是 pandas DataFrame、polars DataFrame、pyarrow Table 或数据库 Connector。

旧 cloud walker helper

这些 helper 用于兼容旧的 cloud 工作流。

from pygwalker.api.kanaries_cloud import create_cloud_walker, walk_on_cloud
 
create_cloud_walker(
    df,
    chart_name="Revenue Dashboard",
    workspace_name="Analytics",
    kanaries_api_key="...",
)
 
walk_on_cloud(
    workspace_name="Analytics",
    chart_name="Revenue Dashboard",
    kanaries_api_key="...",
)

签名：

create_cloud_walker(
    dataset,
    *,
    chart_name,
    workspace_name,
    field_specs=None,
    kanaries_api_key="",
) -> str
 
walk_on_cloud(workspace_name, chart_name, kanaries_api_key="")

当目标是在 live notebook 或应用中使用云端计算时，请优先在常规 PyGWalker API 中使用 computation="cloud"。

云计算 vs 旧参数

使用：

pyg.walk(df, computation="cloud", kanaries_api_key="...")

不要在新代码中使用：

pyg.walk(df, cloud_computation=True)

cloud_computation 是旧兼容参数，并计划在 PyGWalker 0.7.0 中移除。启用时，它也会与非 auto 的 computation 值冲突。

相关指南