Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateIndexesOptions

Hierarchy继承层级

Index索引

Properties属性

2dsphereIndexVersion?: number
authdb?: string
background?: boolean

Creates the index in the background, yielding whenever possible.在后台创建索引,尽可能生成索引。

bits?: number
bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.返回BSON正则表达式作为BSONRegExp实例。

bucketSize?: number
checkKeys?: boolean

the serializer will check if keys are valid.序列化程序将检查键是否有效。

collation?: CollationOptions

Collation排序规则

comment?: unknown

Comment to apply to the operation.要应用于操作的注释。

In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.在4.4之前的服务器版本中,“comment”必须是字符串。如果提供任何其他类型,将引发服务器错误。

In server versions 4.4 and above, 'comment' can be any valid BSON type.在4.4及以上版本的服务器中,“comment”可以是任何有效的BSON类型。

commitQuorum?: string | number

(MongoDB 4.4. or higher) Specifies how many data-bearing members of a replica set, including the primary, must complete the index builds successfully before the primary marks the indexes as ready. (MongoDB 4.4.或更高版本)指定在主副本集将索引标记为就绪之前,副本集(包括主副本集)必须有多少个数据承载成员成功完成索引构建。This option accepts the same values for the "w" field in a write concern plus "votingMembers", which indicates all voting data-bearing nodes.此选项接受写入关注点中“w”字段的相同值加上“votingMembers”,表示所有投票数据承载节点。

dbName?: string
default_language?: string
enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. 反序列化BSON文档时启用utf8验证。Defaults to true.默认为true

expireAfterSeconds?: number

Allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)允许您使应用于数据的索引的数据过期(MongoDB 2.2或更高版本)

Specifies the verbosity mode for the explain output.指定解释输出的详细模式。

fieldsAsRaw?: Document

allow to specify if there what fields we wish to return as unserialized raw buffer.允许指定是否存在我们希望作为非序列化原始缓冲区返回的字段。

fullResponse?: boolean
deprecated

This option does nothing

hidden?: boolean

Specifies that the index should exist on the target collection but should not be used by the query planner when executing operations. 指定索引应存在于目标集合上,但查询规划器在执行操作时不应使用该索引。(MongoDB 4.4 or higher)(MongoDB 4.4或更高版本)

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)序列化不会发出未定义的字段(默认值:true

language_override?: string
max?: number

For geospatial indexes set the high bound for the co-ordinates.对于地理空间索引,设置坐标的上限。

maxTimeMS?: number
min?: number

For geospatial indexes set the lower bound for the co-ordinates.对于地理空间索引,设置坐标的下限。

name?: string

Override the autogenerated index name (useful if the resulting name is larger than 128 bytes)覆盖自动生成的索引名称(如果结果名称大于128字节,则很有用)

noResponse?: boolean
omitReadPreference?: boolean
partialFilterExpression?: Document

Creates a partial index based on the given filter object (MongoDB 3.2 or higher)基于给定的筛选器对象创建部分索引(MongoDB 3.2或更高版本)

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.当反序列化Binary时,它将作为node.js Buffer实例返回。

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits当反序列化Long时,如果Long小于53位,它将适合Number

promoteValues?: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.当反序列化将把BSON值提升到它们的Nodej最接近的等效类型时。

raw?: boolean

Return BSON filled buffers from operations从操作返回BSON填充的缓冲区

readConcern?: ReadConcernLike

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)指定集合的读取关注点和级别。(仅支持MongoDB 3.2或更高版本)

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).首选的读取首选项(ReadPreference.primaryReadPreference.primary_preferredReadPreference.secondaryReadPreference.secondary_preferredReadPreference.nearest)。

retryWrites?: boolean

Should retry failed writes应重试失败的写入

serializeFunctions?: boolean

serialize the javascript functions (default:false).序列化javascript函数(默认值:false)。

session?: ClientSession

Specify ClientSession for this command为此命令指定ClientSession

sparse?: boolean

Creates a sparse index.创建稀疏索引。

storageEngine?: Document

Allows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)允许用户在创建索引时按索引配置存储引擎。(MongoDB 3.0或更高版本)

textIndexVersion?: number
unique?: boolean

Creates an unique index.创建唯一索引。

version?: number

Specifies the index version number, either 0 or 1.指定索引版本号,0或1。

weights?: Document
wildcardProjection?: Document
willRetryWrite?: boolean

Write Concern as an object将关注点写为对象

Generated using TypeDoc