vertx-lang-scala-docs_2.12 3.6.2 API - io.vertx.scala.ext.mongo.MongoClient

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(collection: String, pipeline: JsonArray): ReadStream[JsonObject]

Run aggregate MongoDB command with default AggregateOptions.

Run aggregate MongoDB command with default AggregateOptions. * @param collection the collection

pipeline: aggregation pipeline to be executed

def aggregateWithOptions(collection: String, pipeline: JsonArray, options: AggregateOptions): ReadStream[JsonObject]

Run aggregate MongoDB command.

Run aggregate MongoDB command. * @param collection the collection

pipeline: aggregation pipeline to be executed
options: options to configure the aggregation command see AggregateOptions

final def asInstanceOf[T0]: T0

Definition Classes: Any

def asJava: AnyRef

def bulkWrite(collection: String, operations: Buffer[BulkOperation], resultHandler: Handler[AsyncResult[MongoClientBulkWriteResult]]): MongoClient

Execute a bulk operation.

Execute a bulk operation. Can insert, update, replace, and/or delete multiple documents with one request. * @param collection the collection

operations: the operations to execute
resultHandler: will be called with a MongoClientBulkWriteResult when complete

def bulkWriteFuture(collection: String, operations: Buffer[BulkOperation]): Future[MongoClientBulkWriteResult]

Like bulkWrite but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def bulkWriteWithOptions(collection: String, operations: Buffer[BulkOperation], bulkWriteOptions: BulkWriteOptions, resultHandler: Handler[AsyncResult[MongoClientBulkWriteResult]]): MongoClient

Execute a bulk operation with the specified write options.

Execute a bulk operation with the specified write options. Can insert, update, replace, and/or delete multiple documents with one request. * @param collection the collection

operations: the operations to execute
bulkWriteOptions: the write options see BulkWriteOptions
resultHandler: will be called with a MongoClientBulkWriteResult when complete

def bulkWriteWithOptionsFuture(collection: String, operations: Buffer[BulkOperation], bulkWriteOptions: BulkWriteOptions): Future[MongoClientBulkWriteResult]

Like bulkWriteWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def clone(): AnyRef

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

def close(): Unit

Close the client and release its resources

def count(collection: String, query: JsonObject, resultHandler: Handler[AsyncResult[Long]]): MongoClient

Count matching documents in a collection.

Count matching documents in a collection. * @param collection the collection

query: query used to match documents
resultHandler: will be provided with the number of matching documents

def countFuture(collection: String, query: JsonObject): Future[Long]

Like count but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def createCollection(collectionName: String, resultHandler: Handler[AsyncResult[Unit]]): MongoClient

Create a new collection * @param collectionName the name of the collection

resultHandler: will be called when complete

def createCollectionFuture(collectionName: String): Future[Unit]

Like createCollection but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def createIndex(collection: String, key: JsonObject, resultHandler: Handler[AsyncResult[Unit]]): MongoClient

Creates an index.

Creates an index. * @param collection the collection

key: A document that contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of 1; for descending index, specify a value of -1.
resultHandler: will be called when complete

def createIndexFuture(collection: String, key: JsonObject): Future[Unit]

Like createIndex but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def createIndexWithOptions(collection: String, key: JsonObject, options: IndexOptions, resultHandler: Handler[AsyncResult[Unit]]): MongoClient

Creates an index.

Creates an index. * @param collection the collection

key: A document that contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of 1; for descending index, specify a value of -1.
options: the options for the index see IndexOptions
resultHandler: will be called when complete

def createIndexWithOptionsFuture(collection: String, key: JsonObject, options: IndexOptions): Future[Unit]

Like createIndexWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def distinct(collection: String, fieldName: String, resultClassname: String, resultHandler: Handler[AsyncResult[JsonArray]]): MongoClient

Gets the distinct values of the specified field name.

Gets the distinct values of the specified field name. Return a JsonArray containing distinct values (eg: [ 1 , 89 ]) * @param collection the collection

fieldName: the field name
resultHandler: will be provided with array of values.

def distinctBatch(collection: String, fieldName: String, resultClassname: String): ReadStream[JsonObject]

Gets the distinct values of the specified field name.

Gets the distinct values of the specified field name. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1). * @param collection the collection

fieldName: the field name
returns: a ReadStream emitting json fragments

def distinctBatchWithQuery(collection: String, fieldName: String, resultClassname: String, query: JsonObject, batchSize: Int): ReadStream[JsonObject]

Gets the distinct values of the specified field name filtered by specified query.

Gets the distinct values of the specified field name filtered by specified query. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1). * @param collection the collection

fieldName: the field name
query: the query
batchSize: the number of documents to load in a batch
returns: a ReadStream emitting json fragments

def distinctBatchWithQuery(collection: String, fieldName: String, resultClassname: String, query: JsonObject): ReadStream[JsonObject]

Gets the distinct values of the specified field name filtered by specified query.

Gets the distinct values of the specified field name filtered by specified query. This method use batchCursor for returning each found value. Each value is a json fragment with fieldName key (eg: {"num": 1). * @param collection the collection

fieldName: the field name
query: the query
returns: a ReadStream emitting json fragments

def distinctFuture(collection: String, fieldName: String, resultClassname: String): Future[JsonArray]

Like distinct but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def distinctWithQuery(collection: String, fieldName: String, resultClassname: String, query: JsonObject, resultHandler: Handler[AsyncResult[JsonArray]]): MongoClient

Gets the distinct values of the specified field name filtered by specified query.

Gets the distinct values of the specified field name filtered by specified query. Return a JsonArray containing distinct values (eg: [ 1 , 89 ]) * @param collection the collection

fieldName: the field name
query: the query
resultHandler: will be provided with array of values.

def distinctWithQueryFuture(collection: String, fieldName: String, resultClassname: String, query: JsonObject): Future[JsonArray]

Like distinctWithQuery but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def dropCollection(collection: String, resultHandler: Handler[AsyncResult[Unit]]): MongoClient

Drop a collection * @param collection the collection

resultHandler: will be called when complete

def dropCollectionFuture(collection: String): Future[Unit]

Like dropCollection but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def dropIndex(collection: String, indexName: String, resultHandler: Handler[AsyncResult[Unit]]): MongoClient

Drops the index given its name.

Drops the index given its name. * @param collection the collection

indexName: the name of the index to remove
resultHandler: will be called when complete

def dropIndexFuture(collection: String, indexName: String): Future[Unit]

Like dropIndex but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def finalize(): Unit

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

def find(collection: String, query: JsonObject, resultHandler: Handler[AsyncResult[Buffer[JsonObject]]]): MongoClient

Find matching documents in the specified collection * @param collection the collection

query: query used to match documents
resultHandler: will be provided with list of documents

def findBatch(collection: String, query: JsonObject): ReadStream[JsonObject]

Find matching documents in the specified collection.

Find matching documents in the specified collection. This method use batchCursor for returning each found document. * @param collection the collection

query: query used to match documents
returns: a ReadStream emitting found documents

def findBatchWithOptions(collection: String, query: JsonObject, options: FindOptions): ReadStream[JsonObject]

Find matching documents in the specified collection, specifying options.

Find matching documents in the specified collection, specifying options. This method use batchCursor for returning each found document. * @param collection the collection

query: query used to match documents
options: options to configure the find see FindOptions
returns: a ReadStream emitting found documents

def findFuture(collection: String, query: JsonObject): Future[Buffer[JsonObject]]

Like find but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

def findOne(collection: String, query: JsonObject, fields: Option[JsonObject], resultHandler: Handler[AsyncResult[JsonObject]]): MongoClient

Find a single matching document in the specified collection