SelectObject
对目标文件执行SQL语句,返回执行结果
服务地址:
华东1 金融云
输入参数
只看必填
bucketBucket名称
keyObject的完整路径
x-oss-process如果是csv文件
body保存SelectObject请求的容器
SelectRequest保存Select请求的容器
Expression以Base64 编码的SQL语句
InputSerialization保存Select请求的容器
CompressionType指定文件压缩类型(可选)
CSV保存Select请求的容器
FileHeaderInfo指定CSV文件头信息(可选)
RecordDelimiter指定换行符
FieldDelimiter指定CSV列分隔符
QuoteCharacter指定CSV的引号字符
CommentCharacter指定CSV的注释符
Range指定查询文件的范围(可选)
AllowQuotedRecordDelimiter指定CSV内容是否含有在引号中的换行符
请选择布尔值
JSON保存Select请求的容器
Type指定输入JSON的类型
Range指定查询文件的范围(可选)
ParseJsonNumberAsString将JSON中的数字(整数和浮点数)解析...
请选择布尔值
OutputSerialization保存Select请求的容器
CSV保存Select请求的容器
RecordDelimiter指定换行符
FieldDelimiter指定CSV列分隔符
JSON保存Select请求的容器
RecordDelimiter指定换行符
KeepAllColumns指定返回结果中包含CSV所有列的位置(可选)
请选择布尔值
OutputHeader在返回结果开头输出CSV头信息
请选择布尔值
OutputRawData指定输出数据为纯数据
请选择布尔值
EnablePayloadCrc在每个Frame中会有一个32位的CR...
请选择布尔值
Options保存Select请求的容器
SkipPartialDataRecord忽略缺失数据的行
请选择布尔值
MaxSkippedRecordsAllowed指定最大能容忍的跳过的行数
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 此操作要求您对该 Object 有读权限。
  • 正确执行时,该 API 返回 206。如果 SQL 语句不正确,或者和文件不匹配,则会返回 400 错误。
  • 关于 SelectObject 的功能介绍请参见使用 SelectObject 查询文件

请求语法

POST /{key} HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
<?xml version="1.0" encoding="UTF-8"?>
<SelectRequest>
  <Expression>string</Expression>
  <InputSerialization>
    <CompressionType>string</CompressionType>
    <CSV>
      <FileHeaderInfo>string</FileHeaderInfo>
      <RecordDelimiter>string</RecordDelimiter>
      <FieldDelimiter>string</FieldDelimiter>
      <QuoteCharacter>string</QuoteCharacter>
      <CommentCharacter>string</CommentCharacter>
      <Range>string</Range>
      <AllowQuotedRecordDelimiter>boolean</AllowQuotedRecordDelimiter>
    </CSV>
    <JSON>
      <Type>string</Type>
      <Range>string</Range>
      <ParseJsonNumberAsString>boolean</ParseJsonNumberAsString>
    </JSON>
  </InputSerialization>
  <OutputSerialization>
    <CSV>
      <RecordDelimiter>string</RecordDelimiter>
      <FieldDelimiter>string</FieldDelimiter>
    </CSV>
    <JSON>
      <RecordDelimiter>string</RecordDelimiter>
    </JSON>
    <KeepAllColumns>boolean</KeepAllColumns>
    <OutputHeader>boolean</OutputHeader>
    <OutputRawData>boolean</OutputRawData>
    <EnablePayloadCrc>boolean</EnablePayloadCrc>
  </OutputSerialization>
  <Options>
    <SkipPartialDataRecord>boolean</SkipPartialDataRecord>
    <MaxSkippedRecordsAllowed>integer</MaxSkippedRecordsAllowed>
  </Options>
</SelectRequest>

路径参数

字段名称字段详情
keystring

Object 的完整路径。

示例值:exampledir/exampleobject.txt

请求参数

字段名称字段详情
bucketstring

Bucket 名称。

示例值:examplebucket
x-oss-processstring

如果是 csv 文件,该值需要设置为 csv/select;如果是 json 文件,则需要设置为 json/select。

示例值:csv/select
bodyobject

保存 SelectObject 请求的容器。

返回参数

字段名称字段详情
string<binary>
  • 若 header x-oss-select-output-raw 值为 true,则表明返回结果是对象数据(而不是 Frame 包装的),客户端可以完全按照 Get API 的方式获取数据。展开详情
示例值:
变更历史
变更时间变更内容概要操作
2025-03-04
新增请求参数body
新增请求参数x-oss-process