PyODPS支持MaxCompute SQL的查询和读取执行结果。

执行SQL

入口对象的execute_sql()和run_sql()方法可以执行SQL语句，其返回值是任务实例。详情请参见任务实例 。

参数说明
  • statement：需要执行的SQL语句。
    说明 在MaxCompute客户端中可以执行的SQL语句并非都可以通过入口对象的execute_sql()和run_sql()方法执行。 在调用非DDL或非DML语句时，请使用其它方法。例如，调用GRANT或REVOKE语句时，请使用run_security_query方法；调用PAI命令时，请使用run_xflow或execute_xflow方法。
  • hints：设置运行时参数，参数类型是DICT。
示例
  • 执行SQL语句。 
    o.execute_sql('select * from dual')  #同步的方式执行，会阻塞直到SQL语句执行完成。
instance = o.run_sql('select * from dual')  #异步的方式执行。
print(instance.get_logview_address())  # 获取Logview地址。
instance.wait_for_success()  # 阻塞直到完成。
  • 执行SQL语句时，运行参数。 
    o.execute_sql('select * from pyodps_iris', hints={'odps.sql.mapper.split.size': 16})
    如果全局配置设置了sql.settings，则每次运行时都会添加相关的运行时参数。 
    from odps import options
options.sql.settings = {'odps.sql.mapper.split.size': 16}
o.execute_sql('select * from pyodps_iris')  # 会根据全局配置添加hints。

读取SQL执行结果

运行SQL的Instance能够直接执行open_reader操作读取SQL执行结果。读取时会出现以下两种情况：
  • SQL返回了结构化的数据。 
    with o.execute_sql('select * from dual').open_reader() as reader:
    for record in reader:
    # 处理每一个record。
  • SQL可能执行了desc命令，这时可以通过reader.raw取到原始的SQL执行结果。 
    with o.execute_sql('desc dual').open_reader() as reader:
    print(reader.raw)
如果options.tunnel.use_instance_tunnel == True，在使用open_reader方法时，PyODPS会默认调用Instance Tunnel。如果您使用了较低版本的MaxCompute服务，或者调用Instance Tunnel出现了问题，PyODPS会给出警告并自动降级到旧的Result接口。您可根据警告信息判断导致降级的原因。如果Instance Tunnel的结果不合预期，请将该选项设为False。在使用open_reader方法时，也可以使用Tunnel参数来指定使用的Result接口。 
# 使用Instance Tunnel。
with o.execute_sql('select * from dual').open_reader(tunnel=True) as reader:
    for record in reader:
    # 处理每一个record。
# 使用Results接口。
with o.execute_sql('select * from dual').open_reader(tunnel=False) as reader:
    for record in reader:
    # 处理每一个record。

PyODPS默认不限制从Instance读取的数据规模。但是对于受保护的项目，通过Tunnel下载数据将受限。此时，如果未设置options.tunnel.limit_instance_tunnel，则数据量限制会被自动打开，可下载的数据条数受到项目配置限制，最多为10000条。如果您需要手动限制下载数据的规模，可以为open_reader方法增加limit选项， 或者设置options.tunnel.limit_instance_tunnel = True 。

如果您使用的MaxCompute只能支持旧Result接口，并且需要读取所有的数据，您可将SQL结果写入另一张表后用读表接口读取（可能受到Project安全设置的限制）。

从PyODPS v0.7.7.1开始，您可以通过open_reader方法使用Instance Tunnel获取全量数据。详情请参见Instance tunnel。 
instance = o.execute_sql('select * from movielens_ratings limit 20000')
with instance.open_reader() as reader:
    print(reader.count)
    # for record in reader 遍历这2万条数据，这里通过切片只取10条。
    for record in reader[:10]:  
        print(record)

设置alias

如果某个UDF引用的资源是动态变化的，您可以给旧的资源一个别名作为新的资源，无需重新删除或创建新的UDF。

from odps.models import Schema
myfunc = '''\
from odps.udf import annotate
from odps.distcache import get_cache_file

@annotate('bigint->bigint')
class Example(object):
    def __init__(self):
        self.n = int(get_cache_file('test_alias_res1').read())

    def evaluate(self, arg):
        return arg + self.n
'''
res1 = o.create_resource('test_alias_res1', 'file', file_obj='1')
o.create_resource('test_alias.py', 'py', file_obj=myfunc)
o.create_function('test_alias_func',
                  class_type='test_alias.Example',
                  resources=['test_alias.py', 'test_alias_res1'])

table = o.create_table(
    'test_table',
    schema=Schema.from_lists(['size'], ['bigint']),
    if_not_exists=True
)

data = [[1, ], ]
# 写入一行数据，只包含一个值1。
o.write_table(table, 0, [table.new_record(it) for it in data])

with o.execute_sql(
    'select test_alias_func(size) from test_table').open_reader() as reader:
    print(reader[0][0])
res2 = o.create_resource('test_alias_res2', 'file', file_obj='2')
# 把内容为1的资源别名设置成内容为2的资源。您不需要修改UDF或资源。
with o.execute_sql(
    'select test_alias_func(size) from test_table',
    aliases={'test_alias_res1': 'test_alias_res2'}).open_reader() as reader:
    print(reader[0][0])

在交互式环境执行SQL

在IPython和Jupyter里支持使用SQL插件的方式运行SQL和参数化查询，详情请参见IPython增强和Jupyter Notebook增强。

设置biz_id

在少数情形下，提交SQL时需要同时提交biz_id，否则执行会报错。此时，您可以通过设置全局options里的biz_id解决此类报错。 
from odps import options
options.biz_id = 'my_biz_id'
o.execute_sql('select * from pyodps_iris')