tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
COSBrowser 快速入门
用户指南
创建请求
存储桶
对象
数据管理
批量处理
全球加速
监控与告警
运维中心
数据处理
内容审核
智能工具箱
数据工作流
应用集成
工具指南
工具概览
环境安装与配置
COSBrowser 工具
COSCLI 工具
COSCMD 工具
COS Migration 工具
FTP Server 工具
Hadoop 工具
COSDistCp 工具
HDFS TO COS 工具
GooseFS-Lite 工具
在线辅助工具
自助诊断工具
实践教程
概览
访问控制与权限管理
性能优化
使用 AWS S3 SDK 访问 COS
数据容灾备份
域名管理实践
图片处理实践
COS 音视频播放器实践
工作流实践
数据直传
内容审核实践
数据安全
数据校验
大数据实践
COS 成本优化解决方案
在第三方应用中使用 COS
迁移指南
本地数据迁移至 COS
第三方云存储数据迁移至 COS
以 URL 作为源地址的数据迁移至 COS
COS 之间数据迁移
Hadoop 文件系统与 COS 之间的数据迁移
数据湖存储
云原生数据湖
元数据加速
数据加速器 GooseFS
数据处理
数据处理概述
图片处理
媒体处理
内容审核
文件处理
文档处理
故障处理
获取 RequestId 操作指引
通过外网上传文件至 COS 缓慢
访问 COS 时返回403错误码
资源访问异常
POST Object 常见异常
API 文档
简介
公共请求头部
公共响应头部
错误码
请求签名
操作列表
Service 接口
Bucket 接口
Object 接口
批量处理接口
数据处理接口
任务与工作流
内容审核接口
云查毒接口
SDK 文档
SDK 概览
准备工作
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
小程序 SDK
错误码
鸿蒙(Harmony) SDK
终端 SDK 质量优化
安全与合规
数据容灾
数据安全
访问管理
常见问题
热门问题
一般性问题
计费计量问题
域名合规问题
存储桶配置问题
域名和 CDN 问题
文件操作问题
日志监控问题
权限管理问题
数据处理问题
数据安全问题
预签名 URL 问题
SDK 类问题
工具类问题
API 类问题
服务协议
Service Level Agreement
隐私政策
数据处理和安全协议
联系我们
词汇表

检索对象内容

PDF
聚焦模式
字号
最后更新时间: 2024-01-19 11:57:11

简介

本文档提供关于检索对象内容操作相关的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
检索对象内容
从指定对象(CSV 格式或者 JSON 格式)中检索内容

SDK API 参考

SDK 所有接口的具体参数与方法说明,请参考 SDK API

检索对象内容

功能说明

COS Select 支持检索以下格式的对象数据:
CSV 格式:对象以 CSV 格式存储,并以固定的分隔符划分。
JSON 格式:对象以 JSON 格式存储,可以是 JSON 文件或者 JSON 列表。
注意
使用 COS Select,您必须具有 cos:GetObject 的授权。
CSV、JSON 对象需要以 UTF-8 格式编码。
COS Select 支持检索 GZIP 或者 BZIP2 压缩的 CSV、JSON 对象。
COS Select 支持检索 SSE-COS 加密的 CSV、JSON 对象。

示例代码

QCloudSelectObjectContentRequest *request = [QCloudSelectObjectContentRequest new];
// 存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.tencentcloud.com/cos5/bucket
request.bucket = @"examplebucket-1250000000";
// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
request.object = @"exampleobject";
request.selectType = @"2";
// 选择文件 配置
QCloudSelectObjectContentConfig *config= [QCloudSelectObjectContentConfig new];
/**SQL 表达式,代表您需要发起的检索操作。例如SELECT s._1 FROM COSObject s。
这个表达式可以从 CSV 格式的对象中检索第一列内容。有关 SQL 表达式的详细介绍,
请参见 (Select)[https://www.tencentcloud.com/document/product/436/37636?from_cn_redirect=1] 命令
*/
config.express = @"select * from COSObject";
/**
表达式类型,该项为扩展项,目前只支持 SQL 表达式,仅支持 SQL 参数
*/
config.expressionType = QCloudExpressionTypeSQL;
/**
描述待检索对象的格式
*/
QCloudInputSerialization *inputS = [QCloudInputSerialization new];
inputS.compressionType = QCloudCOSXMLCompressionTypeNONE;
/**
描述在JSON对象格式下所需的文件参数。
*/
QCloudSerializationJSON *inputJson = [QCloudSerializationJSON new];
/**
SON 文件的类型:
DOCUMENT 表示 JSON 文件仅包含一个独立的 JSON 对象,且该对象可以被切割成多行
LINES 表示 JSON 对象中的每一行包含了一个独立的 JSON 对象
合法值为 DOCUMENT 、LINES
*/
inputJson.type = QCloudInputJSONFileTypeDocument;
inputS.serializationJSON = inputJson;
config.inputSerialization = inputS;
/**
描述检索结果的输出格式
*/
QCloudOutputSerialization *outputS = [QCloudOutputSerialization new];

QCloudSerializationJSON *outputJson = [QCloudSerializationJSON new];
/**
将输出结果中的记录分隔为不同行的字符,默认通过\\n进行分隔。您可以指定任意8进制字符,
如逗号、分号、Tab 等。该参数最多支持2个字节,即您可以输入\\r\\n这类格式的分隔符。默认值为\\n
*/
outputJson.outputRecordDelimiter = @"\\n";
/**
描述在JSON对象格式下所需的文件参数。
*/
outputS.serializationJSON = outputJson;

config.outputSerialization = outputS;
/**
是否需要返回查询进度 QueryProgress 信息,如果选中 COS Select 将周期性返回查询进度
*/
QCloudRequestProgress *requestProgress = [QCloudRequestProgress new];
requestProgress.enabled = @"FALSE";
config.requestProgress =requestProgress;
request.selectObjectContentConfig = config;
/**
文件存储在本地的路径
*/
request.downloadingURL = [NSURL fileURLWithPath:QCloudFileInSubPath(@"test", @"2.json")];
[request setDownProcessBlock:^(int64_t bytesDownload, int64_t totalBytesDownload, int64_t totalBytesExpectedToDownload) {
NSLog(@"⏬⏬⏬⏬DOWN [Total]%lld [Downloaded]%lld [Download]%lld", totalBytesExpectedToDownload, totalBytesDownload, bytesDownload);
}];

[request setFinishBlock:^(id _Nonnull result, NSError * _Nonnull error) {
NSLog(@"result = %@",result);
}];
[[QCloudCOSXMLService defaultCOSXML] SelectObjectContent:request];
说明
更多完整示例,请前往 GitHub 查看。
Swift
let request = QCloudSelectObjectContentRequest.init();
// 存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.tencentcloud.com/cos5/bucket
request.bucket = "examplebucket-1250000000";
// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
request.object = "exampleobject";
//代表这一接口的版本信息
request.selectType = "2";
// 选择文件 配置
let config = QCloudSelectObjectContentConfig();
/**SQL 表达式,代表您需要发起的检索操作。例如SELECT s._1 FROM COSObject s。
这个表达式可以从 CSV 格式的对象中检索第一列内容。有关 SQL 表达式的详细介绍,
请参见 (Select)[https://www.tencentcloud.com/document/product/436/37636?from_cn_redirect=1] 命令
*/

config.express = "Select * from COSObject";
/**
表达式类型,该项为扩展项,目前只支持 SQL 表达式,仅支持 SQL 参数
*/
config.expressionType = .SQL;

/**
描述待检索对象的格式
*/
let inputS = QCloudInputSerialization();
inputS.compressionType = .NONE;
/**
描述在JSON对象格式下所需的文件参数。
*/
let inputJson = QCloudSerializationJSON.init();
/**
SON 文件的类型:
DOCUMENT 表示 JSON 文件仅包含一个独立的 JSON 对象,且该对象可以被切割成多行
LINES 表示 JSON 对象中的每一行包含了一个独立的 JSON 对象
合法值为 DOCUMENT 、LINES
*/
inputJson.type = .document;

inputS.serializationJSON = inputJson;

config.inputSerialization = inputS;

/**
描述检索结果的输出格式
*/
let outputS = QCloudOutputSerialization.init();

let outputJson = QCloudSerializationJSON.init();
/**
将输出结果中的记录分隔为不同行的字符,默认通过\\n进行分隔。您可以指定任意8进制字符,
如逗号、分号、Tab 等。该参数最多支持2个字节,即您可以输入\\r\\n这类格式的分隔符。默认值为\\n
*/
outputJson.outputRecordDelimiter = "\\n";
outputS.serializationJSON = outputJson;

config.outputSerialization = outputS;
/**
是否需要返回查询进度 QueryProgress 信息,如果选中 COS Select 将周期性返回查询进度
*/
let requestProgress = QCloudRequestProgress.init();
requestProgress.enabled = "FALSE";
config.requestProgress = requestProgress;
request.selectObjectContentConfig = config;
//文件在本地的存储路径
request.downloadingURL = NSURL.fileURL(withPath: QCloudFileInSubPath("test", "2.json"));
request.finishBlock = {(result,error) in
if error != nil{
print(error!)
}else{
print(result!);
}
}

QCloudCOSXMLService.defaultCOSXML().selectObjectContent(request);
说明
更多完整示例,请前往 GitHub 查看。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈