Preparing search index...
The search index is not available
mongodb
mongodb
SearchIndexDescription
Interface SearchIndexDescription
Hierarchy
SearchIndexDescription
Index
Properties
definition
name?
Properties
definition
definition
:
Document
The index definition.
Optional
name
name
?:
string
The name of the index.
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
definition
name
mongodb
BSONReg
Exp
BSONSymbol
BSONType
Binary
Code
DBRef
Decimal128
Document
Double
Int32
Long
Max
Key
Min
Key
Object
Id
Timestamp
UUID
deserialize
serialize
BSON
Abstract
Cursor
Admin
Aggregation
Cursor
Batch
Bulk
Operation
Base
Bulk
Write
Result
Cancellation
Token
Change
Stream
Client
Encryption
Client
Session
Collection
Command
Failed
Event
Command
Started
Event
Command
Succeeded
Event
Connection
Check
Out
Failed
Event
Connection
Check
Out
Started
Event
Connection
Checked
In
Event
Connection
Checked
Out
Event
Connection
Closed
Event
Connection
Created
Event
Connection
Pool
Cleared
Event
Connection
Pool
Closed
Event
Connection
Pool
Created
Event
Connection
Pool
Monitoring
Event
Connection
Pool
Ready
Event
Connection
Ready
Event
Db
Find
Cursor
Find
Operators
GridFSBucket
GridFSBucket
Read
Stream
GridFSBucket
Write
Stream
Host
Address
List
Collections
Cursor
List
Indexes
Cursor
List
Search
Indexes
Cursor
MongoAPIError
MongoAWSError
Mongo
Azure
Error
Mongo
Batch
Re
Execution
Error
Mongo
Bulk
Write
Error
Mongo
Change
Stream
Error
Mongo
Client
Mongo
Compatibility
Error
Mongo
Credentials
Mongo
Crypt
AzureKMSRequest
Error
Mongo
Crypt
Create
Data
Key
Error
Mongo
Crypt
Create
Encrypted
Collection
Error
Mongo
Crypt
Error
Mongo
Crypt
Invalid
Argument
Error
Mongo
CryptKMSRequest
Network
Timeout
Error
Mongo
Cursor
Exhausted
Error
Mongo
Cursor
In
Use
Error
MongoDBCollection
Namespace
MongoDBNamespace
Mongo
Decompression
Error
Mongo
Driver
Error
Mongo
Error
Mongo
Expired
Session
Error
Mongo
GridFSChunk
Error
Mongo
GridFSStream
Error
Mongo
Invalid
Argument
Error
Mongo
Kerberos
Error
Mongo
Missing
Credentials
Error
Mongo
Missing
Dependency
Error
Mongo
Network
Error
Mongo
Network
Timeout
Error
Mongo
Not
Connected
Error
Mongo
Parse
Error
Mongo
Runtime
Error
Mongo
Server
Closed
Error
Mongo
Server
Error
Mongo
Server
Selection
Error
Mongo
System
Error
Mongo
Tailable
Cursor
Error
Mongo
Topology
Closed
Error
Mongo
Transaction
Error
Mongo
Unexpected
Server
Response
Error
Mongo
Write
Concern
Error
Ordered
Bulk
Operation
Read
Concern
Read
Preference
Run
Command
Cursor
Server
Capabilities
Server
Closed
Event
Server
Description
Server
Description
Changed
Event
Server
Heartbeat
Failed
Event
Server
Heartbeat
Started
Event
Server
Heartbeat
Succeeded
Event
Server
Opening
Event
Server
Session
Stream
Description
Topology
Closed
Event
Topology
Description
Topology
Description
Changed
Event
Topology
Opening
Event
Transaction
Typed
Event
Emitter
Unordered
Bulk
Operation
Write
Concern
Write
Concern
Error
Write
Error
AWSEncryption
Key
Options
Abstract
Cursor
Options
Aggregate
Options
Aggregation
Cursor
Options
Auth
Auth
Mechanism
Properties
Auto
Encryption
Options
Azure
Encryption
Key
Options
BSONSerialize
Options
Bulk
Write
Operation
Error
Bulk
Write
Options
Change
Stream
Coll
Mod
Document
Change
Stream
Create
Document
Change
Stream
Create
Index
Document
Change
Stream
Delete
Document
Change
Stream
Document
CollectionUUID
Change
Stream
Document
Common
Change
Stream
Document
Key
Change
Stream
Document
Operation
Description
Change
Stream
Drop
Database
Document
Change
Stream
Drop
Document
Change
Stream
Drop
Index
Document
Change
Stream
Insert
Document
Change
Stream
Invalidate
Document
Change
Stream
Name
Space
Change
Stream
Options
Change
Stream
Refine
Collection
Shard
Key
Document
Change
Stream
Rename
Document
Change
Stream
Replace
Document
Change
Stream
Reshard
Collection
Document
Change
Stream
Shard
Collection
Document
Change
Stream
Split
Event
Change
Stream
Update
Document
Client
Encryption
Create
Data
Key
Provider
Options
Client
Encryption
Encrypt
Options
Client
Encryption
Options
Client
Encryption
Rewrap
Many
Data
Key
Provider
Options
Client
Encryption
Rewrap
Many
Data
Key
Result
Client
Metadata
Client
Metadata
Options
Client
Session
Options
Close
Options
Cluster
Time
Clustered
Collection
Options
Collation
Options
Collection
Info
Collection
Options
Command
Operation
Options
Connect
Options
Connection
Options
Connection
Pool
Options
Count
Documents
Options
Count
Options
Create
Collection
Options
Create
Indexes
Options
Cursor
Stream
Options
Data
Key
Db
Options
Db
Stats
Options
Delete
Many
Model
Delete
One
Model
Delete
Options
Delete
Result
Delete
Statement
Driver
Info
Drop
Collection
Options
End
Session
Options
Error
Description
Estimated
Document
Count
Options
Explain
Options
Filter
Operators
Find
One
And
Delete
Options
Find
One
And
Replace
Options
Find
One
And
Update
Options
Find
Options
GCPEncryption
Key
Options
GridFSBucket
Options
GridFSBucket
Read
Stream
Options
GridFSBucket
Read
Stream
Options
With
Revision
GridFSBucket
Write
Stream
Options
GridFSChunk
GridFSFile
Hedge
Options
IdPServer
Info
IdPServer
Response
Index
Description
Index
Information
Options
Insert
Many
Result
Insert
One
Model
Insert
One
Options
Insert
One
Result
KMSProviders
List
Collections
Options
List
Databases
Options
List
Databases
Result
List
Indexes
Options
Modify
Result
Mongo
Client
Options
Mongo
Credentials
Options
Mongo
Network
Error
Options
Mongo
Options
Monitor
Options
OIDCCallback
Context
Operation
Options
Pk
Factory
Proxy
Options
Range
Options
Read
Preference
From
Options
Read
Preference
Like
Options
Read
Preference
Options
Rename
Options
Replace
One
Model
Replace
Options
Resume
Options
Root
Filter
Operators
Search
Index
Description
Select
Server
Options
Server
Api
Stream
Description
Options
Time
Series
Collection
Options
Topology
Description
Options
Topology
Version
Transaction
Options
Update
Description
Update
Many
Model
Update
One
Model
Update
Options
Update
Result
Update
Statement
Validate
Collection
Options
Write
Concern
Error
Data
Write
Concern
Options
Write
Concern
Settings
Abstract
Cursor
Events
Accepted
Fields
Add
To
Set
Operators
Alternative
Type
Any
Bulk
Write
Operation
Any
Error
Array
Element
Array
Operator
Auth
Mechanism
Auto
Encryption
Extra
Options
Auto
Encryption
Logger
Level
BSONType
Alias
Batch
Type
Bitwise
Filter
CSFLEKMSTls
Options
Callback
Change
Stream
Document
Change
Stream
Events
Client
Encryption
Data
Key
Provider
Client
Encryption
Tls
Options
Client
Session
Events
Common
Events
Compressor
Compressor
Name
Condition
Connection
Events
Connection
Pool
Events
Cursor
Flag
Distinct
Options
Drop
Database
Options
Drop
Indexes
Options
Enhanced
Omit
Event
Emitter
With
State
Events
Description
Explain
Verbosity
Explain
Verbosity
Like
Filter
Filter
Operations
Flatten
GSSAPICanonicalization
Value
Generic
Listener
GridFSBucket
Events
Hint
Index
Direction
Index
Specification
Infer
Id
Type
Integer
Type
Is
Any
Join
Keys
OfAType
Keys
Of
Other
Type
List
Search
Indexes
Options
Match
Keys
And
Values
Mongo
Client
Events
Mongo
Error
Label
Monitor
Events
Nested
Paths
Nested
Paths
Of
Type
Non
Object
Id
Like
Document
Not
Accepted
Fields
Numeric
Type
OIDCRefresh
Function
OIDCRequest
Function
One
Or
More
Only
Fields
Of
Type
Operation
Time
Optional
Id
Optional
Unless
Required
Id
Profiling
Level
Profiling
Level
Options
Property
Type
Pull
All
Operator
Pull
Operator
Push
Operator
Read
Concern
Level
Read
Concern
Like
Read
Preference
Like
Read
Preference
Mode
Reg
Exp
Or
String
Remove
User
Options
Resume
Token
Return
Document
Run
Command
Options
Run
Cursor
Command
Options
Schema
Member
Server
Api
Version
Server
Events
Server
Monitoring
Mode
Server
Session
Id
Server
Type
Set
Fields
Set
Profiling
Level
Options
Sort
Sort
Direction
Stream
Strict
Filter
Strict
Match
Keys
And
Values
Strict
Update
Filter
Supported
Node
Connection
Options
Supported
Socket
Options
SupportedTLSConnection
Options
SupportedTLSSocket
Options
Tag
Set
Topology
Events
Topology
Type
Update
Filter
W
With
Id
With
Session
Callback
With
Transaction
Callback
Without
Id
Auth
Mechanism
Auto
Encryption
Logger
Level
Batch
Type
CURSOR_
FLAGS
Compressor
Explain
Verbosity
GSSAPICanonicalization
Value
LEGAL_
TCP_
SOCKET_
OPTIONS
LEGAL_
TLS_
SOCKET_
OPTIONS
MONGO_
CLIENT_
EVENTS
Mongo
Error
Label
Profiling
Level
Read
Concern
Level
Read
Preference
Mode
Return
Document
Server
Api
Version
Server
Monitoring
Mode
Server
Type
Topology
Type
Generated using
TypeDoc
The index definition.