object MongoSingle extends MongoSingleImpl
Provides an idiomatic api for performing single operations against MongoDb. It only exposes methods for appending and modifying (delete, insert, replace and update).
- Source
- MongoSingle.scala
- Alphabetic
- By Inheritance
- MongoSingle
- MongoSingleImpl
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply[Doc](collection: MongoCollection[Doc]): MongoSingle[Doc]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def createIndex[Doc](collection: MongoCollection[Doc], key: Bson, indexOptions: IndexOptions = DefaultIndexOptions): Task[Unit]
Creates an index.
Creates an index.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb Collection.
- key
an object describing the index key(s), which may not be null.
- indexOptions
the options for the index
- returns
an empty Task or a failed one
- Definition Classes
- MongoSingle → MongoSingleImpl
- def createIndexes[Doc](collection: MongoCollection[Doc], indexes: List[IndexModel], createIndexOptions: CreateIndexOptions = DefaultCreateIndexesOptions): Task[Unit]
Create multiple indexes.
Create multiple indexes.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb Collection.
- indexes
the list of indexes
- createIndexOptions
the options to use when creating indexes
- returns
an empty Task or a failed one
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.IndexModel
- def deleteMany[Doc](collection: MongoCollection[Doc], filter: Bson, deleteOptions: DeleteOptions = DefaultDeleteOptions, retryStrategy: RetryStrategy = DefaultRetryStrategy): Task[DeleteResult]
Removes all documents from the collection that match the given query filter.
Removes all documents from the collection that match the given query filter. If no documents match, the collection is not modified.
- Doc
the type of the collection
- collection
the abstraction to work with a determined MongoDB Collection
- filter
the query filter to apply the the delete operation
- deleteOptions
the options to apply to the delete operation, it will use default ones in case it is not passed by the user.
- retryStrategy
defines the amount of retries and backoff delays for failed requests.
- returns
a Task with an optional of DeleteResult, being by default DefaultDeleteResult, or a failed one with com.mongodb.MongoException.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
- def deleteMany[Doc](collection: MongoCollection[Doc], filter: Bson): Task[DeleteResult]
Removes all documents from the collection that match the given query filter.
Removes all documents from the collection that match the given query filter. If no documents match, the collection is not modified.
- Doc
the type of the collection
- collection
the abstraction to work with a determined MongoDB Collection
- filter
the query filter to apply the the delete operation
- returns
a Task with an optional DeleteResult, being by default DefaultDeleteResult, or a failed one with com.mongodb.MongoException.
- Definition Classes
- MongoSingle → MongoSingleImpl
- def deleteOne[Doc](collection: MongoCollection[Doc], filter: Bson, deleteOptions: DeleteOptions = DefaultDeleteOptions, retryStrategy: RetryStrategy = DefaultRetryStrategy): Task[DeleteResult]
Removes at most one document from the collection that matches the given filter with some delete options.
Removes at most one document from the collection that matches the given filter with some delete options. If no documents match, the collection is not modified.
- Doc
the type of the collection
- collection
the abstraction to work with a determined MongoDB Collection
- filter
the query filter to apply the the delete operation
- deleteOptions
the options to apply to the delete operation, it will use default ones in case it is not passed by the user.
- retryStrategy
defines the amount of retries and backoff delays for failed requests.
- returns
a Task with an optional DeleteResult, being by default DefaultDeleteResult, or a failed one with com.mongodb.MongoException.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
- def deleteOne[Doc](collection: MongoCollection[Doc], filter: Bson): Task[DeleteResult]
Removes at most one document from the collection that matches the given filter.
Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified.
- Doc
the type of the collection.
- collection
the abstraction to work with a determined MongoDB Collection.
- filter
the query filter to apply the delete operation.
- returns
a Task with a DeleteResult, being by default DefaultDeleteResult, or a failed one with com.mongodb.MongoException.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def insertMany[Doc](collection: MongoCollection[Doc], docs: Seq[Doc], insertManyOptions: InsertManyOptions = DefaultInsertManyOptions, retryStrategy: RetryStrategy = DefaultRetryStrategy): Task[InsertManyResult]
Inserts a batch of documents.
Inserts a batch of documents. If the documents is missing an identifier, the driver should generate one.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb collection
- docs
the documents to insert
- insertManyOptions
the options to apply to the insert operation
- retryStrategy
defines the amount of retries and backoff delays for failed requests.
- returns
a Task with the InsertManyResult that will contain the successful inserted ids, being by default DefaultInsertManyResult, or a failed one with com.mongodb.DuplicateKeyException or com.mongodb.MongoException.
- Definition Classes
- MongoSingle → MongoSingleImpl
- def insertMany[Doc](collection: MongoCollection[Doc], docs: Seq[Doc]): Task[InsertManyResult]
Inserts a batch of documents.
Inserts a batch of documents. If the documents is missing an identifier, the driver should generate one.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb collection
- returns
a Task with the InsertManyResult that will contain the successful inserted ids, being by default DefaultInsertManyResult. or a failed one with com.mongodb.DuplicateKeyException or com.mongodb.MongoException.
- Definition Classes
- MongoSingle → MongoSingleImpl
- def insertOne[Doc](collection: MongoCollection[Doc], document: Doc, insertOneOptions: InsertOneOptions = DefaultInsertOneOptions, retryStrategy: RetryStrategy = DefaultRetryStrategy): Task[InsertOneResult]
Inserts the provided document.
Inserts the provided document. If the document is missing an identifier, the driver should generate one.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb collection
- document
the document to be inserted
- insertOneOptions
the options to apply to the insert operation
- retryStrategy
defines the amount of retries and backoff delays for failed requests.
- returns
a Task with the InsertOneResult that will contain the inserted id in case the operation finished successfully, being by default DefaultInsertOneResult, or a failed one with com.mongodb.DuplicateKeyException or com.mongodb.MongoException.
- Definition Classes
- MongoSingle → MongoSingleImpl
- def insertOne[Doc](collection: MongoCollection[Doc], document: Doc): Task[InsertOneResult]
Inserts the provided document.
Inserts the provided document. If the document is missing an identifier, the driver should generate one.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb collection
- document
the document to be inserted
- returns
a Task with the InsertOneResult that will contain the inserted id in case the operation finished successfully, being by default DefaultInsertOneResult, or a failed one with com.mongodb.DuplicateKeyException or com.mongodb.MongoException.
- Definition Classes
- MongoSingle → MongoSingleImpl
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def replaceOne[Doc](collection: MongoCollection[Doc], filter: Bson, replacement: Doc, replaceOptions: ReplaceOptions = DefaultReplaceOptions, retryStrategy: RetryStrategy = DefaultRetryStrategy): Task[UpdateResult]
Replace a document in the collection according to the specified arguments.
Replace a document in the collection according to the specified arguments.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb collection
- filter
the query filter to apply the the replace operation
- replacement
the replacement document
- replaceOptions
the options to apply to the replace operation
- retryStrategy
defines the amount of retries and backoff delays for failed requests.
- returns
a Task with a single UpdateResult, being by default DefaultUpdateResult, or a failed one.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
- def replaceOne[Doc](collection: MongoCollection[Doc], filter: Bson, replacement: Doc): Task[UpdateResult]
Replace a document in the collection according to the specified arguments.
Replace a document in the collection according to the specified arguments.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb collection
- filter
the query filter to apply the the replace operation
- replacement
the replacement document
- returns
a Task with an UpdateResult, being by default DefaultUpdateResult, or a failed one.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def updateMany[Doc](collection: MongoCollection[Doc], filter: Bson, update: Bson, updateOptions: UpdateOptions = DefaultUpdateOptions, retryStrategy: RetryStrategy = DefaultRetryStrategy): Task[UpdateResult]
Update all documents in the collection according to the specified arguments.
Update all documents in the collection according to the specified arguments.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb Collection.
- filter
a document describing the query filter, which may not be null.
- update
a document describing the update, which may not be null, the update to apply must include only update operators
- updateOptions
the options to apply to the update operation
- retryStrategy
defines the amount of retries and backoff delays for failed requests.
- returns
a Task with an optional UpdateResult being by default DefaultUpdateResult, or a failed one.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
com.mongodb.client.model.Updates
- def updateMany[Doc](collection: MongoCollection[Doc], filter: Bson, update: Bson): Task[UpdateResult]
Update all documents in the collection according to the specified arguments.
Update all documents in the collection according to the specified arguments.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb Collection.
- filter
a document describing the query filter, which may not be null.
- update
a document describing the update, which may not be null, the update to apply must include only update operators
- returns
a Task with an optional UpdateResult, being by default DefaultUpdateResult, or a failed one.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
com.mongodb.client.model.Updates
- def updateOne[Doc](collection: MongoCollection[Doc], filter: Bson, update: Bson, updateOptions: UpdateOptions = DefaultUpdateOptions, retryStrategy: RetryStrategy = DefaultRetryStrategy): Task[UpdateResult]
Update a single document in the collection according to the specified arguments.
Update a single document in the collection according to the specified arguments.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb Collection.
- filter
a document describing the query filter, which may not be null.
- update
a document describing the update, which may not be null, the update to apply must include only update operators
- updateOptions
the options to apply to the update operation
- retryStrategy
defines the amount of retries and backoff delays for failed requests.
- returns
a Task with an optional UpdateResult, being by default DefaultUpdateResult, or a failed one.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
com.mongodb.client.model.Updates
- def updateOne[Doc](collection: MongoCollection[Doc], filter: Bson, update: Bson): Task[UpdateResult]
Update a single document in the collection according to the specified arguments.
Update a single document in the collection according to the specified arguments.
- Doc
the type of the collection
- collection
the abstraction to work with the determined mongodb collection
- filter
a document describing the query filter, which may not be null.
- update
a document describing the update, which may not be null, the update to apply must include only update operators
- returns
a Task with a UpdateResult, being by default DefaultUpdateResult or a failed one.
- Definition Classes
- MongoSingle → MongoSingleImpl
- See also
com.mongodb.client.model.Filters
com.mongodb.client.model.Updates
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()