标量过滤查询
更新时间：2025-04-18
POST
http://{host}/v{version}/row?select
基于标量属性过滤查询记录。
权限说明
鉴权认证机制的详细内容请参见鉴权认证
请求参数
Headers 参数
除公共头域外，无其它特殊头域
URL 参数
version
string
API版本号，当前取1。
必选
host
string
"{实例IP}:{实例Port}"
必选
Query 参数
select
string
标量过滤查询操作
可选
Body 参数
database
string
指定库的名称。
必选
table
string
指定表的名称。
必选
filter
string
过滤条件。Filter表达式语法参照SQL的WHERE子句语法进行设计，其详细描述和使用示例请参见Filter条件表达式。必须填写主键值或过滤条件，二者有且仅能选其一。
可选
marker
object
查询的分页起始点，用于控制分页查询返回结果的起始位置，方便用户对数据进行分页展示和浏览，用户不填时，默认从第一条符合条件的记录开始返回。
可选
显示子属性
隐藏子属性
limit
integer
查询返回的记录条数，在进行分页查询时，即每页的记录条数。
默认为10，取值范围[1, 1000]。
可选
projections
array
投影字段列表，默认为空，为空时查询结果默认返回所有标量字段。
可选
显示子属性
隐藏子属性
items
string
readConsistency
string
查询请求的一致性级别，取值为：
可选
请求结构
POST /v{version}/row?select HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
"database": "db_test",
"table": "table_test",
"filter": "column1 = 'test' and column2 < 20",
"marker": {
"id": 10
},
"limit": 50,
"projections": ["column1", "column2", "vector"],
"readConsistency": "EVENTUAL"
}示例代码
请求示例
curl --location 'http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/row?select' \
--header 'Authorization: Bearer account=root&api_key=eC4bLRy2va******************************' \
--header 'Content-Type: application/json' \
--data '{
"database": "db_test",
"table": "table_test",
"filter": "column1 = \'test\' and column2 < 20",
"marker": {
"id": 10
},
"limit": 50,
"projections": ["column1", "column2", "vector"],
"readConsistency": "EVENTUAL"
}'返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
msg
string
返回信息
可选
code
integer
返回码
可选
rows
array
结果数据集
可选
显示子属性
隐藏子属性
items
object
显示子属性
隐藏子属性
nextMarker
object
分页查询时的下一次查询起始点，当isTruncated为true时，可以利用该字段当作下一次的查询起始点分页查询。
可选
显示子属性
隐藏子属性
isTruncated
boolean
结果是否截断，即是否返回所有满足过滤条件记录：，
可选
响应示例
{
"isTruncated": true,
"nextMarker": {
"id": 100
},
"rows": [
{
"id": 10,
"column1": "test",
"column2": 15,
"vector": [
0.23432432,
0.8923744,
0.89238432
]
}
],
"code": 0,
"msg": "Success"
}