Skip to content

API Cloud PyGWalker

Utilisez computation="cloud" lorsqu'une session PyGWalker active doit exécuter les requêtes de données via le cloud Kanaries. Utilisez les helpers cloud lorsque vous devez créer ou ouvrir directement des ressources cloud Kanaries.

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

create_cloud_dataset

create_cloud_dataset téléverse un dataset et retourne l'ID du dataset cloud.

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 peut être une DataFrame pandas, une DataFrame polars, une pyarrow Table ou un Connector de base de données.

Helpers cloud Walker hérités

Ces helpers existent pour la compatibilité avec d'anciens workflows 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="...",
)

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

Préférez computation="cloud" dans les API PyGWalker régulières lorsque l'objectif est le calcul cloud dans un notebook ou une application active.

Calcul cloud ou anciennes options

Utilisez :

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

Ne commencez pas de nouveau code avec :

pyg.walk(df, cloud_computation=True)

cloud_computation est une ancienne option de compatibilité et sa suppression est prévue dans PyGWalker 0.7.0. Elle entre aussi en conflit avec les valeurs computation non automatiques lorsqu'elle est activée.

Guides associés