Skip to content

PyGWalker Cloud API

ライブ PyGWalker セッションでデータクエリを Kanaries cloud 経由で実行したい場合は computation="cloud" を使います。Kanaries cloud assets を直接作成または開く必要がある場合は 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 はデータセットをアップロードし、cloud 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="...",
)

Signature:

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 workflow との互換性のために存在します。

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="...",
)

Signatures:

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="")

ライブ notebook またはアプリでクラウド計算を行うことが目的なら、通常の PyGWalker API では computation="cloud" を優先します。

Cloud computation とレガシーフラグ

使うべき書き方:

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

新しいコードで次のように始めないでください。

pyg.walk(df, cloud_computation=True)

cloud_computation はレガシー互換フラグで、PyGWalker 0.7.0 で削除予定です。有効化された場合、非 auto の computation 値とも競合します。

関連ガイド