Zettapark

Zettapark is a Python DataFrame library for ClickZetta. It provides a familiar SQL and DataFrame programming model for querying and transforming data in ClickZetta.

Highlights

• DataFrame-style API for ClickZetta workloads
• SQL and DataFrame workflows in the same session
• Local data and pandas DataFrame ingestion
• Python UDF support

Requirements

• Python 3.8+
• Access to a ClickZetta environment
• Python UDF features require Python 3.10

Installation

Install from PyPI:

pip install clickzetta-zettapark-python

Import the main entry point:

from clickzetta.zettapark import Session

Quick Start

1. Create a session

from clickzetta.zettapark import Session

connection_parameters = {
    "username": "<username>",
    "password": "<password>",
    "service": "<service>",
    "instance": "<instance>",
    "workspace": "<workspace>",
    "schema": "<schema>",
    "vcluster": "<vcluster>",
}

session = Session.builder.configs(connection_parameters).create()

Use the standard ClickZetta connector parameter names shown above.

2. Run SQL

rows = session.sql("select 1 as id, 'hello' as message").collect()
print(rows)

Session.sql() is lazy. Execution starts when you call an action such as collect(), show(), or to_pandas().

3. Use the DataFrame API

from clickzetta.zettapark.functions import col

source_df = session.create_dataframe(
    [[1, "alice"], [2, "bob"], [3, "cindy"]],
    schema=["id", "name"],
)

source_df.filter(col("id") >= 2).show()

You can mix SQL and DataFrame operations in the same workflow:

from clickzetta.zettapark.functions import avg

sales_df = session.table("sales.orders")
summary_df = sales_df.group_by("region").agg(avg("amount").alias("avg_amount"))
summary_df.sort("region").show()

4. Create a DataFrame from pandas

import pandas as pd

pdf = pd.DataFrame(
    [(1, "beijing"), (2, "shanghai")],
    columns=["id", "city"],
)

session.create_dataframe(pdf).show()

Resources

• Package: clickzetta-zettapark-python
• Homepage: https://www.yunqi.tech/
• Documentation: https://yunqi.tech/documents
• ClickZetta docs: https://doc.clickzetta.com/
• Development and contribution guide: AGENTS.md

License

Apache-2.0. See LICENSE.txt for details.