Package com.mongodb.client.model.bulk

Interface ClientNamespacedWriteModel

All Known Subinterfaces:

ClientNamespacedDeleteManyModel, ClientNamespacedDeleteOneModel, ClientNamespacedInsertOneModel, ClientNamespacedReplaceOneModel, ClientNamespacedUpdateManyModel, ClientNamespacedUpdateOneModel

@Sealed
public interface ClientNamespacedWriteModel

A combination of an individual write operation and a namespace the operation is targeted at.

Since:

5.3

Method Summary

Static Methods

Modifier and Type	Method	Description
static ClientNamespacedDeleteManyModel	deleteMany(MongoNamespace namespace, org.bson.conversions.Bson filter)	Creates a model for deleting all documents from the namespace matching the filter.
static ClientNamespacedDeleteManyModel	deleteMany(MongoNamespace namespace, org.bson.conversions.Bson filter, ClientDeleteManyOptions options)	Creates a model for deleting all documents from the namespace matching the filter.
static ClientNamespacedDeleteOneModel	deleteOne(MongoNamespace namespace, org.bson.conversions.Bson filter)	Creates a model for deleting at most one document from the namespace matching the filter.
static ClientNamespacedDeleteOneModel	deleteOne(MongoNamespace namespace, org.bson.conversions.Bson filter, ClientDeleteOneOptions options)	Creates a model for deleting at most one document from the namespace matching the filter.
static <TDocument> ClientNamespacedInsertOneModel	insertOne(MongoNamespace namespace, TDocument document)	Creates a model for inserting the document into the namespace.
static <TDocument> ClientNamespacedReplaceOneModel	replaceOne(MongoNamespace namespace, org.bson.conversions.Bson filter, TDocument replacement)	Creates a model for replacing at most one document in the namespace matching the filter.
static <TDocument> ClientNamespacedReplaceOneModel	replaceOne(MongoNamespace namespace, org.bson.conversions.Bson filter, TDocument replacement, ClientReplaceOneOptions options)	Creates a model for replacing at most one document in the namespace matching the filter.
static ClientNamespacedUpdateManyModel	updateMany(MongoNamespace namespace, org.bson.conversions.Bson filter, Iterable<? extends org.bson.conversions.Bson> updatePipeline)	Creates a model for updating all documents in the namespace matching the filter.
static ClientNamespacedUpdateManyModel	updateMany(MongoNamespace namespace, org.bson.conversions.Bson filter, Iterable<? extends org.bson.conversions.Bson> updatePipeline, ClientUpdateManyOptions options)	Creates a model for updating all documents in the namespace matching the filter.
static ClientNamespacedUpdateManyModel	updateMany(MongoNamespace namespace, org.bson.conversions.Bson filter, org.bson.conversions.Bson update)	Creates a model for updating all documents in the namespace matching the filter.
static ClientNamespacedUpdateManyModel	updateMany(MongoNamespace namespace, org.bson.conversions.Bson filter, org.bson.conversions.Bson update, ClientUpdateManyOptions options)	Creates a model for updating all documents in the namespace matching the filter.
static ClientNamespacedUpdateOneModel	updateOne(MongoNamespace namespace, org.bson.conversions.Bson filter, Iterable<? extends org.bson.conversions.Bson> updatePipeline)	Creates a model for updating at most one document in the namespace matching the filter.
static ClientNamespacedUpdateOneModel	updateOne(MongoNamespace namespace, org.bson.conversions.Bson filter, Iterable<? extends org.bson.conversions.Bson> updatePipeline, ClientUpdateOneOptions options)	Creates a model for updating at most one document in the namespace matching the filter.
static ClientNamespacedUpdateOneModel	updateOne(MongoNamespace namespace, org.bson.conversions.Bson filter, org.bson.conversions.Bson update)	Creates a model for updating at most one document in the namespace matching the filter.
static ClientNamespacedUpdateOneModel	updateOne(MongoNamespace namespace, org.bson.conversions.Bson filter, org.bson.conversions.Bson update, ClientUpdateOneOptions options)	Creates a model for updating at most one document in the namespace matching the filter.

Method Details

insertOne

static <TDocument> ClientNamespacedInsertOneModel insertOne(MongoNamespace namespace,
 TDocument document)

Creates a model for inserting the document into the namespace.

Type Parameters:

TDocument - The document type, for example Document.

Parameters:

namespace - The namespace.

document - The document.

Returns:

The requested ClientNamespacedInsertOneModel.

updateOne

static ClientNamespacedUpdateOneModel updateOne(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 org.bson.conversions.Bson update)

Creates a model for updating at most one document in the namespace matching the filter. This method is functionally equivalent to updateOne(MongoNamespace, Bson, Bson, ClientUpdateOneOptions) with the default options.

Parameters:

namespace - The namespace.

filter - The filter.

update - The update.

Returns:

The requested ClientNamespacedUpdateOneModel.

See Also:

• Filters
• Updates

updateOne

static ClientNamespacedUpdateOneModel updateOne(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 org.bson.conversions.Bson update,
 ClientUpdateOneOptions options)

Creates a model for updating at most one document in the namespace matching the filter.

Parameters:

namespace - The namespace.

filter - The filter.

update - The update.

options - The options.

Returns:

The requested ClientNamespacedUpdateOneModel.

See Also:

• Filters
• Updates

updateOne

static ClientNamespacedUpdateOneModel updateOne(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 Iterable<? extends org.bson.conversions.Bson> updatePipeline)

Creates a model for updating at most one document in the namespace matching the filter. This method is functionally equivalent to updateOne(MongoNamespace, Bson, Iterable, ClientUpdateOneOptions) with the default options.

Parameters:

namespace - The namespace.

filter - The filter.

updatePipeline - The update pipeline.

Returns:

The requested ClientNamespacedUpdateOneModel.

See Also:

• Filters
• Aggregates

updateOne

static ClientNamespacedUpdateOneModel updateOne(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 Iterable<? extends org.bson.conversions.Bson> updatePipeline,
 ClientUpdateOneOptions options)

Creates a model for updating at most one document in the namespace matching the filter.

Parameters:

namespace - The namespace.

filter - The filter.

updatePipeline - The update pipeline.

options - The options.

Returns:

The requested ClientNamespacedUpdateOneModel.

See Also:

• Filters
• Aggregates

updateMany

static ClientNamespacedUpdateManyModel updateMany(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 org.bson.conversions.Bson update)

Creates a model for updating all documents in the namespace matching the filter. This method is functionally equivalent to updateMany(MongoNamespace, Bson, Bson, ClientUpdateManyOptions) with the default.

Parameters:

namespace - The namespace.

filter - The filter.

update - The update.

Returns:

The requested ClientNamespacedUpdateManyModel.

See Also:

• Filters
• Updates

updateMany

static ClientNamespacedUpdateManyModel updateMany(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 org.bson.conversions.Bson update,
 ClientUpdateManyOptions options)

Creates a model for updating all documents in the namespace matching the filter.

Parameters:

namespace - The namespace.

filter - The filter.

update - The update.

options - The options.

Returns:

The requested ClientNamespacedUpdateManyModel.

See Also:

• Filters
• Updates

updateMany

static ClientNamespacedUpdateManyModel updateMany(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 Iterable<? extends org.bson.conversions.Bson> updatePipeline)

Creates a model for updating all documents in the namespace matching the filter. This method is functionally equivalent to updateMany(MongoNamespace, Bson, Iterable, ClientUpdateManyOptions) with the default options.

Parameters:

namespace - The namespace.

filter - The filter.

updatePipeline - The update pipeline.

Returns:

The requested ClientNamespacedUpdateManyModel.

See Also:

• Filters
• Aggregates

updateMany

static ClientNamespacedUpdateManyModel updateMany(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 Iterable<? extends org.bson.conversions.Bson> updatePipeline,
 ClientUpdateManyOptions options)

Creates a model for updating all documents in the namespace matching the filter.

Parameters:

namespace - The namespace.

filter - The filter.

updatePipeline - The update pipeline.

options - The options.

Returns:

The requested ClientNamespacedUpdateManyModel.

See Also:

• Filters
• Aggregates

replaceOne

static <TDocument> ClientNamespacedReplaceOneModel replaceOne(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 TDocument replacement)

Creates a model for replacing at most one document in the namespace matching the filter. This method is functionally equivalent to replaceOne(MongoNamespace, Bson, Object, ClientReplaceOneOptions) with the default options.

Type Parameters:

TDocument - The document type, for example Document.

Parameters:

namespace - The namespace.

filter - The filter.

replacement - The replacement. The keys of this document must not start with $, unless they express a database reference.

Returns:

The requested ClientNamespacedReplaceOneModel.

See Also:

• Filters

replaceOne

static <TDocument> ClientNamespacedReplaceOneModel replaceOne(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 TDocument replacement,
 ClientReplaceOneOptions options)

Creates a model for replacing at most one document in the namespace matching the filter.

Type Parameters:

TDocument - The document type, for example Document.

Parameters:

namespace - The namespace.

filter - The filter.

replacement - The replacement. The keys of this document must not start with $, unless they express a database reference.

options - The options.

Returns:

The requested ClientNamespacedReplaceOneModel.

See Also:

• Filters

deleteOne

static ClientNamespacedDeleteOneModel deleteOne(MongoNamespace namespace,
 org.bson.conversions.Bson filter)

Creates a model for deleting at most one document from the namespace matching the filter. This method is functionally equivalent to deleteOne(MongoNamespace, Bson, ClientDeleteOneOptions) with the default options.

Parameters:

namespace - The namespace.

filter - The filter.

Returns:

The requested ClientNamespacedDeleteOneModel.

See Also:

• Filters

deleteOne

static ClientNamespacedDeleteOneModel deleteOne(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 ClientDeleteOneOptions options)

Creates a model for deleting at most one document from the namespace matching the filter.

Parameters:

namespace - The namespace.

filter - The filter.

options - The options.

Returns:

The requested ClientNamespacedDeleteOneModel.

See Also:

• Filters

deleteMany

static ClientNamespacedDeleteManyModel deleteMany(MongoNamespace namespace,
 org.bson.conversions.Bson filter)

Creates a model for deleting all documents from the namespace matching the filter. This method is functionally equivalent to deleteMany(MongoNamespace, Bson, ClientDeleteManyOptions) with the default options.

Parameters:

namespace - The namespace.

filter - The filter.

Returns:

The requested ClientNamespacedDeleteManyModel.

See Also:

• Filters

deleteMany

static ClientNamespacedDeleteManyModel deleteMany(MongoNamespace namespace,
 org.bson.conversions.Bson filter,
 ClientDeleteManyOptions options)

Creates a model for deleting all documents from the namespace matching the filter.

Parameters:

namespace - The namespace.

filter - The filter.

options - The options.

Returns:

The requested ClientNamespacedDeleteManyModel.

See Also:

• Filters