Updates all documents matching the given query with the document encoded from the given model.
@discardableResult func updateManyEncoded<Query, E>(where query: Query, to model: E) async throws -> UpdateReply where Query : MongoKittenQuery, E : Encodable s11MongoKitten0A10CollectionC17updateManyEncoded5where2to0aB4Core11UpdateReplyVx_q_tYaKAG0aB5QueryRzSER_r0_lF What are these?9EWN3The reply from the server
See: https://docs.mongodb.com/manual/reference/command/update/
import MongoKittenfinal class MongoCollectionA reference to a collection in a MongoDatabase.
struct UpdateReplyprotocol MongoKittenQueryprotocol EncodableA type that can encode itself to an external representation.
let database: MongoDatabaseThe database this collection belongs to
var isInTransaction: Bool { get }Whether this collection is part of a transaction
let name: StringThe name of this collection
var namespace: MongoNamespace { get }The full namespace of this collection
let session: MongoClientSession?The session this collection is bound to
var sessionId: SessionIdentifier? { get }The session identifier for this collection’s session
func buildAggregate(@AggregateBuilder build: () -> [any AggregateBuilderStage]) -> AggregateBuilderPipeline Creates an aggregation pipeline for complex data processing and analysis.
func buildChangeStream(options: ChangeStreamOptions = .init(), @AggregateBuilder build: () -> [any AggregateBuilderStage]) async throws -> ChangeStream<Document> Creates a change stream for this collection using the given aggregation pipeline.
func buildChangeStream<T>(options: ChangeStreamOptions = .init(), ofType type: T.Type, using decoder: BSONDecoder = BSONDecoder(), @AggregateBuilder build: () -> [any AggregateBuilderStage]) async throws -> ChangeStream<T> where T : Decodable Creates a change stream for this collection using the given aggregation pipeline
func buildIndexes(@MongoIndexBuilder build: () -> _MongoIndexes) async throws Creates indexes using a builder pattern
func count(_ query: Document? = nil) async throws -> Int Counts the amount of documents in this collection matching the given query. If no query is given, this counts all documents in the collection.
func count<Query>(_ query: Query? = nil) async throws -> Int where Query : MongoKittenQuery Counts the amount of documents in this collection matching the given query. If no query is given, this counts all documents in the collection.
func createIndex(named name: String, keys: Document) async throws Creates a new index on this collection
func createIndexes(_ indexes: [CreateIndexes.Index]) async throws Creates multiple indexes on this collection
@discardableResult func deleteAll(where query: Document, writeConcern: WriteConcern? = nil) async throws -> DeleteReply Deletes all documents matching the given query. If no query is given, it deletes all documents in the collection.
@discardableResult func deleteAll<Q>(where filter: Q, writeConcern: WriteConcern? = nil) async throws -> DeleteReply where Q : MongoKittenQuery Deletes all documents matching the given query.
@discardableResult func deleteOne(where query: Document, writeConcern: WriteConcern? = nil) async throws -> DeleteReply Deletes the first document matching the given query. If no query is given, it deletes the first document in the collection.
@discardableResult func deleteOne<Q>(where filter: Q, writeConcern: WriteConcern? = nil) async throws -> DeleteReply where Q : MongoKittenQuery Deletes the first document matching the given query.
func distinctValues(forKey key: String, where query: Document? = nil) async throws -> [any Primitive] Returns the distinct values for the given key in this collection matching the given query.
func drop() async throws Drops this collection and all its indexes
func find(_ query: Document = [:]) -> FindQueryBuilder Finds documents in this collection matching the given query. If no query is given, it returns all documents in the collection.
func find<Query>(_ query: Query) -> FindQueryBuilder where Query : MongoKittenQuery Finds documents in this collection matching the given query. If no query is given, it returns all documents in the collection.
func find<D>(_ query: Document = [:], as type: D.Type) -> MappedCursor<FindQueryBuilder, D> where D : Decodable Finds documents in this collection matching the given query. If no query is given, it returns all documents in the collection. Decodes the results to the given type.
func find<D, Query>(_ query: Query, as type: D.Type) -> MappedCursor<FindQueryBuilder, D> where D : Decodable, Query : MongoKittenQuery Finds documents in this collection matching the given query. If no query is given, it returns all documents in the collection. Decodes the results to the given type.
func findAndModify(where query: Document, update document: Document = [:], remove: Bool = false, returnValue: FindAndModifyReturnValue = .original) -> FindAndModifyBuilder Modifies and returns a single document.
func findAndModify<Query>(where query: Query, update document: Document = [:], remove: Bool = false, returnValue: FindAndModifyReturnValue = .original) -> FindAndModifyBuilder where Query : MongoKittenQuery Modifies and returns a single document.
func findOne(_ query: Document = [:]) async throws -> Document? Finds the first document in this collection matching the given query. If no query is given, it returns the first document in the collection.
func findOne<Query>(_ query: Query) async throws -> Document? where Query : MongoKittenQuery Finds the first document in this collection matching the given query. If no query is given, it returns the first document in the collection.
func findOne<D>(_ query: Document = [:], as type: D.Type) async throws -> D? where D : Decodable Finds the first document in this collection matching the given query. Decodes the result into D.Type.
func findOne<D, Query>(_ query: Query, as type: D.Type) async throws -> D? where D : Decodable, Query : MongoKittenQuery Finds the first document in this collection matching the given query. Decodes the result into D.Type.
func findOneAndDelete(where query: Document) -> FindAndModifyBuilder Deletes a single document based on the query, returning the deleted document.
func findOneAndDelete<Query>(where query: Query) -> FindAndModifyBuilder where Query : MongoKittenQuery Deletes a single document based on the query, returning the deleted document.
func findOneAndReplace(where query: Document, replacement document: Document, returnValue: FindAndModifyReturnValue = .original) -> FindAndModifyBuilder Replaces a single document based on the specified query.
func findOneAndReplace<Query>(where query: Query, replacement document: Document, returnValue: FindAndModifyReturnValue = .original) -> FindAndModifyBuilder where Query : MongoKittenQuery Replaces a single document based on the specified query.
func findOneAndUpdate(where query: Document, to document: Document, returnValue: FindAndModifyReturnValue = .original) -> FindAndModifyBuilder Updates a single document based on the specified query.
func findOneAndUpdate<Query>(where query: Query, to document: Document, returnValue: FindAndModifyReturnValue = .original) -> FindAndModifyBuilder where Query : MongoKittenQuery Updates a single document based on the specified query.
func findOneAndUpsert(where query: Document, replacement document: Document, returnValue: FindAndModifyReturnValue = .original) -> FindAndModifyBuilder Replaces a single document based on the specified query.
@discardableResult func insert(_ document: Document, writeConcern: WriteConcern? = nil) async throws -> InsertReply Creates a new document in this collection with the given document. The document must have an _id field, or one will be generated.
@discardableResult func insertEncoded<E>(_ model: E, writeConcern: WriteConcern? = nil) async throws -> InsertReply where E : Encodable Creates a new document in this collection with the given model encoded to a BSON Document.
@discardableResult func insertMany(_ documents: [Document], writeConcern: WriteConcern? = nil) async throws -> InsertReply Creates new documents in this collection with the given documents.
@discardableResult func insertManyEncoded<E>(_ models: [E], writeConcern: WriteConcern? = nil) async throws -> InsertReply where E : Encodable Creates new documents in this collection with the given models encoded to BSON Documents.
func listIndexes() async throws -> MappedCursor<MongoCursor, MongoIndex> Lists all indexes in this collection
@discardableResult func updateEncoded<E>(where query: Document, to model: E) async throws -> UpdateReply where E : Encodable Replaces a single document in this collection matching the given query with the document encoded from the given model.
@discardableResult func updateEncoded<Query, E>(where query: Query, to model: E) async throws -> UpdateReply where Query : MongoKittenQuery, E : Encodable Updates a single document in this collection matching the given query with the document encoded from the given model.
@discardableResult func updateMany(where query: Document, setting: Document?, unsetting: Document?) async throws -> UpdateReply Updates all documents matching the given query.
@discardableResult func updateMany(where query: Document, to document: Document) async throws -> UpdateReply Update all documents matching the given query with the given document.
@discardableResult func updateMany<Query>(where query: Query, to document: Document) async throws -> UpdateReply where Query : MongoKittenQuery Updates all documents matching the given query with the given document.
@discardableResult func updateManyEncoded<E>(where query: Document, to model: E) async throws -> UpdateReply where E : Encodable @discardableResult func updateOne(where query: Document, to document: Document) async throws -> UpdateReply Updates a single document in this collection matching the given query with the given document.
@discardableResult func updateOne<Query>(where query: Query, to document: Document) async throws -> UpdateReply where Query : MongoKittenQuery Replaces a single document in this collection matching the given query with the given document.
@discardableResult func upsert(_ document: Document, where query: Document) async throws -> UpdateReply Creates a new document in this collection if no document matches the given query. Otherwise, updates the first document matching the query.
@discardableResult func upsert<Query>(_ document: Document, where query: Query) async throws -> UpdateReply where Query : MongoKittenQuery Creates a new document in this collection if no document matches the given query. Otherwise, updates the first document matching the query.
@discardableResult func upsertEncoded<Query, E>(_ model: E, where query: Query) async throws -> UpdateReply where Query : MongoKittenQuery, E : Encodable Creates a new document in this collection if no document matches the given query. Otherwise, updates the first document matching the query.
@discardableResult func upsertEncoded<E>(_ model: E, where query: Document) async throws -> UpdateReply where E : Encodable Creates a new document in this collection if no document matches the given query. Otherwise, updates the first document matching the query.
func watch(options: ChangeStreamOptions = .init()) async throws -> ChangeStream<Document> Creates a simple change stream for this collection.
func watch<T>(options: ChangeStreamOptions = .init(), type: T.Type, using decoder: BSONDecoder = BSONDecoder()) async throws -> ChangeStream<T> where T : Decodable Creates a type-safe change stream for this collection