Row 操作

更新时间：2025-10-10

插入记录

功能介绍

将一条或者一批记录插入到指定的表中。插入语义为Insert，若记录的主键已存在，则插入失败并报错。当插入一批时，该接口暂不支持批次的原子性。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import Row

account = 'root'
api_key = '$您的账户API密钥'
endpoint = '$您的实例访问端点' # 例如：'http://127.0.0.1:5287'

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")

table = db.table("book_vector")
rows = [
    Row(id='0001',
        vector=[0.2123, 0.21, 0.213],
        bookName='西游记'),
]
table.insert(rows)

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
rows	List<Row>	是	插入的记录列表。

插入或更新记录

功能介绍

将一条或者一批记录插入到指定的表中。插入语义为Upsert（Insert or else Update），即，当记录的主键不存在时，则正常插入，若发现主键已存在，则用新的记录覆盖旧的记录。当插入一批时，该接口暂不支持批次的原子性。该接口可用于批量迁移/灌库等场景。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import Row

account = 'root'
api_key = '$您的账户API密钥'
endpoint = '$您的实例访问端点' # 例如：'http://127.0.0.1:5287'

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")

table = db.table("book_vector")
rows = [
    Row(id='0001',
        vector=[0.2123, 0.21, 0.213],
        bookName='西游记'),
]
table.upsert(rows)

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
rows	List<Row>	是	待插入记录列表。

更新记录

功能介绍

更新表中指定记录的一个或多个标量字段的值

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
account = 'root'
api_key = '$您的账户API密钥'
endpoint = '$您的实例访问端点' # 例如：'http://127.0.0.1:5287'
config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)
db = client.database("db_test")
table = db.table("book_vector")
primary_key = {'id': '0001'}
update_fields = {'bookName': '红楼梦'}
table.update(primary_key=primary_key, update_fields=update_fields)
client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
primary_key	Json	是	指定记录的主键值。
partition_key	Json	否	指定记录的分区键值。如果该表的分区键和主键是同一个键，则不需要填写分区键值。只有在有主键值的情况下，分区键值才会生效。
update_fields	Json	是	待更新的字段列表及其新值。不允许更新主键、分区键和向量字段。

删除记录

功能介绍

删除表中的指定记录。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials

account = 'root'
api_key = '$您的账户API密钥'
endpoint = '$您的实例访问端点' # 例如：'http://127.0.0.1:5287'

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")

table = db.table("book_vector")
primary_key = {'id': '0001'}
table.delete(primary_key) # 基于主键的查询删除
table.delete(filter="id=='0001'") # 基于标量字段的过滤删除

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
primary_key	Json	否	指定记录的主键值。
partition_key	Json	否	指定记录的分区键值。如果该表的分区键和主键是同一个键，则不需要填写分区键值。只有在有主键值的情况下，分区键值才会生效。
filter	String	否	删除的标量过滤条件。当要删除全部记录，可设置为"*"；Filter表达式语法参照SQL的WHERE子句语法进行设计，其详细描述和使用示例请参见Filter条件表达式。必须填写主键值或过滤条件，二者有且仅能选其一。

标量查询

功能介绍

基于主键值进行点查。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials

account = 'root'
api_key = '$您的账户API密钥'
endpoint = '$您的实例访问端点' # 例如：'http://127.0.0.1:5287'

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")

table = db.table("book_vector")
primary_key = {'id': '0001'}
projections = ["id", "bookName"]
res = table.query(primary_key=primary_key, projections=projections)

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
primary_key	Json	是	指定记录的主键值。
partition_key	Json	否	指定记录的分区键值。如果该表的分区键和主键是同一个键，则不需要填写分区键值。
projections	List<String>	否	投影字段列表，默认为空，为空时查询结果默认返回所有标量字段。
retrieve_vector	Boolean	否	是否返回结果记录中的向量字段值，默认为False。
read_consistency	ReadConsistency	否	查询请求的一致性级别，取值为： EVENTUAL（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； STRONG：强一致性，查询请求只会发送给分片主副本。

批量标量查询

功能介绍

基于主键值的批量点查操作。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import BatchQueryKey

account = 'root'
api_key = 'your_api_key'
endpoint = 'you_endpoint' #example http://127.0.0.1:8511

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")
keys = [BatchQueryKey({'id':'0001'}), 
        BatchQueryKey({'id':'0002'})]
projections = ["id", "bookName"]
res = table.batch_query(keys=keys, projections=projections)
client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
keys	List<BatchQueryKey>	是	目标记录的主键及分区键
projections	List<String>	否	投影字段列表，默认为空，为空时查询结果默认返回所有标量字段。
retrieve_vector	Boolean	否	是否返回结果记录中的向量字段值，默认为False。
read_consistency	ReadConsistency	否	查询请求的一致性级别，取值为： EVENTUAL（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； STRONG：强一致性，查询请求只会发送给分片主副本。

BatchQueryKey 参数

参数	参数类型	是否必选	参数含义
primary_key	Json	是	目标记录的主键
partition_key	Json	否	目标记录的分区键值。如该表的分区键和主键是同一个键，则不需要填写分区键值。

标量过滤查询

功能介绍

基于标量属性过滤查询记录。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.enum import ReadConsistency

account = 'root'
api_key = 'your_api_key'
endpoint = 'you_endpoint' #example http://127.0.0.1:8511

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")

projections = ["id", "bookName"]
marker = {'id': 50}
filter = 'id < 100'
table.select(filter=filter, marker=marker, projections=projections, read_consistency=ReadConsistency.EVENTUAL, limit=10)

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
filter	String	否	检索的标量过滤条件，表示仅在符合过滤条件的候选集中进行检索，默认为空。Filter表达式语法参照SQL的WHERE子句语法进行设计，其详细描述和使用示例请参见Filter条件表达式。
marker	Json	否	查询的分页起始点，用于控制分页查询返回结果的起始位置，方便用户对数据进行分页展示和浏览，用户不填时，默认从第一条符合条件的记录开始返回。
projections	List<String>	否	投影字段列表，默认为空，为空时查询结果默认返回所有标量字段。
read_consistency	String	否	查询请求的一致性级别，取值为： EVENTUAL（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； STRONG：强一致性，查询请求只会发送给分片主副本。
limit	Int	否	查询返回的记录条数，在进行分页查询时，即每页的记录条数。默认为10，取值范围[1, 1000]。

向量TopK检索

功能介绍

基于向量字段值的KNN或ANN TopK检索操作，支持通过标量字段值进行过滤。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import VectorTopkSearchRequest, FloatVector, VectorSearchConfig

account = 'root'
api_key = 'your_api_key'
endpoint = 'you_endpoint' #example http://127.0.0.1:8511

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")
request = VectorTopkSearchRequest(vector_field="vector", vector=FloatVector([0.3123, 0.43, 0.213]), 
     limit=10, filter="bookName='三国演义'", config=VectorSearchConfig(ef=200))
res = table.vector_search(request=request)
client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
request	VectorTopkSearchRequest	是	检索请求参数描述信息。
partition_key	Json	否	目标记录的分区键值，如果该表的分区键和主键是同一个键，则不需要填写分区键值。需要注意的是，如果没有指定分区键值，那么该检索请求可能会退化为在该表所有分片上都执行的MPP检索。
projections	List<String>	否	投影字段列表，默认为空，为空时检索结果返回所有标量字段。
read_consistency	ReadConsistency	否	检索请求的一致性级别，取值为： EVENTUAL（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； STRONG：强一致性，查询请求只会发送给分片主副本。

VectorTopkSearchRequest参数

参数	参数类型	是否必选	参数含义
vector_field	String	是	检索的指定向量字段名称。
vector	FloatVector	是	检索的目标向量字段值。
limit	Int	否	返回最接近目标向量的向量记录数量，相当于TopK的K值，默认为50。
filter	String	否	检索的标量过滤条件，表示仅在符合过滤条件的候选集中进行检索，默认为空。Filter表达式语法参照SQL的WHERE子句语法进行设计，其详细描述和使用示例请参见Filter条件表达式。
config	VectorSearchConfig	否	向量检索算法的运行参数

VectorSearchConfig参数

参数	参数类型	是否必选	适用算法	参数含义
ef	Int	否	HNSW、HNSWPQ	检索过程的动态候选列表的大小。
pruning	Boolean	否	HNSW、HNSWPQ	检索过程中是否开启剪枝优化。
search_coarse_count	Int	否	PUCK	粗聚类中心候选集大小。
nprobe	Int	否	IVF、IVFSQ	聚类中心候选集大小。
w	Int	否	DISKANN	检索过程的候选节点宽度。
search_l	Int	否	DISKANN	检索过程中搜索堆的最大候选集合大小。

向量范围检索

功能介绍

基于向量字段值的KNN或ANN范围检索操作，支持通过标量字段值进行过滤。向量范围检索当前支持 HNSW、HNSWPQ，不支持 PUCK。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import VectorRangeSearchRequest, FloatVector, VectorSearchConfig

account = 'root'
api_key = 'your_api_key'
endpoint = 'you_endpoint' #example http://127.0.0.1:8511

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")
request = VectorRangeSearchRequest(vector_field="vector", vector=FloatVector([0.3123, 0.43, 0.213]),
             distance_range=(0, 20), limit=10, filter="bookName='三国演义'", config=VectorSearchConfig(ef=200))
res = table.vector_search(request=request)
client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
request	VectorRangeSearchRequest	是	检索请求参数描述信息。
partition_key	Json	否	目标记录的分区键值，如果该表的分区键和主键是同一个键，则不需要填写分区键值。需要注意的是，如果没有指定分区键值，那么该检索请求可能会退化为在该表所有分片上都执行的MPP检索。
projections	List<String>	否	投影字段列表，默认为空，为空时检索结果返回所有标量字段。
read_consistency	ReadConsistency	否	检索请求的一致性级别，取值为： EVENTUAL（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； STRONG：强一致性，查询请求只会发送给分片主副本。

VectorRangeSearchRequest参数

参数	参数类型	是否必选	参数含义
vector_field	String	是	检索的指定向量字段名称。
vector	FloatVector	是	检索的目标向量字段值。
distance_range	Tuple[Float, Float]	是	范围检索场景中的最近距离与最远距离，最近距离在前，取值约束如下: 任意距离算法下，distanceFar都必须大于等于distanceNear，不支持小于；当索引距离为L2时，distanceFar和distanceNear仅支持正数；当索引距离为COSINE时，distanceFar和distanceNear的取值范围为[-1.0, 1.0]； distanceFar与distanceNear需要成对出现。
limit	int	否	返回最接近目标向量的向量记录数量，相当于TopK的K值，默认为50。
filter	String	否	检索的标量过滤条件，表示仅在符合过滤条件的候选集中进行检索，默认为空。Filter表达式语法参照SQL的WHERE子句语法进行设计，其详细描述和使用示例请参见Filter条件表达式。
config	VectorSearchConfig	否	向量检索算法的运行参数

VectorSearchConfig参数

参数	参数类型	是否必选	适用算法	参数含义
ef	Int	否	HNSW、HNSWPQ	检索过程的动态候选列表的大小。
pruning	Boolean	否	HNSW、HNSWPQ	检索过程中是否开启剪枝优化。
search_coarse_count	Int	否	PUCK	粗聚类中心候选集大小。
nprobe	Int	否	IVF、IVFSQ	聚类中心候选集大小。
w	Int	否	DISKANN	检索过程的候选节点宽度。
search_l	Int	否	DISKANN	检索过程中搜索堆的最大候选集合大小。

批量向量检索

功能介绍

基于多个向量字段值的KNN或ANN检索操作，支持通过标量字段值进行过滤。仅适用于多节点标准版，不支持单节点免费测试版。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import VectorBatchSearchRequest, FloatVector, VectorSearchConfig

account ='root'
api_key ='$您的账户API密钥'
endpoint ='$您的实例访问端点'# 例如：'http://127.0.0.1:5287'

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")
request = VectorBatchSearchRequest(vector_field="vector",
                                   vectors=[FloatVector([1, 0.21, 0.213, 0]),
                                            FloatVector([1, 0.32, 0.513, 0])],
                                   limit=10, filter="bookName='三国演义'",
                                   config=VectorSearchConfig(ef=200))
res = table.vector_search(request=request)

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
request	VectorBatchSearchRequest	是	检索请求参数描述信息。
partition_key	Json	否	目标记录的分区键值，如果该表的分区键和主键是同一个键，则不需要填写分区键值。需要注意的是，如果没有指定分区键值，那么该检索请求可能会退化为在该表所有分片上都执行的MPP检索。
projections	List<String>	否	投影字段列表，默认为空，为空时检索结果返回所有标量字段。
read_consistency	ReadConsistency	否	检索请求的一致性级别，取值为： EVENTUAL（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； STRONG：强一致性，查询请求只会发送给分片主副本。

VectorBatchSearchRequest参数

参数	参数类型	是否必选	参数含义
vector_field	String	是	检索的指定向量字段名称。
vectors	List<FloatVector>	是	检索的目标向量字段值。
limit	Int	否	返回最接近目标向量的向量记录数量，相当于TopK的K值，默认为50。
distance_range	Tuple[Float, Float]	否	范围检索场景中的最近距离与最远距离，最近距离在前，取值约束如下: 任意距离算法下，distanceFar都必须大于等于distanceNear，不支持小于；当索引距离为L2时，distanceFar和distanceNear仅支持正数；当索引距离为COSINE时，distanceFar和distanceNear的取值范围为[-1.0, 1.0]； distanceFar与distanceNear需要成对出现。
filter	String	否	检索的标量过滤条件，表示仅在符合过滤条件的候选集中进行检索，默认为空。Filter表达式语法参照SQL的WHERE子句语法进行设计，其详细描述和使用示例请参见Filter条件表达式。
config	VectorSearchConfig	否	向量检索算法的运行参数

VectorSearchConfig参数

参数	参数类型	是否必选	适用算法	参数含义
ef	Int	否	HNSW、HNSWPQ	检索过程的动态候选列表的大小。
pruning	Boolean	否	HNSW、HNSWPQ	检索过程中是否开启剪枝优化。
search_coarse_count	Int	否	PUCK	粗聚类中心候选集大小。
nprobe	Int	否	IVF、IVFSQ	聚类中心候选集大小。
w	Int	否	DISKANN	检索过程的候选节点宽度。
search_l	Int	否	DISKANN	检索过程中搜索堆的最大候选集合大小。

全文检索

功能介绍

基于关键字的全文检索，支持通过标量字段值进行过滤。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import BM25SearchRequest

account = 'root'
api_key = 'your_api_key'
endpoint = 'you_endpoint' #example http://127.0.0.1:8511

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")
request = BM25SearchRequest(index_name="book_segment_inverted_idx",
                             search_text="吕布", 
                             limit=10,
                             filter="bookName='三国演义'")
res = table.bm25_search(request=request)
logger.debug("res: {}".format(res))
client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
request	BM25SearchRequest	是	全文检索的详细参数。
partition_key	Json	否	目标记录的分区键值，如果该表的分区键和主键是同一个键，则不需要填写分区键值。需要注意的是，如果没有指定分区键值，那么该检索请求可能会退化为在该表所有分片上都执行的MPP检索。
projections	List<String>	否	投影字段列表，默认为空，为空时检索结果返回所有标量字段。
read_consistency	ReadConsistency	否	检索请求的一致性级别，取值为： EVENTUAL（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； STRONG：强一致性，查询请求只会发送给分片主副本。

BM25SearchRequest参数

参数	参数类型	是否必选	参数含义
index_name	String	是	倒排索引的名字。
searchText	String	是	全文检索的检索表达式（UTF-8编码）。几种常见用法: `content:数据库`：在content这列搜索"数据库"关键字 `content:百度VectorDB数据库`：在content这列匹配"百度VectorDB数据库"中任意关键字 `content:"百度VectorDB数据库"`：搜索短语"百度VectorDB数据库" `content:百度 AND content:VectorDB`：在content列同时匹配"百度"、"VectorDB" 关键字 `content:百度 OR content:VectorDB`：在content列匹配"百度"、"VectorDB"的任意一个更多用法见全文检索表达式
limit	int	否	指定返回相关性最高的条目数。
filter	String	否	检索的标量过滤条件，表示仅在符合过滤条件的候选集中进行检索，默认为空。Filter表达式语法参照SQL的WHERE子句语法进行设计，其详细描述和使用示例请参见Filter条件表达式。

全文检索表达式

检索类型	用法	例子	例子含义	备注
关键词检索	`field_name:keyword` `field_name:(keyword_1, keyword_2)`	`title:数据库` `title:(数据库百度)`	在title这列搜索“数据库”关键字在title这列搜索“数据库”、"百度"关键字，满足任意一个即可
关键词检索	`keyword` `keyword_1 AND keyword_2`	`数据库` `数据库 AND 百度`	在content 这列上搜索"数据库"关键字在content 这列上搜索，要求同时包括"数据库"、"百度" 关键字	只适用于在单列上建立倒排索引的情况。对于多列倒排索引，必须使用上述 `field_name:keyword` 的方式指定检索词。
复合检索: AND/OR	`query_1 AND query_2` `query_1 OR query_2` `(query_1 OR query_2) AND query_3`	`title:数据库 AND title:百度` `title:数据库 OR title:百度` `(title:数据库 OR title:百度) AND content:VectorDB`	在title这列搜索, 要求同时包括"数据库"、"百度" 这2个关键字在title这列搜索, 要求包括"数据库"、"百度" 任意一个在title这列搜索, 要求包括"数据库"、"百度" 任意一个，同时content列包含"VectorDB"关键字
Phrase检索	`field_name:"phrase"`	`title:"百度VectorDB数据库"`	在title这里搜索"百度VectorDB数据库"短语	短语必须使用双引号
Match检索	`field_name:statement`	`content:百度VectorDB的优缺点`	在content这列搜索"百度VectorDB的优缺点"的任意词，匹配词数量越多，相关性得分越高
Prefix检索	`field_name:keyword*`	`title:数据*`	在title这列检索，包含以"数据"为前缀词的文档
更改查询权重	`field_name:keyword^boost`	`title:数据库^2 OR content:百度`	title包括"数据库"关键字，或content包含“百度”关键字，最后计算相关性得分是，title列匹配的文档权重系数为2， content 列匹配的权重系数为1	不设置boost的话，默认权重都是1

全文检索表达式会将一些特殊字符用于专用目的，如想在表达式中匹配一些特殊字符，需要用 \ 符号进行转义。当前被征用特殊字符包括:

+ - && || ! ( ) { } [ ] ^ " ~ * ? : `

以 百度自研的向量数据库:VectorDB 这个表达式为例，表达式解释器会认为在"百度自研的向量数据库" 这列上搜索 VectorDB，这就违背了使用者的初衷，为此需把表达式写成 百度自研的向量数据库\\:VectorDB。

混合检索

功能介绍

同时进行关键字全文检索和向量检索，检索结果融合排序后返回，也支持通过标量属性进行过滤。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import VectorTopkSearchRequest, BM25SearchRequest, FloatVector, VectorSearchConfig, HybridSearchRequest

account = 'root'
api_key = 'your_api_key'
endpoint = 'you_endpoint' #example http://127.0.0.1:8511

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")

bm25_request = BM25SearchRequest(index_name="book_segment_inverted_idx",
                                 search_text="吕布")
vector_request = VectorTopkSearchRequest(vector_field="vector", vector=FloatVector[0.3123, 0.43, 0.213], 
                                         limit=10, filter=None, config=VectorSearchConfig(ef=200)) 

hybrid_search_request = HybridSearchRequest(vector_request=vector_request,
                                    bm25_request=bm25_request,
                                    vector_weight=0.5, 
                                    bm25_weight=0.5,
                                    limit=10,
                                    filter="bookName='三国演义'")
res = table.hybrid_serch(request=hybrid_search_request)                             
logger.debug("res: {}".format(res))
client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
request	HybridSearchRequest	是	混合检索的详细参数。
partition_key	Json	否	目标记录的分区键值，如果该表的分区键和主键是同一个键，则不需要填写分区键值。需要注意的是，如果没有指定分区键值，那么该检索请求可能会退化为在该表所有分片上都执行的MPP检索。
projections	List<String>	否	投影字段列表，默认为空，为空时检索结果返回所有标量字段。
read_consistency	ReadConsistency	否	检索请求的一致性级别，取值为： EVENTUAL（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； STRONG：强一致性，查询请求只会发送给分片主副本。

HybridSearchRequest参数

参数	参数类型	是否必选	参数含义
vector_request	VectorTopkSearchRequest 或 VectorRangeSearchRequest 或 VectorBatchSearchRequest	是	向量检索的详细参数
bm25_request	BM25SearchRequest	是	全文检索的详细参数
vector_weight	Float	否	向量检索结果在混合检索中所占权重，默认0.5
bm25_weight	Float	否	全文检索结果在混合检索中所占比重，默认0.5
limit	Int	否	返回的最相关条目数
filter	String	否	检索的标量过滤条件，表示仅在符合过滤条件的候选集中进行检索，默认为空。Filter表达式语法参照SQL的WHERE子句语法进行设计，其详细描述和使用示例请参见Filter条件表达式。

SearchIterator

功能介绍

SearchIterator 提供了一种分页获取搜索结果的机制。在 SearchIterator 请求中，limit参数用于指定当前分页的返回结果数量。通过多次调用迭代器，可以突破单次检索的 topK 数量限制，逐步获取完整的结果集。对于 topK 值较大的搜索请求，推荐使用 SearchIterator 来实现结果的分批次获取。

请求示例

                Python
                
            

                import pymochow
from pymochow.configuration import Configuration
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.model.table import VectorTopkSearchRequest, FloatVector, VectorSearchConfig

account = 'root'
api_key = 'your_api_key'
endpoint = 'you_endpoint' #example http://127.0.0.1:8511

config = Configuration(credentials=BceCredentials(account, api_key),
            endpoint=endpoint)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")

request = VectorTopkSearchRequest(
            vector_field="vector", 
            vector=FloatVector([1, 0.21, 0.213, 0]), 
            limit=1000, 
            config=VectorSearchConfig(ef=2000))

iterator = table.search_iterator(request=request, batch_size=1000, total_size=10000) # 初始化 SearchIterator

while True:
    rows = iterator1.next() # 获取下一批检索结果
    if not rows:
        break
    logger.debug("rows:{}".format(rows))

iterator1.close() # 释放 iterator

client.close()
            

接口描述

`Table.search_iterator`

功能：初始化 SearchIterator 对象。

参数：

参数名	参数类型	是否必选	参数含义
request	`VectorTopkSearchRequest` 或 `MultiVectorSearchRequest`	是	检索请求参数描述信息。
batch_size	Int	是	每批次检索获取记录条数
total_size	Int	是	获取记录总条数
partition_key	Json	否	目标记录的分区键值，如果该表的分区键和主键是同一个键，则不需要填写分区键值。需要注意的是，如果没有指定分区键值，那么该检索请求可能会退化为在该表所有分片上都执行的MPP检索。
projections	List<String>	否	投影字段列表，默认为空，为空时检索结果返回所有标量字段。
read_consistency	ReadConsistency	否	检索请求的一致性级别，取值为： `EVENTUAL`（默认值）：最终一致性，查询请求会随机发送给分片的所有副本； `STRONG`：强一致性，查询请求只会发送给分片主副本。

返回类型：SearchIterator。

`SearchIterator.next`

功能：执行检索，并返回检索结果。当返回结果为空，说明 SearchIterator 执行结束。
参数：无。
返回类型：List<Row>。

`SearchIterator.close`

功能：释放 SearchIterator。执行 close 后，不应该再调用 next。
参数：无。
返回类型：无。

限制

仅支持 HNSW、HNSWPQ 索引类型。
仅支持向量TopK检索（VectorTopkSearch）、多向量检索（MultiVectorSearch），不支持向量范围检索（VectorRangeSearch）、批量向量检索（VectorBatchSearch）、全文检索（BM25Search）、混合检索（HybridSearch）。
对于 MultiVectorSearch，仅支持 ws融合排序算法。

Table 操作

Index 操作

向量数据库 VectorDB

Row 操作

插入记录

功能介绍

请求示例

请求参数

插入或更新记录

功能介绍

请求示例

请求参数

更新记录

功能介绍

请求示例

请求参数

删除记录

功能介绍

请求示例

请求参数

标量查询

功能介绍

请求示例

请求参数

批量标量查询

功能介绍

请求示例

请求参数

标量过滤查询

功能介绍

请求示例

请求参数

向量TopK检索

功能介绍

请求示例

请求参数

向量范围检索

功能介绍

请求示例

请求参数

批量向量检索

功能介绍

请求示例

请求参数

全文检索

功能介绍

请求示例

请求参数

混合检索

功能介绍

请求示例

请求参数

SearchIterator

功能介绍

请求示例

接口描述

Table.search_iterator

SearchIterator.next

SearchIterator.close

限制

`Table.search_iterator`

`SearchIterator.next`

`SearchIterator.close`