接口定义
count() 用于查询集合中的文档数量。
def count(database_name: str,collection_name: str,filter: Filter | str = None,timeout: float = None) -> int
使用示例
说明：
支持根据主键 id（Document ID），搭配自定义的标量字段的 Filter 表达式一并查询数据。
支持指定查询起始位置 offset 和返回数量 limit，精确检索查询区间内的数据，实现数据 SCAN 能力。
import tcvectordbfrom tcvectordb.model.document import Filterdoc_count = client.count(database_name='db-test',collection_name='book-vector',filter='bookName=\\"三国演义\\"')print(doc_count)
入参描述
参数 | 是否必选 | 参数含义 | 参数配置 |
database_name | 是 | 指定检索的数据库名。 | Database 命名要求如下： 只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。 长度要求：[1,128]。 |
collection_name | 是 | 指定检索的集合名。 | Collection 命名要求如下： 只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。 长度要求：[1,128]。 |
filter | 否 | 使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。 | Filter 的表达式格式为 '<field_name><operator><value>'，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 条件表达式。其中 <field_name>：表示要过滤的字段名。 <operator>：表示要使用的运算符。 string：匹配单个字符串值（=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。 uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）、不等于（!=）。例如，expired _time > 1623388524。 array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。 json：json 类型的 Filter 表达式语法和 json 字段的键值类型保持一致。若访问 Json 对象中的键，使用点（.）符号连接。例如：Json 类型的字段 bookInfo ，其键 bookName 的 Filter 表达式如下所示。更多信息，请参见 Json 类型表达式。
<value>：表示要匹配的值。 |
出参描述
检索结果，如下所示。
3
参数名 | 参数含义 |
count | 集合中的文档数量。 |
