Use MaxFrame in a local environment-MaxCompute(MaxCompute)-阿里云帮助中心

MaxCompute supports using MaxFrame through the MaxFrame SDK (local MaxFrame client). This topic describes how to use MaxFrame in a local environment.

Prerequisites

Before using MaxFrame, ensure you have completed the following preparations:

Your local system has Python 3.7 or 3.11 installed. Using other versions may cause errors.
Your local system has pip installed. If not, visit the Python official website for pip installation instructions.
You have created a MaxCompute project. For more information, see Create a MaxCompute project.

Install MaxFrame

In your system’s command-line window (such as the Windows CMD window), install the MaxFrame client by running the following pip command:
```
pip install --upgrade maxframe
```

Run the following command to verify that MaxFrame installed successfully. If no output or error appears, the installation succeeded.

python -c "import maxframe.dataframe as md"

If an error appears, check your system’s default Python version and switch to Python 3.7 or 3.11. For example:

# Check the system default version
python --version 

# Switch the system default version to Python 3.7, where $path/python3.7 is the installed Python path
$path/python3.7 -m pip install setuptools>=3.0

Use MaxFrame

Create a local file with the .py extension (for example, test.py). Copy the following sample code into test.py and save the file.

import os
import maxframe.dataframe as md
from odps import ODPS
from maxframe import new_session

# Create a MaxCompute entry point
o = ODPS(
    # Set the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable to your AccessKey ID,
    # and ALIBABA_CLOUD_ACCESS_KEY_SECRET to your AccessKey secret.
    # Do not use AccessKey ID and AccessKey secret strings directly.
    os.getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    os.getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
    project='your-default-project',
    endpoint='your-end-point',
)
table = o.create_table("test_source_table", "a string, b bigint", if_not_exists=True)
with table.open_writer() as writer:
    writer.write([
        ["value1", 0],
        ["value2", 1],
    ])

# Create a MaxFrame session
session = new_session(o)

df = md.read_odps_table("test_source_table",index_col="b")
df["a"] = "prefix_" + df["a"]

# Print dataframe data
print(df.execute().fetch())

# Write MaxFrame DataFrame data to a MaxCompute table
md.to_odps_table(df, "test_prefix_source_table").execute()

# Destroy the MaxFrame session
session.destroy()

Parameter descriptions:

ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET: Set these environment variables to the AccessKey ID and AccessKey secret that have the required permissions for your target MaxCompute project. You can obtain your AccessKey ID from the AccessKey management page.
your-default-project: The name of your MaxCompute project. Log on to the MaxCompute console, and in the left navigation pane, choose Workspace > Projects to view it.
your-end-point: The Endpoint of the region where your MaxCompute project resides. For more information, see Endpoint.

Navigate to the directory containing test.py and run the Python file. For example:
```
python test.py
```

Result validation

After running the Python code, query the sink table data. If the result matches expectations, MaxFrame is installed successfully and connected to the MaxCompute cluster.

Running the Python code returns the following result:
```
b           a
0  prefix_value1
1  prefix_value2
```

In your target MaxCompute project, run the following SQL to query data in the test_prefix_source_table table.

SELECT * FROM test_prefix_source_table;

The returned result is:

+------------+------------+
| b          | a          |
+------------+------------+
| 0          | prefix_value1 |
| 1          | prefix_value2 |
+------------+------------+