准备工作

通过本地客户端访问MaxFrame

1. 在系统的命令行执行窗口（例如Windows的CMD窗口）中，通过pip命令安装MaxFrame客户端。命令如下：

   pip install maxframe

2. 创建MaxFrame会话。

   1. 创建一个后缀名为.py的PY文件（以test.py为例），将下述示例代码复制到test.py中并保存。

      import os
      import maxframe.dataframe as md
      from odps import ODPS
      from maxframe import new_session
      
      # 创建MaxCompute入口
      o = ODPS(
          # 确保 ALIBABA_CLOUD_ACCESS_KEY_ID 环境变量设置为用户 Access Key ID，
          # ALIBABA_CLOUD_ACCESS_KEY_SECRET 环境变量设置为用户 Access Key Secret，
          # 不建议直接使用AccessKey ID和 AccessKey Secret字符串。
          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],
          ])
      
      # 创建MaxFrame session
      session = new_session(o)
      
      df = md.read_odps_table("test_source_table",index_col="b")
      df["a"] = "prefix_" + df["a"]
      
      # 打印dataframe数据
      print(df.execute().fetch())
      
      # MaxFrame DataFrame数据写入MaxCompute表
      md.to_odps_table(df, "test_prefix_source_table").execute()
      
      # 销毁 maxframe session
      session.destroy()

      参数说明：

      • ALIBABA_CLOUD_ACCESS_KEY_ID：需将该环境变量设置为具备目标MaxCompute项目中待操作对象相关MaxCompute权限的AccessKey ID。您可以进入AccessKey管理页面获取AccessKey ID。

      • ALIBABA_CLOUD_ACCESS_KEY_SECRET：需将该环境变量设置为AccessKey ID对应的AccessKey Secret。

      • your-default-project：使用的MaxCompute项目名称。您可以登录MaxCompute控制台，在左侧导航栏选择工作区>项目管理，查看MaxCompute项目名称。

      • your-end-point：目标MaxCompute项目所在地域的Endpoint。详情请参见Endpoint。

   2. 进入test.py所在的文件路径，运行Python文件。命令示例如下：

      python test.py

通过DataWorks访问MaxFrame

DataWorks为MaxCompute项目提供任务调度能力，且已在PyODPS 3节点内置了MaxFrame，您可以直接使用DataWorks的PyODPS 3节点开发和运行MaxFrame作业。

1. 创建PyODPS 3节点。

   您可以进入DataWorks的数据开发页面创建PyODPS 3节点，详情请参见开发PyODPS 3任务。

2. 创建MaxFrame会话。

   PyODPS 3内置了MaxCompute用户和项目信息，因此您可以直接创建MaxFrame会话。代码示例如下：

   import maxframe.dataframe as md
   from maxframe import new_session
   from maxframe.config import options
   options.sql.enable_mcqa = False
   
   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],
       ])
   
   # 创建MaxFrame session
   session = new_session(o)
   
   df = md.read_odps_table("test_source_table",index_col="b")
   df["a"] = "prefix_" + df["a"]
   
   # 打印dataframe数据
   print(df.execute().fetch())
   
   # MaxFrame DataFrame数据写入MaxCompute表
   md.to_odps_table(df, "test_prefix_source_table").execute()
   
   # 销毁 maxframe session
   session.destroy()
   

通过MaxCompute Notebook访问MaxFrame

MaxCompute Notebook已内置MaxFrame和MaxCompute账号认证信息，您无需提供AK和SK，即可直接连接MaxCompute项目并进行开发。

创建MaxFrame会话的代码示例如下：

import maxframe.dataframe as md
from odps import ODPS
from maxframe import new_session
from maxframe.config import options
options.sql.enable_mcqa = False


# create MaxCompute entrance object
o = ODPS(
    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],
    ])

# 创建MaxFrame session
session = new_session(o)

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

# 打印dataframe数据
print(df.execute().fetch())

# MaxFrame DataFrame数据写入MaxCompute表
md.to_odps_table(df, "test_prefix_source_table").execute()

# 销毁 maxframe session
session.destroy()