Packages

c

org.mongodb.scala

MongoCollection

case class MongoCollection[TResult](wrapped: com.mongodb.reactivestreams.client.MongoCollection[TResult]) extends Product with Serializable

The MongoCollection representation.

TResult

The type that this collection will encode documents from and decode documents to.

wrapped

the underlying java MongoCollection

Since

1.0

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MongoCollection
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MongoCollection(wrapped: com.mongodb.reactivestreams.client.MongoCollection[TResult])

    wrapped

    the underlying java MongoCollection

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def aggregate[C](clientSession: ClientSession, pipeline: Seq[Bson])(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): AggregateObservable[C]

    Aggregates documents according to the specified aggregation pipeline.

    Aggregates documents according to the specified aggregation pipeline.

    clientSession

    the client session with which to associate this operation

    pipeline

    the aggregate pipeline

    returns

    a Observable containing the result of the aggregation operation Aggregation

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  5. def aggregate[C](pipeline: Seq[Bson])(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): AggregateObservable[C]

    Aggregates documents according to the specified aggregation pipeline.

    Aggregates documents according to the specified aggregation pipeline.

    pipeline

    the aggregate pipeline

    returns

    a Observable containing the result of the aggregation operation Aggregation

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def bulkWrite(clientSession: ClientSession, requests: Seq[_ <: WriteModel[_ <: TResult]], options: BulkWriteOptions): SingleObservable[BulkWriteResult]

    Executes a mix of inserts, updates, replaces, and deletes.

    Executes a mix of inserts, updates, replaces, and deletes.

    clientSession

    the client session with which to associate this operation

    requests

    the writes to execute

    options

    the options to apply to the bulk write operation

    returns

    a Observable with a single element the BulkWriteResult

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  8. def bulkWrite(clientSession: ClientSession, requests: Seq[_ <: WriteModel[_ <: TResult]]): SingleObservable[BulkWriteResult]

    Executes a mix of inserts, updates, replaces, and deletes.

    Executes a mix of inserts, updates, replaces, and deletes.

    clientSession

    the client session with which to associate this operation

    requests

    the writes to execute

    returns

    a Observable with a single element the BulkWriteResult

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  9. def bulkWrite(requests: Seq[_ <: WriteModel[_ <: TResult]], options: BulkWriteOptions): SingleObservable[BulkWriteResult]

    Executes a mix of inserts, updates, replaces, and deletes.

    Executes a mix of inserts, updates, replaces, and deletes.

    requests

    the writes to execute

    options

    the options to apply to the bulk write operation

    returns

    a Observable with a single element the BulkWriteResult

  10. def bulkWrite(requests: Seq[_ <: WriteModel[_ <: TResult]]): SingleObservable[BulkWriteResult]

    Executes a mix of inserts, updates, replaces, and deletes.

    Executes a mix of inserts, updates, replaces, and deletes.

    requests

    the writes to execute

    returns

    a Observable with a single element the BulkWriteResult

  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  12. lazy val codecRegistry: CodecRegistry

    Get the codec registry for the MongoDatabase.

    Get the codec registry for the MongoDatabase.

    returns

    the { @link org.bson.codecs.configuration.CodecRegistry}

  13. def countDocuments(clientSession: ClientSession, filter: Bson, options: CountOptions): SingleObservable[Long]

    Counts the number of documents in the collection according to the given options.

    Counts the number of documents in the collection according to the given options.

    Note: For a fast count of the total documents in a collection see estimatedDocumentCount()* When migrating from count() to countDocuments() the following query operators must be replaced:

    +-------------+----------------------------------------+
| Operator    | Replacement                            |
+=============+========================================+
| `$where`     |  `$expr`                            |
+-------------+----------------------------------------+
| `$near`      |  `$geoWithin` with  `$center`      |
+-------------+----------------------------------------+
| `$nearSphere`|  `$geoWithin` with  `$centerSphere`|
+-------------+----------------------------------------+
    clientSession

    the client session with which to associate this operation

    filter

    the query filter

    options

    the options describing the count

    returns

    a publisher with a single element indicating the number of documents

    Since

    2.4

    Note

    Requires MongoDB 3.6 or greater

  14. def countDocuments(clientSession: ClientSession, filter: Bson): SingleObservable[Long]

    Counts the number of documents in the collection according to the given options.

    Counts the number of documents in the collection according to the given options.

    Note: For a fast count of the total documents in a collection see estimatedDocumentCount()* When migrating from count() to countDocuments() the following query operators must be replaced:

    +-------------+----------------------------------------+
| Operator    | Replacement                            |
+=============+========================================+
| `$where`     |  `$expr`                            |
+-------------+----------------------------------------+
| `$near`      |  `$geoWithin` with  `$center`      |
+-------------+----------------------------------------+
| `$nearSphere`|  `$geoWithin` with  `$centerSphere`|
+-------------+----------------------------------------+
    clientSession

    the client session with which to associate this operation

    filter

    the query filter

    returns

    a publisher with a single element indicating the number of documents

    Since

    2.4

    Note

    Requires MongoDB 3.6 or greater

  15. def countDocuments(clientSession: ClientSession): SingleObservable[Long]

    Counts the number of documents in the collection.

    Counts the number of documents in the collection.

    Note: For a fast count of the total documents in a collection see estimatedDocumentCount()* When migrating from count() to countDocuments() the following query operators must be replaced:

    +-------------+----------------------------------------+
| Operator    | Replacement                            |
+=============+========================================+
| `$where`     |  `$expr`                            |
+-------------+----------------------------------------+
| `$near`      |  `$geoWithin` with  `$center`      |
+-------------+----------------------------------------+
| `$nearSphere`|  `$geoWithin` with  `$centerSphere`|
+-------------+----------------------------------------+
    clientSession

    the client session with which to associate this operation

    returns

    a publisher with a single element indicating the number of documents

    Since

    2.4

    Note

    Requires MongoDB 3.6 or greater

  16. def countDocuments(filter: Bson, options: CountOptions): SingleObservable[Long]

    Counts the number of documents in the collection according to the given options.

    Counts the number of documents in the collection according to the given options.

    Note: For a fast count of the total documents in a collection see estimatedDocumentCount()* When migrating from count() to countDocuments() the following query operators must be replaced:

    +-------------+----------------------------------------+
| Operator    | Replacement                            |
+=============+========================================+
| `$where`     |  `$expr`                            |
+-------------+----------------------------------------+
| `$near`      |  `$geoWithin` with  `$center`      |
+-------------+----------------------------------------+
| `$nearSphere`|  `$geoWithin` with  `$centerSphere`|
+-------------+----------------------------------------+
    filter

    the query filter

    options

    the options describing the count

    returns

    a publisher with a single element indicating the number of documents

    Since

    2.4

  17. def countDocuments(filter: Bson): SingleObservable[Long]

    Counts the number of documents in the collection according to the given options.

    Counts the number of documents in the collection according to the given options.

    Note: For a fast count of the total documents in a collection see estimatedDocumentCount()* When migrating from count() to countDocuments() the following query operators must be replaced:

    +-------------+----------------------------------------+
| Operator    | Replacement                            |
+=============+========================================+
| `$where`     |  `$expr`                            |
+-------------+----------------------------------------+
| `$near`      |  `$geoWithin` with  `$center`      |
+-------------+----------------------------------------+
| `$nearSphere`|  `$geoWithin` with  `$centerSphere`|
+-------------+----------------------------------------+
    filter

    the query filter

    returns

    a publisher with a single element indicating the number of documents

    Since

    2.4

  18. def countDocuments(): SingleObservable[Long]

    Counts the number of documents in the collection.

    Counts the number of documents in the collection.

    Note: For a fast count of the total documents in a collection see estimatedDocumentCount()* When migrating from count() to countDocuments() the following query operators must be replaced:

    +-------------+----------------------------------------+
| Operator    | Replacement                            |
+=============+========================================+
| `$where`     |  `$expr`                            |
+-------------+----------------------------------------+
| `$near`      |  `$geoWithin` with  `$center`      |
+-------------+----------------------------------------+
| `$nearSphere`|  `$geoWithin` with  `$centerSphere`|
+-------------+----------------------------------------+
    returns

    a publisher with a single element indicating the number of documents

    Since

    2.4

  19. def createIndex(clientSession: ClientSession, key: Bson, options: IndexOptions): SingleObservable[String]

    Create Index

    Create Index

    clientSession

    the client session with which to associate this operation

    key

    an object describing the index key(s), which may not be null. This can be of any type for which a Codec is registered

    options

    the options for the index

    returns

    an empty Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  20. def createIndex(clientSession: ClientSession, key: Bson): SingleObservable[String]

    Create Index

    Create Index

    clientSession

    the client session with which to associate this operation

    key

    an object describing the index key(s), which may not be null. This can be of any type for which a Codec is registered

    returns

    an empty Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  21. def createIndex(key: Bson, options: IndexOptions): SingleObservable[String]

    Create Index

    Create Index

    key

    an object describing the index key(s), which may not be null. This can be of any type for which a Codec is registered

    options

    the options for the index

    returns

    an empty Observable that indicates when the operation has completed

  22. def createIndex(key: Bson): SingleObservable[String]

    Create Index

    Create Index

    key

    an object describing the index key(s), which may not be null. This can be of any type for which a Codec is registered

    returns

    an empty Observable that indicates when the operation has completed

  23. def createIndexes(clientSession: ClientSession, models: Seq[IndexModel], createIndexOptions: CreateIndexOptions): Observable[String]

    Create multiple indexes.

    Create multiple indexes.

    Create Index

    clientSession

    the client session with which to associate this operation

    models

    the list of indexes to create

    createIndexOptions

    options to use when creating indexes

    returns

    a Observable with the names of the indexes

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  24. def createIndexes(clientSession: ClientSession, models: Seq[IndexModel]): Observable[String]

    Create multiple indexes.

    Create multiple indexes.

    Create Index

    clientSession

    the client session with which to associate this operation

    models

    the list of indexes to create

    returns

    a Observable with the names of the indexes

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  25. def createIndexes(models: Seq[IndexModel], createIndexOptions: CreateIndexOptions): Observable[String]

    Create multiple indexes.

    Create multiple indexes.

    Create Index

    models

    the list of indexes to create

    createIndexOptions

    options to use when creating indexes

    returns

    a Observable with the names of the indexes

    Since

    2.2

  26. def createIndexes(models: Seq[IndexModel]): Observable[String]

    Create multiple indexes.

    Create multiple indexes.

    Create Index

    models

    the list of indexes to create

    returns

    a Observable with the names of the indexes

  27. def createSearchIndex(definition: Bson): SingleObservable[String]

    Create an Atlas Search index with default name for the collection.

    Create an Atlas Search index with default name for the collection.

    definition

    the search index mapping definition.

    returns

    an Observable with search index name.

    Since

    4.11

    Note

    Requires MongoDB 6.0 or greater

    See also

    Create Search Indexes

  28. def createSearchIndex(indexName: String, definition: Bson): SingleObservable[String]

    Create an Atlas Search index for the collection.

    Create an Atlas Search index for the collection.

    indexName

    the name of the search index to create.

    definition

    the search index mapping definition.

    returns

    an Observable with the search index name.

    Since

    4.11

    Note

    Requires MongoDB 6.0 or greater

    See also

    Create Search Indexes

  29. def createSearchIndexes(searchIndexModels: List[SearchIndexModel]): Observable[String]

    Create one or more Atlas Search indexes for the collection.

    Create one or more Atlas Search indexes for the collection.

    The name can be omitted for a single index, in which case a name will be default.

    searchIndexModels

    the search index models.

    returns

    an Observable with the names of the search indexes in the order specified by the given list of org.mongodb.scala.model.SearchIndexModels.

    Since

    4.11

    Note

    Requires MongoDB 6.0 or greater

    See also

    Create Search Indexes

  30. def deleteMany(clientSession: ClientSession, filter: Bson, options: DeleteOptions): SingleObservable[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.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to apply the delete operation

    options

    the options to apply to the delete operation

    returns

    a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  31. def deleteMany(clientSession: ClientSession, filter: Bson): SingleObservable[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.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to apply the delete operation

    returns

    a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  32. def deleteMany(filter: Bson, options: DeleteOptions): SingleObservable[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.

    filter

    the query filter to apply the delete operation

    options

    the options to apply to the delete operation

    returns

    a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

    Since

    1.2

  33. def deleteMany(filter: Bson): SingleObservable[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.

    filter

    the query filter to apply the delete operation

    returns

    a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

  34. def deleteOne(clientSession: ClientSession, filter: Bson, options: DeleteOptions): SingleObservable[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.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to apply the delete operation

    options

    the options to apply to the delete operation

    returns

    a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  35. def deleteOne(clientSession: ClientSession, filter: Bson): SingleObservable[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.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to apply the delete operation

    returns

    a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  36. def deleteOne(filter: Bson, options: DeleteOptions): SingleObservable[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.

    filter

    the query filter to apply the delete operation

    options

    the options to apply to the delete operation

    returns

    a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

    Since

    1.2

  37. def deleteOne(filter: Bson): SingleObservable[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.

    filter

    the query filter to apply the delete operation

    returns

    a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

  38. def distinct[C](clientSession: ClientSession, fieldName: String, filter: Bson)(implicit ct: ClassTag[C]): DistinctObservable[C]

    Gets the distinct values of the specified field name.

    Gets the distinct values of the specified field name.

    Distinct

    C

    the target type of the observable.

    clientSession

    the client session with which to associate this operation

    fieldName

    the field name

    filter

    the query filter

    returns

    a Observable emitting the sequence of distinct values

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  39. def distinct[C](clientSession: ClientSession, fieldName: String)(implicit ct: ClassTag[C]): DistinctObservable[C]

    Gets the distinct values of the specified field name.

    Gets the distinct values of the specified field name.

    Distinct

    C

    the target type of the observable.

    clientSession

    the client session with which to associate this operation

    fieldName

    the field name

    returns

    a Observable emitting the sequence of distinct values

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  40. def distinct[C](fieldName: String, filter: Bson)(implicit ct: ClassTag[C]): DistinctObservable[C]

    Gets the distinct values of the specified field name.

    Gets the distinct values of the specified field name.

    Distinct

    C

    the target type of the observable.

    fieldName

    the field name

    filter

    the query filter

    returns

    a Observable emitting the sequence of distinct values

  41. def distinct[C](fieldName: String)(implicit ct: ClassTag[C]): DistinctObservable[C]

    Gets the distinct values of the specified field name.

    Gets the distinct values of the specified field name.

    Distinct

    C

    the target type of the observable.

    fieldName

    the field name

    returns

    a Observable emitting the sequence of distinct values

  42. lazy val documentClass: Class[TResult]

    Get the default class to cast any documents returned from the database into.

    Get the default class to cast any documents returned from the database into.

    returns

    the default class to cast any documents into

  43. def drop(clientSession: ClientSession, dropCollectionOptions: DropCollectionOptions): SingleObservable[Unit]

    Drops this collection from the Database.

    Drops this collection from the Database.

    clientSession

    the client session with which to associate this operation

    dropCollectionOptions

    various options for dropping the collection

    returns

    an Observable that indicates when the operation has completed Drop Collection

    Since

    4.7

    Note

    Requires MongoDB 6.0 or greater

  44. def drop(dropCollectionOptions: DropCollectionOptions): SingleObservable[Unit]

    Drops this collection from the Database.

    Drops this collection from the Database.

    dropCollectionOptions

    various options for dropping the collection

    returns

    an Observable that indicates when the operation has completed Drop Collection

    Since

    4.7

    Note

    Requires MongoDB 6.0 or greater

  45. def drop(clientSession: ClientSession): SingleObservable[Unit]

    Drops this collection from the Database.

    Drops this collection from the Database.

    clientSession

    the client session with which to associate this operation

    returns

    an Observable that indicates when the operation has completed Drop Collection

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  46. def drop(): SingleObservable[Unit]

    Drops this collection from the Database.

    Drops this collection from the Database.

    returns

    an Observable that indicates when the operation has completed Drop Collection

  47. def dropIndex(clientSession: ClientSession, keys: Bson, dropIndexOptions: DropIndexOptions): SingleObservable[Unit]

    Drops the index given the keys used to create it.

    Drops the index given the keys used to create it.

    clientSession

    the client session with which to associate this operation

    keys

    the keys of the index to remove

    dropIndexOptions

    options to use when dropping indexes

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  48. def dropIndex(clientSession: ClientSession, keys: Bson): SingleObservable[Unit]

    Drops the index given the keys used to create it.

    Drops the index given the keys used to create it.

    clientSession

    the client session with which to associate this operation

    keys

    the keys of the index to remove

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  49. def dropIndex(clientSession: ClientSession, indexName: String, dropIndexOptions: DropIndexOptions): SingleObservable[Unit]

    Drops the given index.

    Drops the given index.

    Drop Indexes

    clientSession

    the client session with which to associate this operation

    indexName

    the name of the index to remove

    dropIndexOptions

    options to use when dropping indexes

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  50. def dropIndex(clientSession: ClientSession, indexName: String): SingleObservable[Unit]

    Drops the given index.

    Drops the given index.

    Drop Indexes

    clientSession

    the client session with which to associate this operation

    indexName

    the name of the index to remove

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  51. def dropIndex(keys: Bson, dropIndexOptions: DropIndexOptions): SingleObservable[Unit]

    Drops the index given the keys used to create it.

    Drops the index given the keys used to create it.

    keys

    the keys of the index to remove

    dropIndexOptions

    options to use when dropping indexes

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

  52. def dropIndex(keys: Bson): SingleObservable[Unit]

    Drops the index given the keys used to create it.

    Drops the index given the keys used to create it.

    keys

    the keys of the index to remove

    returns

    an Observable that indicates when the operation has completed

  53. def dropIndex(indexName: String, dropIndexOptions: DropIndexOptions): SingleObservable[Unit]

    Drops the given index.

    Drops the given index.

    Drop Indexes

    indexName

    the name of the index to remove

    dropIndexOptions

    options to use when dropping indexes

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

  54. def dropIndex(indexName: String): SingleObservable[Unit]

    Drops the given index.

    Drops the given index.

    Drop Indexes

    indexName

    the name of the index to remove

    returns

    an Observable that indicates when the operation has completed

  55. def dropIndexes(clientSession: ClientSession, dropIndexOptions: DropIndexOptions): SingleObservable[Unit]

    Drop all the indexes on this collection, except for the default on _id.

    Drop all the indexes on this collection, except for the default on _id.

    Drop Indexes

    clientSession

    the client session with which to associate this operation

    dropIndexOptions

    options to use when dropping indexes

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  56. def dropIndexes(clientSession: ClientSession): SingleObservable[Unit]

    Drop all the indexes on this collection, except for the default on _id.

    Drop all the indexes on this collection, except for the default on _id.

    Drop Indexes

    clientSession

    the client session with which to associate this operation

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  57. def dropIndexes(dropIndexOptions: DropIndexOptions): SingleObservable[Unit]

    Drop all the indexes on this collection, except for the default on _id.

    Drop all the indexes on this collection, except for the default on _id.

    Drop Indexes

    dropIndexOptions

    options to use when dropping indexes

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

  58. def dropIndexes(): SingleObservable[Unit]

    Drop all the indexes on this collection, except for the default on _id.

    Drop all the indexes on this collection, except for the default on _id.

    Drop Indexes

    returns

    an Observable that indicates when the operation has completed

  59. def dropSearchIndex(indexName: String): SingleObservable[Unit]

    Drop an Atlas Search index given its name.

    Drop an Atlas Search index given its name.

    indexName

    the name of the search index to drop.

    returns

    an Observable that indicates when the operation has completed.

    Since

    4.11

    Note

    Requires MongoDB 6.0 or greater

    See also

    Drop Search Index

  60. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. def estimatedDocumentCount(options: EstimatedDocumentCountOptions): SingleObservable[Long]

    Gets an estimate of the count of documents in a collection using collection metadata.

    Gets an estimate of the count of documents in a collection using collection metadata.

    options

    the options describing the count

    returns

    a publisher with a single element indicating the estimated number of documents

    Since

    2.4

    Note

    this method is implemented using the MongoDB server's count command

  62. def estimatedDocumentCount(): SingleObservable[Long]

    Gets an estimate of the count of documents in a collection using collection metadata.

    Gets an estimate of the count of documents in a collection using collection metadata.

    returns

    a publisher with a single element indicating the estimated number of documents

    Since

    2.4

    Note

    this method is implemented using the MongoDB server's count command

  63. def find[C](clientSession: ClientSession, filter: Bson)(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): FindObservable[C]

    Finds all documents in the collection.

    Finds all documents in the collection.

    Find

    C

    the target document type of the observable.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter

    returns

    the find Observable

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  64. def find[C](clientSession: ClientSession)(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): FindObservable[C]

    Finds all documents in the collection.

    Finds all documents in the collection.

    Find

    C

    the target document type of the observable.

    clientSession

    the client session with which to associate this operation

    returns

    the find Observable

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  65. def find[C](filter: Bson)(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): FindObservable[C]

    Finds all documents in the collection.

    Finds all documents in the collection.

    Find

    C

    the target document type of the observable.

    filter

    the query filter

    returns

    the find Observable

  66. def find[C]()(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): FindObservable[C]

    Finds all documents in the collection.

    Finds all documents in the collection.

    Find

    C

    the target document type of the observable.

    returns

    the find Observable

  67. def findOneAndDelete(clientSession: ClientSession, filter: Bson, options: FindOneAndDeleteOptions): SingleObservable[TResult]

    Atomically find a document and remove it.

    Atomically find a document and remove it.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to find the document with

    options

    the options to apply to the operation

    returns

    a Observable with a single element the document that was removed. If no documents matched the query filter, then null will be returned

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  68. def findOneAndDelete(clientSession: ClientSession, filter: Bson): SingleObservable[TResult]

    Atomically find a document and remove it.

    Atomically find a document and remove it.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to find the document with

    returns

    a Observable with a single element the document that was removed. If no documents matched the query filter, then null will be returned

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  69. def findOneAndDelete(filter: Bson, options: FindOneAndDeleteOptions): SingleObservable[TResult]

    Atomically find a document and remove it.

    Atomically find a document and remove it.

    filter

    the query filter to find the document with

    options

    the options to apply to the operation

    returns

    a Observable with a single element the document that was removed. If no documents matched the query filter, then null will be returned

  70. def findOneAndDelete(filter: Bson): SingleObservable[TResult]

    Atomically find a document and remove it.

    Atomically find a document and remove it.

    filter

    the query filter to find the document with

    returns

    a Observable with a single element the document that was removed. If no documents matched the query filter, then null will be returned

  71. def findOneAndReplace(clientSession: ClientSession, filter: Bson, replacement: TResult, options: FindOneAndReplaceOptions): SingleObservable[TResult]

    Atomically find a document and replace it.

    Atomically find a document and replace it.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to apply the replace operation

    replacement

    the replacement document

    options

    the options to apply to the operation

    returns

    a Observable with a single element the document that was replaced. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  72. def findOneAndReplace(clientSession: ClientSession, filter: Bson, replacement: TResult): SingleObservable[TResult]

    Atomically find a document and replace it.

    Atomically find a document and replace it.

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to apply the replace operation

    replacement

    the replacement document

    returns

    a Observable with a single element the document that was replaced. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  73. def findOneAndReplace(filter: Bson, replacement: TResult, options: FindOneAndReplaceOptions): SingleObservable[TResult]

    Atomically find a document and replace it.

    Atomically find a document and replace it.

    filter

    the query filter to apply the replace operation

    replacement

    the replacement document

    options

    the options to apply to the operation

    returns

    a Observable with a single element the document that was replaced. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

  74. def findOneAndReplace(filter: Bson, replacement: TResult): SingleObservable[TResult]

    Atomically find a document and replace it.

    Atomically find a document and replace it.

    filter

    the query filter to apply the replace operation

    replacement

    the replacement document

    returns

    a Observable with a single element the document that was replaced. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

  75. def findOneAndUpdate(clientSession: ClientSession, filter: Bson, update: Seq[Bson], options: FindOneAndUpdateOptions): SingleObservable[TResult]

    Atomically find a document and update it.

    Atomically find a document and update it.

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    options

    the options to apply to the operation

    returns

    a Observable with a single element the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  76. def findOneAndUpdate(clientSession: ClientSession, filter: Bson, update: Seq[Bson]): SingleObservable[TResult]

    Atomically find a document and update it.

    Atomically find a document and update it.

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    returns

    a Observable with a single element the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  77. def findOneAndUpdate(filter: Bson, update: Seq[Bson], options: FindOneAndUpdateOptions): SingleObservable[TResult]

    Atomically find a document and update it.

    Atomically find a document and update it.

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    options

    the options to apply to the operation

    returns

    a Observable with a single element the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  78. def findOneAndUpdate(filter: Bson, update: Seq[Bson]): SingleObservable[TResult]

    Atomically find a document and update it.

    Atomically find a document and update it.

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    returns

    a Observable with a single element the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  79. def findOneAndUpdate(clientSession: ClientSession, filter: Bson, update: Bson, options: FindOneAndUpdateOptions): SingleObservable[TResult]

    Atomically find a document and update it.

    Atomically find a document and update it.

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    options

    the options to apply to the operation

    returns

    a Observable with a single element the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  80. def findOneAndUpdate(clientSession: ClientSession, filter: Bson, update: Bson): SingleObservable[TResult]

    Atomically find a document and update it.

    Atomically find a document and update it.

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    returns

    a Observable with a single element the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  81. def findOneAndUpdate(filter: Bson, update: Bson, options: FindOneAndUpdateOptions): SingleObservable[TResult]

    Atomically find a document and update it.

    Atomically find a document and update it.

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    options

    the options to apply to the operation

    returns

    a Observable with a single element the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

  82. def findOneAndUpdate(filter: Bson, update: Bson): SingleObservable[TResult]

    Atomically find a document and update it.

    Atomically find a document and update it.

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    returns

    a Observable with a single element the document that was updated. Depending on the value of the returnOriginal property, this will either be the document as it was before the update or as it is after the update. If no documents matched the query filter, then null will be returned

  83. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  84. def insertMany(clientSession: ClientSession, documents: Seq[_ <: TResult], options: InsertManyOptions): SingleObservable[InsertManyResult]

    Inserts a batch of documents.

    Inserts a batch of documents. The preferred way to perform bulk inserts is to use the BulkWrite API.

    clientSession

    the client session with which to associate this operation

    documents

    the documents to insert

    options

    the options to apply to the operation

    returns

    a Observable with a single element the InsertManyResult or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoExceptionn

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  85. def insertMany(clientSession: ClientSession, documents: Seq[_ <: TResult]): SingleObservable[InsertManyResult]

    Inserts a batch of documents.

    Inserts a batch of documents. The preferred way to perform bulk inserts is to use the BulkWrite API.

    clientSession

    the client session with which to associate this operation

    documents

    the documents to insert

    returns

    a Observable with a single element the InsertManyResult or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  86. def insertMany(documents: Seq[_ <: TResult], options: InsertManyOptions): SingleObservable[InsertManyResult]

    Inserts a batch of documents.

    Inserts a batch of documents. The preferred way to perform bulk inserts is to use the BulkWrite API. However, when talking with a server < 2.6, using this method will be faster due to constraints in the bulk API related to error handling.

    documents

    the documents to insert

    options

    the options to apply to the operation

    returns

    a Observable with a single element the InsertManyResult or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

  87. def insertMany(documents: Seq[_ <: TResult]): SingleObservable[InsertManyResult]

    Inserts a batch of documents.

    Inserts a batch of documents. The preferred way to perform bulk inserts is to use the BulkWrite API. However, when talking with a server < 2.6, using this method will be faster due to constraints in the bulk API related to error handling.

    documents

    the documents to insert

    returns

    a Observable with a single element the InsertManyResult or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

  88. def insertOne(clientSession: ClientSession, document: TResult, options: InsertOneOptions): SingleObservable[InsertOneResult]

    Inserts the provided document.

    Inserts the provided document. If the document is missing an identifier, the driver should generate one.

    clientSession

    the client session with which to associate this operation

    document

    the document to insert

    options

    the options to apply to the operation

    returns

    a Observable with a single element the InsertOneResult or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  89. def insertOne(clientSession: ClientSession, document: TResult): SingleObservable[InsertOneResult]

    Inserts the provided document.

    Inserts the provided document. If the document is missing an identifier, the driver should generate one.

    clientSession

    the client session with which to associate this operation

    document

    the document to insert

    returns

    a Observable with a single element the InsertOneResult or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  90. def insertOne(document: TResult, options: InsertOneOptions): SingleObservable[InsertOneResult]

    Inserts the provided document.

    Inserts the provided document. If the document is missing an identifier, the driver should generate one.

    document

    the document to insert

    options

    the options to apply to the operation

    returns

    a Observable with a single element the InsertOneResult or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

    Since

    1.1

  91. def insertOne(document: TResult): SingleObservable[InsertOneResult]

    Inserts the provided document.

    Inserts the provided document. If the document is missing an identifier, the driver should generate one.

    document

    the document to insert

    returns

    a Observable with a single element the InsertOneResult or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

  92. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  93. def listIndexes[C](clientSession: ClientSession)(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): ListIndexesObservable[C]

    Get all the indexes in this collection.

    Get all the indexes in this collection.

    listIndexes

    C

    the target document type of the observable.

    clientSession

    the client session with which to associate this operation

    returns

    the fluent list indexes interface

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  94. def listIndexes[C]()(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): ListIndexesObservable[C]

    Get all the indexes in this collection.

    Get all the indexes in this collection.

    listIndexes

    C

    the target document type of the observable.

    returns

    the fluent list indexes interface

  95. def listSearchIndexes[C]()(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): ListSearchIndexesObservable[C]

    Get all Atlas Search indexes in this collection.

    Get all Atlas Search indexes in this collection.

    C

    the target document type of the observable.

    returns

    the fluent list search indexes interface

    Since

    4.11

    Note

    Requires MongoDB 6.0 or greater

    See also

    List Search Indexes

  96. lazy val namespace: MongoNamespace

    Gets the namespace of this collection.

    Gets the namespace of this collection.

    returns

    the namespace

  97. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  98. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  99. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  100. def productElementNames: Iterator[String]
    Definition Classes
    Product
  101. lazy val readConcern: ReadConcern

    Get the read concern for the MongoDatabase.

    Get the read concern for the MongoDatabase.

    returns

    the ReadConcern

    Since

    1.1

  102. lazy val readPreference: ReadPreference

    Get the read preference for the MongoDatabase.

    Get the read preference for the MongoDatabase.

    returns

    the { @link com.mongodb.ReadPreference}

  103. def renameCollection(clientSession: ClientSession, newCollectionNamespace: MongoNamespace, options: RenameCollectionOptions): SingleObservable[Unit]

    Rename the collection with oldCollectionName to the newCollectionName.

    Rename the collection with oldCollectionName to the newCollectionName.

    Rename collection

    clientSession

    the client session with which to associate this operation

    newCollectionNamespace

    the name the collection will be renamed to

    options

    the options for renaming a collection

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  104. def renameCollection(clientSession: ClientSession, newCollectionNamespace: MongoNamespace): SingleObservable[Unit]

    Rename the collection with oldCollectionName to the newCollectionName.

    Rename the collection with oldCollectionName to the newCollectionName.

    Rename collection

    clientSession

    the client session with which to associate this operation

    newCollectionNamespace

    the name the collection will be renamed to

    returns

    an Observable that indicates when the operation has completed

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  105. def renameCollection(newCollectionNamespace: MongoNamespace, options: RenameCollectionOptions): SingleObservable[Unit]

    Rename the collection with oldCollectionName to the newCollectionName.

    Rename the collection with oldCollectionName to the newCollectionName.

    Rename collection

    newCollectionNamespace

    the name the collection will be renamed to

    options

    the options for renaming a collection

    returns

    an Observable that indicates when the operation has completed

  106. def renameCollection(newCollectionNamespace: MongoNamespace): SingleObservable[Unit]

    Rename the collection with oldCollectionName to the newCollectionName.

    Rename the collection with oldCollectionName to the newCollectionName.

    Rename collection

    newCollectionNamespace

    the name the collection will be renamed to

    returns

    an Observable that indicates when the operation has completed

  107. def replaceOne(clientSession: ClientSession, filter: Bson, replacement: TResult, options: ReplaceOptions): SingleObservable[UpdateResult]

    Replace a document in the collection according to the specified arguments.

    Replace a document in the collection according to the specified arguments.

    Replace

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to apply the replace operation

    replacement

    the replacement document

    options

    the options to apply to the replace operation

    returns

    a Observable with a single element the UpdateResult

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  108. def replaceOne(filter: Bson, replacement: TResult, options: ReplaceOptions): SingleObservable[UpdateResult]

    Replace a document in the collection according to the specified arguments.

    Replace a document in the collection according to the specified arguments.

    Replace

    filter

    the query filter to apply the replace operation

    replacement

    the replacement document

    options

    the options to apply to the replace operation

    returns

    a Observable with a single element the UpdateResult

  109. def replaceOne(clientSession: ClientSession, filter: Bson, replacement: TResult): SingleObservable[UpdateResult]

    Replace a document in the collection according to the specified arguments.

    Replace a document in the collection according to the specified arguments.

    Replace

    clientSession

    the client session with which to associate this operation

    filter

    the query filter to apply the replace operation

    replacement

    the replacement document

    returns

    a Observable with a single element the UpdateResult

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  110. def replaceOne(filter: Bson, replacement: TResult): SingleObservable[UpdateResult]

    Replace a document in the collection according to the specified arguments.

    Replace a document in the collection according to the specified arguments.

    Replace

    filter

    the query filter to apply the replace operation

    replacement

    the replacement document

    returns

    a Observable with a single element the UpdateResult

  111. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  112. lazy val timeout: Option[Duration]

    The time limit for the full execution of an operation.

    The time limit for the full execution of an operation.

    If not null the following deprecated options will be ignored: waitQueueTimeoutMS, socketTimeoutMS, wTimeoutMS, maxTimeMS and maxCommitTimeMS.

    • null means that the timeout mechanism for operations will defer to using:
      • waitQueueTimeoutMS: The maximum wait time in milliseconds that a thread may wait for a connection to become available
      • socketTimeoutMS: How long a send or receive on a socket can take before timing out.
      • wTimeoutMS: How long the server will wait for the write concern to be fulfilled before timing out.
      • maxTimeMS: The time limit for processing operations on a cursor. See: [cursor.maxTimeMS](https://docs.mongodb.com/manual/reference/method/cursor.maxTimeMS").
      • maxCommitTimeMS: The maximum amount of time to allow a single commitTransaction command to execute.
    • 0 means infinite timeout.
    • > 0 The time limit to use for the full execution of an operation.
    returns

    the optional timeout duration

    Annotations
    @Alpha()
    Since

    5.2

  113. def updateMany(clientSession: ClientSession, filter: Bson, update: Seq[Bson], options: UpdateOptions): SingleObservable[UpdateResult]

    Update all documents in the collection according to the specified arguments.

    Update all documents in the collection according to the specified arguments.

    Updates Update Operators

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    options

    the options to apply to the update operation

    returns

    a Observable with a single element the UpdateResult

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  114. def updateMany(clientSession: ClientSession, filter: Bson, update: Seq[Bson]): SingleObservable[UpdateResult]

    Update all documents in the collection according to the specified arguments.

    Update all documents in the collection according to the specified arguments.

    Updates Update Operators

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    returns

    a Observable with a single element the UpdateResult

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  115. def updateMany(filter: Bson, update: Seq[Bson], options: UpdateOptions): SingleObservable[UpdateResult]

    Update all documents in the collection according to the specified arguments.

    Update all documents in the collection according to the specified arguments.

    Updates Update Operators

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    options

    the options to apply to the update operation

    returns

    a Observable with a single element the UpdateResult

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  116. def updateMany(filter: Bson, update: Seq[Bson]): SingleObservable[UpdateResult]

    Update all documents in the collection according to the specified arguments.

    Update all documents in the collection according to the specified arguments.

    Updates Update Operators

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    returns

    a Observable with a single element the UpdateResult

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  117. def updateMany(clientSession: ClientSession, filter: Bson, update: Bson, options: UpdateOptions): SingleObservable[UpdateResult]

    Update all documents in the collection according to the specified arguments.

    Update all documents in the collection according to the specified arguments.

    Updates Update Operators

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    options

    the options to apply to the update operation

    returns

    a Observable with a single element the UpdateResult

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  118. def updateMany(clientSession: ClientSession, filter: Bson, update: Bson): SingleObservable[UpdateResult]

    Update all documents in the collection according to the specified arguments.

    Update all documents in the collection according to the specified arguments.

    Updates Update Operators

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    returns

    a Observable with a single element the UpdateResult

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  119. def updateMany(filter: Bson, update: Bson, options: UpdateOptions): SingleObservable[UpdateResult]

    Update all documents in the collection according to the specified arguments.

    Update all documents in the collection according to the specified arguments.

    Updates Update Operators

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    options

    the options to apply to the update operation

    returns

    a Observable with a single element the UpdateResult

  120. def updateMany(filter: Bson, update: Bson): SingleObservable[UpdateResult]

    Update all documents in the collection according to the specified arguments.

    Update all documents in the collection according to the specified arguments.

    Updates Update Operators

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    returns

    a Observable with a single element the UpdateResult

  121. def updateOne(clientSession: ClientSession, filter: Bson, update: Seq[Bson], options: UpdateOptions): SingleObservable[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.

    Updates Update Operators

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    options

    the options to apply to the update operation

    returns

    a Observable with a single element the UpdateResult

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  122. def updateOne(clientSession: ClientSession, filter: Bson, update: Seq[Bson]): SingleObservable[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.

    Updates Update Operators

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    returns

    a Observable with a single element the UpdateResult

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  123. def updateOne(filter: Bson, update: Seq[Bson], options: UpdateOptions): SingleObservable[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.

    Updates Update Operators

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    options

    the options to apply to the update operation

    returns

    a Observable with a single element the UpdateResult

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  124. def updateOne(filter: Bson, update: Seq[Bson]): SingleObservable[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.

    Updates Update Operators

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a pipeline describing the update.

    returns

    a Observable with a single element the UpdateResult

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

  125. def updateOne(clientSession: ClientSession, filter: Bson, update: Bson, options: UpdateOptions): SingleObservable[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.

    Updates Update Operators

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    options

    the options to apply to the update operation

    returns

    a Observable with a single element the UpdateResult

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  126. def updateOne(clientSession: ClientSession, filter: Bson, update: Bson): SingleObservable[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.

    Updates Update Operators

    clientSession

    the client session with which to associate this operation

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    returns

    a Observable with a single element the UpdateResult

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  127. def updateOne(filter: Bson, update: Bson, options: UpdateOptions): SingleObservable[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.

    Updates Update Operators

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    options

    the options to apply to the update operation

    returns

    a Observable with a single element the UpdateResult

  128. def updateOne(filter: Bson, update: Bson): SingleObservable[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.

    Updates Update Operators

    filter

    a document describing the query filter, which may not be null. This can be of any type for which a Codec is registered

    update

    a document describing the update, which may not be null. The update to apply must include only update operators. This can be of any type for which a Codec is registered

    returns

    a Observable with a single element the UpdateResult

  129. def updateSearchIndex(indexName: String, definition: Bson): SingleObservable[Unit]

    Update an Atlas Search index in the collection.

    Update an Atlas Search index in the collection.

    indexName

    the name of the search index to update.

    definition

    the search index mapping definition.

    returns

    an Observable that indicates when the operation has completed.

    Since

    4.11

    Note

    Requires MongoDB 6.0 or greater

    See also

    Update Search Index

  130. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  131. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  132. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  133. def watch[C](clientSession: ClientSession, pipeline: Seq[Bson])(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): ChangeStreamObservable[C]

    Creates a change stream for this collection.

    Creates a change stream for this collection.

    C

    the target document type of the observable.

    clientSession

    the client session with which to associate this operation

    pipeline

    the aggregation pipeline to apply to the change stream

    returns

    the change stream observable

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  134. def watch[C](clientSession: ClientSession)(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): ChangeStreamObservable[C]

    Creates a change stream for this collection.

    Creates a change stream for this collection.

    C

    the target document type of the observable.

    clientSession

    the client session with which to associate this operation

    returns

    the change stream observable

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  135. def watch[C](pipeline: Seq[Bson])(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): ChangeStreamObservable[C]

    Creates a change stream for this collection.

    Creates a change stream for this collection.

    C

    the target document type of the observable.

    pipeline

    the aggregation pipeline to apply to the change stream

    returns

    the change stream observable

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  136. def watch[C]()(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): ChangeStreamObservable[C]

    Creates a change stream for this collection.

    Creates a change stream for this collection.

    C

    the target document type of the observable.

    returns

    the change stream observable

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  137. def withCodecRegistry(codecRegistry: CodecRegistry): MongoCollection[TResult]

    Create a new MongoCollection instance with a different codec registry.

    Create a new MongoCollection instance with a different codec registry.

    The { @link CodecRegistry} configured by this method is effectively treated by the driver as an instance of { @link CodecProvider}, which { @link CodecRegistry} extends. So there is no benefit to defining a class that implements { @link CodecRegistry}. Rather, an application should always create { @link CodecRegistry} instances using the factory methods in { @link CodecRegistries}.

    codecRegistry

    the new { @link org.bson.codecs.configuration.CodecRegistry} for the collection

    returns

    a new MongoCollection instance with the different codec registry

    See also

    CodecRegistries

  138. def withDocumentClass[C]()(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): MongoCollection[C]

    Create a new MongoCollection instance with a different default class to cast any documents returned from the database into..

    Create a new MongoCollection instance with a different default class to cast any documents returned from the database into..

    C

    The type that the new collection will encode documents from and decode documents to

    returns

    a new MongoCollection instance with the different default class

  139. def withReadConcern(readConcern: ReadConcern): MongoCollection[TResult]

    Create a new MongoCollection instance with a different read concern.

    Create a new MongoCollection instance with a different read concern.

    readConcern

    the new ReadConcern for the collection

    returns

    a new MongoCollection instance with the different ReadConcern

    Since

    1.1

  140. def withReadPreference(readPreference: ReadPreference): MongoCollection[TResult]

    Create a new MongoCollection instance with a different read preference.

    Create a new MongoCollection instance with a different read preference.

    readPreference

    the new { @link com.mongodb.ReadPreference} for the collection

    returns

    a new MongoCollection instance with the different readPreference

  141. def withTimeout(timeout: Duration): MongoCollection[TResult]

    Sets the time limit for the full execution of an operation.

    Sets the time limit for the full execution of an operation.

    - 0 means infinite timeout. - > 0 The time limit to use for the full execution of an operation.

    timeout

    the timeout, which must be greater than or equal to 0

    returns

    a new MongoCollection instance with the set time limit for operations

    Annotations
    @Alpha()
    Since

    5.2

  142. def withWriteConcern(writeConcern: WriteConcern): MongoCollection[TResult]

    Create a new MongoCollection instance with a different write concern.

    Create a new MongoCollection instance with a different write concern.

    writeConcern

    the new { @link com.mongodb.WriteConcern} for the collection

    returns

    a new MongoCollection instance with the different writeConcern

  143. lazy val writeConcern: WriteConcern

    Get the write concern for the MongoDatabase.

    Get the write concern for the MongoDatabase.

    returns

    the { @link com.mongodb.WriteConcern}

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def mapReduce[C](clientSession: ClientSession, mapFunction: String, reduceFunction: String)(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): MapReduceObservable[C]

    Aggregates documents according to the specified map-reduce function.

    Aggregates documents according to the specified map-reduce function.

    C

    the target document type of the observable.

    clientSession

    the client session with which to associate this operation

    mapFunction

    A JavaScript function that associates or "maps" a value with a key and emits the key and value pair.

    reduceFunction

    A JavaScript function that "reduces" to a single object all the values associated with a particular key.

    returns

    a Observable containing the result of the map-reduce operation map-reduce

    Annotations
    @deprecated
    Deprecated

    (Since version 4.4.0) Superseded by aggregate

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  3. def mapReduce[C](mapFunction: String, reduceFunction: String)(implicit e: DefaultsTo[C, TResult], ct: ClassTag[C]): MapReduceObservable[C]

    Aggregates documents according to the specified map-reduce function.

    Aggregates documents according to the specified map-reduce function.

    C

    the target document type of the observable.

    mapFunction

    A JavaScript function that associates or "maps" a value with a key and emits the key and value pair.

    reduceFunction

    A JavaScript function that "reduces" to a single object all the values associated with a particular key.

    returns

    a Observable containing the result of the map-reduce operation map-reduce

    Annotations
    @deprecated
    Deprecated

    (Since version 4.4.0) Superseded by aggregate

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped