tencent cloud

简介

本文档提供关于检索对象内容相关的 API 概览以及 SDK 示例代码。

检索对象内容

功能说明

从指定对象中检索内容（SELECT Object content）。

方法原型

select_object_content(Bucket, Key, Expression, ExpressionType, InputSerialization, OutputSerialization, RequestProgress=None, **kwargs)

请求示例

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import 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 = 'SecretId'     # 替换为用户的 SecretId，请登录访问管理控制台进行查看和管理，https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # 替换为用户的 SecretKey，请登录访问管理控制台进行查看和管理，https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的region可以在控制台查看，https://console.intl.cloud.tencent.com/cos5/bucket
                         # COS支持的所有region列表参见https://intl.cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见https://intl.cloud.tencent.com/document/product/436/14048
scheme = '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'
      }
  }
)

全部参数请求示例

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'
  }
)

参数说明

返回结果说明

对象的 Body 和元信息，类型为 dict。

{
   'Body': EventStream(),
   'ETag': '"9a4802d5c99dafe1c04da0a8e7e166bf"',
   'Last-Modified': 'Wed, 28 Oct 2014 20:30:00 GMT',
   'Accept-Ranges': 'bytes',
   'Content-Range': 'bytes 0-16086/16087',
   'Cache-Control': 'max-age=1000000',
   'Content-Type': 'application/octet-stream',
   'Content-Disposition': 'attachment; filename="filename.jpg"',
   'Content-Encoding': 'gzip',
   'Content-Language': 'zh-cn',
   'Content-Length': '16807',
   'Expires': 'Wed, 28 Oct 2019 20:30:00 GMT',
   'x-cos-meta-test': 'test',
   'x-cos-version-id': 'MTg0NDUxODMzMTMwMDM2Njc1ODA',
   'x-cos-request-id': 'NTg3NzQ3ZmVfYmRjMzVfMzE5N182NzczMQ=='
}