Interface ClientUpdateOneModel<TSchema>

interface ClientUpdateOneModel<TSchema> {
    arrayFilters?: Document[];
    collation?: CollationOptions;
    filter: Filter<TSchema>;
    hint?: Hint;
    name: "updateOne";
    namespace: string;
    update: Document[] | UpdateFilter<TSchema>;
    upsert?: boolean;
}

Type Parameters

  • TSchema

Hierarchy (view full)

Properties

arrayFilters? collation? filter hint? name namespace update upsert?

Properties

OptionalarrayFilters

arrayFilters?: Document[]

A set of filters specifying to which array elements an update should apply.

Optionalcollation

collation?: CollationOptions

Specifies a collation.

filter

filter: Filter<TSchema>

The filter used to determine if a document should be updated. For an updateOne operation, the first match is updated.

Optionalhint

hint?: Hint

The index to use. If specified, then the query system will only consider plans using the hinted index.

name

name: "updateOne"

namespace

namespace: string

The namespace for the write.

A namespace is a combination of the database name and the name of the collection: <database-name>.<collection>. All documents belong to a namespace.

See

https://www.mongodb.com/docs/manual/reference/limits/#std-label-faq-dev-namespace

update

update: Document[] | UpdateFilter<TSchema>

The modifications to apply. The value can be either: UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

Optionalupsert

upsert?: boolean

When true, creates a new document if no document matches the query.

Settings

Member Visibility

On This Page

Properties