API | 操作名 | 操作描述 |
检索对象内容 | 从指定对象中检索内容 |
select_object_content(Bucket, Key, Expression, ExpressionType, InputSerialization, OutputSerialization, RequestProgress=None, **kwargs)
# -*- coding=utf-8from qcloud_cos import CosConfigfrom qcloud_cos import CosS3Clientimport sysimport osimport logging# 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息logging.basicConfig(level=logging.INFO, stream=sys.stdout)# 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.tencentcloud.com/cos5/bucket# COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)client = CosS3Client(config)response = client.select_object_content(Bucket='examplebucket-1250000000',Key='exampleobject',Expression='Select * from COSObject',ExpressionType='SQL',InputSerialization={'CompressionType': 'NONE','JSON': {'Type': 'LINES'}},OutputSerialization={'CSV': {'RecordDelimiter': '\\n'}})# 获取封装在响应结果中的 EventStream 实例event_stream = response['Payload']# 一次性获取全部检索结果# 注意, 因为 EventStream 对检索结果的获取是流式的, 所以当您再次调用 get_select_result() 方法时将返回空集result = event_stream.get_select_result()print(result)
response = client.select_object_content(Bucket='examplebucket-1250000000',Key='exampleobject',Expression='Select * from COSObject',ExpressionType='SQL',InputSerialization={'CompressionType': 'GZIP','JSON': {'Type': 'LINES'}},OutputSerialization={'CSV': {'RecordDelimiter': '\\n'}},RequestProgress={'Enabled': 'FALSE'})
参数名称 | 参数描述 | 类型 | 是否必填 |
Bucket | 存储桶名称,由 BucketName-APPID 构成 | String | 是 |
Key | 对象键(Key)是对象在存储桶中的唯一标识。例如,在对象的访问域名 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg 中,对象键为 doc/pic.jpg | String | 是 |
Expression | SQL 表达式,代表您需要发起的检索操作 | String | 是 |
ExpressionType | 表达式类型,该项为扩展项,目前只支持 SQL 表达式,仅支持 SQL 参数 | String | 是 |
InputSerialization | 描述待检索对象的格式,详情参见 请求示例 | Dict | 是 |
OutputSerialization | 描述检索结果的输出格式,详情参见 请求示例 | Dict | 是 |
RequestProgress | 是否需要返回查询进度 QueryProgress 信息,如果选中 COS Select 将周期性返回查询进度 | Dict | 否 |
{'Payload': EventStream()}
'Payload'
,Value 为EventStream
实例的 Key-Value 对,对象的检索结果封装在 EventStream
实例里,您可以调用其 next_event()
、get_select_result()
以及get_select_result_to_file()
方法获取检索结果。
本页内容是否解决了您的问题?