模块:集合

收集工厂。
混合:

方法


添加(expr)

创建一个操作,将一个或多个文档添加到集合。
参数:
的名字 类型 描述
expr DocumentOrJSON|数组。<DocumentOrJSON> 带有文档数据的对象
抛出:
当输入类型无效时。
类型
错误
返回:
操作实例。
类型
模块:CollectionAdd
例子
//参数作为单个文档集合。添加({foo: 'baz'}, {bar: 'qux'}) //文档集合的数组。添加([{foo: 'baz'}, {bar: 'qux'}])

addOrReplaceOne (id、数据)

使用给定的id创建或替换文档。
参数:
的名字 类型 描述
id 字符串 文档id
数据 对象 文档属性
返回:
解决操作结果的承诺。
类型
承诺。<模块:结果>
例子
收集。addOrReplaceOne('foo', {prop1: 'bar', prop2: 'baz'})

count ()

检索集合中文档的总数。
返回:
类型
承诺。<数字>

方法createIndex(名称、约束)

创建一个新索引。
参数:
的名字 类型 描述
的名字 字符串 索引名称
约束 IndexDefinition 索引定义
返回:
类型
承诺。布尔> <

dropIndex(名字)

在给定名称的集合上删除索引。
参数:
的名字 类型 描述
的名字 字符串 索引名称
返回:
类型
承诺。布尔> <

existsInDatabase ()

检查数据库中是否存在此集合。
返回:
类型
承诺。布尔> <

找到(expr)

创建一个操作来查找集合中的文档。
参数:
的名字 类型 描述
expr SearchConditionStr 过滤条件
返回:
操作实例。
类型
模块:CollectionFind

getName ()

检索集合名称。
返回:
类型
字符串

getOne (id)

检索具有给定id的单个文档。
参数:
的名字 类型 描述
id 字符串 文档id
返回:
文档实例。
类型
对象
例子
collection.getOne (' 1 ')

getSchema ()

检索与集合关联的模式。
返回:
类型
模块:模式

检查()

检索集合元数据。
返回:
包含相关元数据的对象。
类型
对象

修改(expr)

创建一个操作来修改集合中的文档。
参数:
的名字 类型 描述
expr SearchConditionStr 过滤条件
返回:
操作实例。
类型
模块:CollectionModify
例子
//更新集合collection.modify('true')中的所有文档。集(“名字”、“酒吧”)// update documents that match a given condition collection.modify('name = "foo"').set('name', 'bar')

删除(expr)

创建从集合中删除文档的操作。
参数:
的名字 类型 描述
expr SearchConditionStr 过滤条件
返回:
操作实例。
类型
模块:CollectionRemove
例子
remove('true') //删除与给定条件集合匹配的文档。remove (name =“foobar”)

removeOne (id)

删除具有给定id的单个文档。
参数:
的名字 类型 描述
id 字符串 文档id
返回:
解决操作结果的承诺。
类型
承诺。<模块:结果>
例子
collection.removeOne (' 1 ')

replaceOne (id、数据)

用给定的id替换整个文档。
参数:
的名字 类型 描述
id 字符串 文档id
数据 对象 文档属性
返回:
解决操作结果的承诺。
类型
承诺。<模块:结果>
例子
收集。replaceOne('foo', {prop1: 'bar', prop2: 'baz'})

类型定义


FieldDefinition

索引字段定义。
类型:
  • 对象
属性:
的名字 类型 论点 默认的 描述
字符串 文件路径
类型 字符串 索引类型(参见示例)
要求 布尔 <可选>
允许(或不)列的“null”值
选项 数量 <可选>
描述如何处理包含坐标维度大于2的几何图形的GeoJSON文档
srid 数量 <可选>
用于明确识别投影、非投影和局部空间坐标系统定义的唯一值。
例子
INT[无符号]TINYINT[无符号]SMALLINT[无符号]MEDIUMINT[无符号]INTEGER[无符号]BIGINT[无符号]REAL[无符号]FLOAT[无符号]DOUBLE[无符号]DECIMAL[无符号]NUMERIC[无符号]DATETIME TIMESTAMP DATETIME TEXT[(长度)]GEOJSON(额外选项:options, srid)

IndexDefinition

整体指数的定义。
类型:
  • 对象
属性:
的名字 类型 论点 默认的 描述
类型 字符串 <可选>
指数 索引类型(index或SPATIAL)。
字段 数组。< FieldDefinition > 索引字段定义