Interface CreateIndexesOptions

Hierarchy

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实例返回。

Default Value

false

bucketSize?: number
checkKeys?: boolean

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

Default Value

false

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. Defaults to true.在反序列化BSON文档时启用utf8验证。默认为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.允许指定我们希望返回哪些字段作为未序列化的原始缓冲区。

Default Value

null

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 note that the driver sets this to falseserialize不会发出未定义的字段请注意,驱动程序将其设置为false

Default Value

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时,它将作为nodejs Buffer实例返回。

Default Value

false

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits.当反序列化Long时,如果它小于53位,则将其放入Number中。

Default Value

true

promoteValues?: boolean

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

Default Value

true

raw?: boolean

Enabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API.启用raw选项将返回使用allocUnsafe API分配的Node.js缓冲区 See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context.请参阅Node.js文档中的这一部分,了解有关“不安全”在本文中所指内容的更多详细信息。 If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:如果您需要维护自己的可编辑字节克隆,以延长进程的使用寿命,建议您分配自己的缓冲区并克隆内容:

Example

const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point

Remarks

Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.请注意,有一个已知的限制,即此选项不能在MongoClient级别使用(请参阅NODE-3946)。它在Db、Collection和每个操作中都能正常工作,与其他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序列化javascript函数

Default Value

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.创建唯一索引。

useBigInt64?: boolean

when deserializing a Long return as a BigInt.当将Long返回反序列化为BigInt时。

Default Value

false

version?: number

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

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

Generated using TypeDoc