Optional
includeIf true, include the similarity score in the result via the $similarity
field.
Optional
maxThis temporary error-ing property exists for migration convenience, and will be removed in a future version.
maxTimeMS
option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using timeout
, and defaults in timeoutDefaults
. You may generally Ctrl+R replace maxTimeMS
with timeout
to retain the same behavior.Optional
projectionThe projection to apply to the returned records, to specify only a select set of fields to return.
If using a projection, it is heavily recommended to provide a custom type for the returned records as a generic typeparam to the find
method.
Optional
sortThe order in which to apply the update if the filter selects multiple records.
Defaults to null
, where the order is not guaranteed.
Optional
timeoutThe method timeout override.
See TimeoutDescriptor for much more information.
Optional
vectorThis temporary error-ing property exists for migration convenience, and will be removed in a future version.
sort: { $vector: [...] }
instead.Optional
vectorizeThis temporary error-ing property exists for migration convenience, and will be removed in a future version.
sort: { $vectorize: '...' }
instead.
Represents the options for some generic
findOne
command.Field
sort - The sort order to pick which document to return if the filter selects multiple documents.
Field
projection - Specifies which fields should be included/excluded in the returned documents.
Field
includeSimilarity - If true, include the similarity score in the result via the
$similarity
field.Field
timeout - The timeout override for this method