Mongo Scala Driver - org.mongodb.scala.MongoCollection

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 aggregate[C](pipeline: Seq[Bson])(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): AggregateObservable[C]

Aggregates documents according to the specified aggregation pipeline.

pipeline: the aggregate pipeline
returns: a Observable containing the result of the aggregation operation Aggregation

final def asInstanceOf[T0]: T0

Definition Classes: Any

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

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

def bulkWrite(requests: Seq[_ <: WriteModel[_ <: TResult]]): Observable[BulkWriteResult]

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

requests: the writes to execute
returns: a Observable with a single element the BulkWriteResult

def clone(): AnyRef

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( ... )

lazy val codecRegistry: CodecRegistry

Get the codec registry for the MongoDatabase.

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

def count(filter: Bson, options: CountOptions): Observable[Long]

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

filter: the query filter
options: the options describing the count
returns: a Observable with a single element indicating the number of documents

def count(filter: Bson): Observable[Long]

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

filter: the query filter
returns: a Observable with a single element indicating the number of documents

def count(): Observable[Long]

Counts the number of documents in the collection.

returns: a Observable with a single element indicating the number of documents

def createIndex(key: Bson, options: IndexOptions): Observable[String]

Create Index

key: an object describing the index key(s), which may not be null. This can be of any type for which a { @code Codec} is registered
options: the options for the index
returns: a Observable with a single element indicating when the operation has completed

def createIndex(key: Bson): Observable[String]

Create an Index

key: an object describing the index key(s), which may not be null. This can be of any type for which a { @code Codec} is registered
returns: a Observable with a single element indicating when the operation has completed Ensure Index

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

Create Index

models: the list of indexes to create
returns: a Observable with a single element indicating when the operation has completed

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

def deleteMany(filter: Bson): Observable[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 the delete operation
returns: a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

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

def deleteOne(filter: Bson): Observable[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 the delete operation
returns: a Observable with a single element the DeleteResult or with an com.mongodb.MongoException

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

Gets the distinct values of the specified field name.

Distinct

C: the target type of the iterable.
fieldName: the field name
filter: the query filter
returns: a Observable emitting the sequence of distinct values

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

Gets the distinct values of the specified field name.

Distinct

C: the target type of the iterable.
fieldName: the field name
returns: a Observable emitting the sequence of distinct values

lazy val documentClass: Class[TResult]

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

returns: the default class to cast any documents into

def drop(): Observable[Completed]

Drops this collection from the Database.

returns: a Observable with a single element indicating when the operation has completed Drop Collection

def dropIndex(keys: Bson): Observable[Completed]

Drops the index given the keys used to create it.

keys: the keys of the index to remove
returns: a Observable with a single element indicating when the operation has completed

def dropIndex(indexName: String): Observable[Completed]

Drops the given index.

Drop Indexes

indexName: the name of the index to remove
returns: a Observable with a single element indicating when the operation has completed

def dropIndexes(): Observable[Completed]

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

Drop Indexes

returns: a Observable with a single element indicating when the operation has completed

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def finalize(): Unit

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

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

Finds all documents in the collection.

Find

C: the target document type of the iterable.
filter: the query filter
returns: the find Observable

def find[C]()(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): FindObservable[C]

Finds all documents in the collection.

Find

C: the target document type of the iterable.
returns: the find Observable

def findOneAndDelete(filter: Bson, options: FindOneAndDeleteOptions): Observable[TResult]

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

def findOneAndDelete(filter: Bson): Observable[TResult]

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

def findOneAndReplace(filter: Bson, replacement: TResult, options: FindOneAndReplaceOptions): Observable[TResult]

Atomically find a document and replace it.

filter: the query filter to apply the 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 { @code 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

def findOneAndReplace(filter: Bson, replacement: TResult): Observable[TResult]

Atomically find a document and replace it.

filter: the query filter to apply the 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 { @code 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

def findOneAndUpdate(filter: Bson, update: Bson, options: FindOneAndUpdateOptions): Observable[TResult]

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 { @code 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 { @code 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 { @code 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

def findOneAndUpdate(filter: Bson, update: Bson): Observable[TResult]

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 { @code 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 { @code Codec} is registered
returns: a Observable with a single element the document that was updated before the update was applied. If no documents matched the query filter, then null will be returned

final def getClass(): Class[_]

Definition Classes: AnyRef → Any

def insertMany(documents: Seq[_ <: TResult], options: InsertManyOptions): Observable[Completed]

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 indicating when the operation has completed or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

def insertMany(documents: Seq[_ <: TResult]): Observable[Completed]

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 indicating when the operation has completed or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

def insertOne(document: TResult, options: InsertOneOptions): Observable[Completed]

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 indicating when the operation has completed or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

Since: 1.1

def insertOne(document: TResult): Observable[Completed]

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 indicating when the operation has completed or with either a com.mongodb.DuplicateKeyException or com.mongodb.MongoException

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

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

Get all the indexes in this collection.

listIndexes

C: the target document type of the iterable.
returns: the fluent list indexes interface

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

Aggregates documents according to the specified map-reduce function.

C: the target document type of the iterable.
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

lazy val namespace: MongoNamespace

Gets the namespace of this collection.

returns: the namespace

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def notify(): Unit

Definition Classes: AnyRef

final def notifyAll(): Unit

Definition Classes: AnyRef

lazy val readConcern: ReadConcern

Get the read concern for the MongoDatabase.

returns: the ReadConcern

Since: 1.1

lazy val readPreference: ReadPreference

Get the read preference for the MongoDatabase.

returns: the { @link com.mongodb.ReadPreference}

def renameCollection(newCollectionNamespace: MongoNamespace, options: RenameCollectionOptions): Observable[Completed]

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: a Observable with a single element indicating when the operation has completed

def renameCollection(newCollectionNamespace: MongoNamespace): Observable[Completed]

Rename the collection with oldCollectionName to the newCollectionName.

Rename collection

newCollectionNamespace: the namespace the collection will be renamed to
returns: a Observable with a single element indicating when the operation has completed

def replaceOne(filter: Bson, replacement: TResult, options: UpdateOptions): Observable[UpdateResult]

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

Replace

filter: the query filter to apply the 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

def replaceOne(filter: Bson, replacement: TResult): Observable[UpdateResult]

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

Replace

filter: the query filter to apply the the replace operation
replacement: the replacement document
returns: a Observable with a single element the UpdateResult

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes: AnyRef

def updateMany(filter: Bson, update: Bson, options: UpdateOptions): Observable[UpdateResult]

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 { @code 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 { @code Codec} is registered
options: the options to apply to the update operation
returns: a Observable with a single element the UpdateResult

def updateMany(filter: Bson, update: Bson): Observable[UpdateResult]

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 { @code 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 { @code Codec} is registered
returns: a Observable with a single element the UpdateResult

def updateOne(filter: Bson, update: Bson, options: UpdateOptions): Observable[UpdateResult]

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 { @code 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 { @code Codec} is registered
options: the options to apply to the update operation
returns: a Observable with a single element the UpdateResult

def updateOne(filter: Bson, update: Bson): Observable[UpdateResult]

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 { @code 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 { @code Codec} is registered
returns: a Observable with a single element the UpdateResult

final def wait(): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

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

Create a new MongoCollection instance with a different codec registry.

codecRegistry: the new { @link org.bson.codecs.configuration.CodecRegistry} for the collection
returns: a new MongoCollection instance with the different codec registry

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..

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

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

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

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

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

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

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

lazy val writeConcern: WriteConcern

Get the write concern for the MongoDatabase.

returns: the { @link com.mongodb.WriteConcern}

Packages

Driver structure

MongoCollection

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

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Driver structure

MongoCollection 

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

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

MongoCollection