Class: VertxMongo::MongoClient

Inherits:
Object
  • Object
show all
Defined in:
/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb

Overview

A Vert.x service used to interact with MongoDB server instances.

Some of the operations might change _id field of passed document.

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (::VertxMongo::MongoClient) create_non_shared(vertx = nil, config = nil)

Create a Mongo client which maintains its own data source.

Parameters:

  • vertx (::Vertx::Vertx) (defaults to: nil)
    the Vert.x instance
  • config (Hash{String => Object}) (defaults to: nil)
    the configuration

Returns:

Raises:

  • (ArgumentError)


23
24
25
26
27
28
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 23

def self.create_non_shared(vertx=nil,config=nil)
  if vertx.class.method_defined?(:j_del) && config.class == Hash && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtMongo::MongoClient.java_method(:createNonShared, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxCoreJson::JsonObject.java_class]).call(vertx.j_del,::Vertx::Util::Utils.to_json_object(config)),::VertxMongo::MongoClient)
  end
  raise ArgumentError, "Invalid arguments when calling create_non_shared(vertx,config)"
end

+ (::VertxMongo::MongoClient) create_shared(vertx = nil, config = nil, dataSourceName = nil)

Create a Mongo client which shares its data source with any other Mongo clients created with the same data source name

Parameters:

  • vertx (::Vertx::Vertx) (defaults to: nil)
    the Vert.x instance
  • config (Hash{String => Object}) (defaults to: nil)
    the configuration
  • dataSourceName (String) (defaults to: nil)
    the data source name

Returns:

Raises:

  • (ArgumentError)


35
36
37
38
39
40
41
42
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 35

def self.create_shared(vertx=nil,config=nil,dataSourceName=nil)
  if vertx.class.method_defined?(:j_del) && config.class == Hash && !block_given? && dataSourceName == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtMongo::MongoClient.java_method(:createShared, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxCoreJson::JsonObject.java_class]).call(vertx.j_del,::Vertx::Util::Utils.to_json_object(config)),::VertxMongo::MongoClient)
  elsif vertx.class.method_defined?(:j_del) && config.class == Hash && dataSourceName.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtMongo::MongoClient.java_method(:createShared, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::java.lang.String.java_class]).call(vertx.j_del,::Vertx::Util::Utils.to_json_object(config),dataSourceName),::VertxMongo::MongoClient)
  end
  raise ArgumentError, "Invalid arguments when calling create_shared(vertx,config,dataSourceName)"
end

Instance Method Details

- (void) close

This method returns an undefined value.

Close the client and release its resources

Raises:

  • (ArgumentError)


467
468
469
470
471
472
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 467

def close
  if !block_given?
    return @j_del.java_method(:close, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling close()"
end

- (self) count(collection = nil, query = nil) { ... }

Count matching documents in a collection.

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents

Yields:

  • will be provided with the number of matching documents

Returns:

  • (self)

Raises:

  • (ArgumentError)


285
286
287
288
289
290
291
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 285

def count(collection=nil,query=nil)
  if collection.class == String && query.class == Hash && block_given?
    @j_del.java_method(:count, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling count(collection,query)"
end

- (self) create_collection(collectionName = nil) { ... }

Create a new collection

Parameters:

  • collectionName (String) (defaults to: nil)
    the name of the collection

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


396
397
398
399
400
401
402
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 396

def create_collection(collectionName=nil)
  if collectionName.class == String && block_given?
    @j_del.java_method(:createCollection, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(collectionName,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling create_collection(collectionName)"
end

- (self) distinct(collection = nil, fieldName = nil, resultClassname = nil) { ... }

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

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • fieldName (String) (defaults to: nil)
    the field name
  • resultClassname (String) (defaults to: nil)

Yields:

  • will be provided with array of values.

Returns:

  • (self)

Raises:

  • (ArgumentError)


443
444
445
446
447
448
449
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 443

def distinct(collection=nil,fieldName=nil,resultClassname=nil)
  if collection.class == String && fieldName.class == String && resultClassname.class == String && block_given?
    @j_del.java_method(:distinct, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,fieldName,resultClassname,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling distinct(collection,fieldName,resultClassname)"
end

- (self) distinct_batch(collection = nil, fieldName = nil, resultClassname = nil) { ... }

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: 1).

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • fieldName (String) (defaults to: nil)
    the field name
  • resultClassname (String) (defaults to: nil)

Yields:

  • will be provided with each found value

Returns:

  • (self)

Raises:

  • (ArgumentError)


458
459
460
461
462
463
464
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 458

def distinct_batch(collection=nil,fieldName=nil,resultClassname=nil)
  if collection.class == String && fieldName.class == String && resultClassname.class == String && block_given?
    @j_del.java_method(:distinctBatch, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,fieldName,resultClassname,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling distinct_batch(collection,fieldName,resultClassname)"
end

- (self) drop_collection(collection = nil) { ... }

Drop a collection

Parameters:

  • collection (String) (defaults to: nil)
    the collection

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


417
418
419
420
421
422
423
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 417

def drop_collection(collection=nil)
  if collection.class == String && block_given?
    @j_del.java_method(:dropCollection, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling drop_collection(collection)"
end

- (self) find(collection = nil, query = nil) { ... }

Find matching documents in the specified collection

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents

Yields:

  • will be provided with list of documents

Returns:

  • (self)

Raises:

  • (ArgumentError)


218
219
220
221
222
223
224
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 218

def find(collection=nil,query=nil)
  if collection.class == String && query.class == Hash && block_given?
    @j_del.java_method(:find, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result.to_a.map { |elt| elt != nil ? JSON.parse(elt.encode) : nil } : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling find(collection,query)"
end

- (self) find_batch(collection = nil, query = nil) { ... }

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

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents

Yields:

  • will be provided with each found document

Returns:

  • (self)

Raises:

  • (ArgumentError)


231
232
233
234
235
236
237
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 231

def find_batch(collection=nil,query=nil)
  if collection.class == String && query.class == Hash && block_given?
    @j_del.java_method(:findBatch, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling find_batch(collection,query)"
end

- (self) find_batch_with_options(collection = nil, query = nil, options = nil) { ... }

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

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents
  • options (Hash) (defaults to: nil)
    options to configure the find

Yields:

  • will be provided with each found document

Returns:

  • (self)

Raises:

  • (ArgumentError)


258
259
260
261
262
263
264
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 258

def find_batch_with_options(collection=nil,query=nil,options=nil)
  if collection.class == String && query.class == Hash && options.class == Hash && block_given?
    @j_del.java_method(:findBatchWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::FindOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),Java::IoVertxExtMongo::FindOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling find_batch_with_options(collection,query,options)"
end

- (self) find_one(collection = nil, query = nil, fields = nil) { ... }

Find a single matching document in the specified collection

This operation might change _id field of query parameter

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    the query used to match the document
  • fields (Hash{String => Object}) (defaults to: nil)
    the fields

Yields:

  • will be provided with the document, if any

Returns:

  • (self)

Raises:

  • (ArgumentError)


273
274
275
276
277
278
279
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 273

def find_one(collection=nil,query=nil,fields=nil)
  if collection.class == String && query.class == Hash && fields.class == Hash && block_given?
    @j_del.java_method(:findOne, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(fields),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling find_one(collection,query,fields)"
end

- (self) find_with_options(collection = nil, query = nil, options = nil) { ... }

Find matching documents in the specified collection, specifying options

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents
  • options (Hash) (defaults to: nil)
    options to configure the find

Yields:

  • will be provided with list of documents

Returns:

  • (self)

Raises:

  • (ArgumentError)


244
245
246
247
248
249
250
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 244

def find_with_options(collection=nil,query=nil,options=nil)
  if collection.class == String && query.class == Hash && options.class == Hash && block_given?
    @j_del.java_method(:findWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::FindOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),Java::IoVertxExtMongo::FindOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result.to_a.map { |elt| elt != nil ? JSON.parse(elt.encode) : nil } : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling find_with_options(collection,query,options)"
end

- (self) get_collections { ... }

Get a list of all collections in the database.

Yields:

  • will be called with a list of collections.

Returns:

  • (self)

Raises:

  • (ArgumentError)


406
407
408
409
410
411
412
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 406

def get_collections
  if block_given?
    @j_del.java_method(:getCollections, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result.to_a.map { |elt| elt } : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling get_collections()"
end

- (self) insert(collection = nil, document = nil) { ... }

Insert a document in the specified collection

This operation might change _id field of document parameter

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • document (Hash{String => Object}) (defaults to: nil)
    the document

Yields:

  • result handler will be provided with the id if document didn't already have one

Returns:

  • (self)

Raises:

  • (ArgumentError)


79
80
81
82
83
84
85
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 79

def insert(collection=nil,document=nil)
  if collection.class == String && document.class == Hash && block_given?
    @j_del.java_method(:insert, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(document),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling insert(collection,document)"
end

- (self) insert_with_options(collection = nil, document = nil, writeOption = nil) { ... }

Insert a document in the specified collection with the specified write option

This operation might change _id field of document parameter

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • document (Hash{String => Object}) (defaults to: nil)
    the document
  • writeOption (:ACKNOWLEDGED, :UNACKNOWLEDGED, :FSYNCED, :JOURNALED, :REPLICA_ACKNOWLEDGED, :MAJORITY) (defaults to: nil)
    the write option to use

Yields:

  • result handler will be provided with the id if document didn't already have one

Returns:

  • (self)

Raises:

  • (ArgumentError)


94
95
96
97
98
99
100
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 94

def insert_with_options(collection=nil,document=nil,writeOption=nil)
  if collection.class == String && document.class == Hash && writeOption.class == Symbol && block_given?
    @j_del.java_method(:insertWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::WriteOption.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(document),Java::IoVertxExtMongo::WriteOption.valueOf(writeOption),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling insert_with_options(collection,document,writeOption)"
end

- (self) remove(collection = nil, query = nil) { ... }

Remove matching documents from a collection

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


297
298
299
300
301
302
303
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 297

def remove(collection=nil,query=nil)
  if collection.class == String && query.class == Hash && block_given?
    @j_del.java_method(:remove, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling remove(collection,query)"
end

- (self) remove_document(collection = nil, query = nil) { ... }

Remove a single matching document from a collection and return the handler with MongoClientDeleteResult result

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match document

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


359
360
361
362
363
364
365
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 359

def remove_document(collection=nil,query=nil)
  if collection.class == String && query.class == Hash && block_given?
    @j_del.java_method(:removeDocument, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.toJson.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling remove_document(collection,query)"
end

- (self) remove_document_with_options(collection = nil, query = nil, writeOption = nil) { ... }

Remove a single matching document from a collection with the specified write option and return the handler with MongoClientDeleteResult result

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match document
  • writeOption (:ACKNOWLEDGED, :UNACKNOWLEDGED, :FSYNCED, :JOURNALED, :REPLICA_ACKNOWLEDGED, :MAJORITY) (defaults to: nil)
    the write option to use

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


385
386
387
388
389
390
391
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 385

def remove_document_with_options(collection=nil,query=nil,writeOption=nil)
  if collection.class == String && query.class == Hash && writeOption.class == Symbol && block_given?
    @j_del.java_method(:removeDocumentWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::WriteOption.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),Java::IoVertxExtMongo::WriteOption.valueOf(writeOption),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.toJson.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling remove_document_with_options(collection,query,writeOption)"
end

- (self) remove_documents(collection = nil, query = nil) { ... }

Remove matching documents from a collection and return the handler with MongoClientDeleteResult result

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


309
310
311
312
313
314
315
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 309

def remove_documents(collection=nil,query=nil)
  if collection.class == String && query.class == Hash && block_given?
    @j_del.java_method(:removeDocuments, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.toJson.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling remove_documents(collection,query)"
end

- (self) remove_documents_with_options(collection = nil, query = nil, writeOption = nil) { ... }

Remove matching documents from a collection with the specified write option and return the handler with MongoClientDeleteResult result

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents
  • writeOption (:ACKNOWLEDGED, :UNACKNOWLEDGED, :FSYNCED, :JOURNALED, :REPLICA_ACKNOWLEDGED, :MAJORITY) (defaults to: nil)
    the write option to use

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


335
336
337
338
339
340
341
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 335

def remove_documents_with_options(collection=nil,query=nil,writeOption=nil)
  if collection.class == String && query.class == Hash && writeOption.class == Symbol && block_given?
    @j_del.java_method(:removeDocumentsWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::WriteOption.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),Java::IoVertxExtMongo::WriteOption.valueOf(writeOption),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.toJson.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling remove_documents_with_options(collection,query,writeOption)"
end

- (self) remove_one(collection = nil, query = nil) { ... }

Remove a single matching document from a collection

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match document

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


347
348
349
350
351
352
353
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 347

def remove_one(collection=nil,query=nil)
  if collection.class == String && query.class == Hash && block_given?
    @j_del.java_method(:removeOne, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling remove_one(collection,query)"
end

- (self) remove_one_with_options(collection = nil, query = nil, writeOption = nil) { ... }

Remove a single matching document from a collection with the specified write option

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match document
  • writeOption (:ACKNOWLEDGED, :UNACKNOWLEDGED, :FSYNCED, :JOURNALED, :REPLICA_ACKNOWLEDGED, :MAJORITY) (defaults to: nil)
    the write option to use

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


372
373
374
375
376
377
378
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 372

def remove_one_with_options(collection=nil,query=nil,writeOption=nil)
  if collection.class == String && query.class == Hash && writeOption.class == Symbol && block_given?
    @j_del.java_method(:removeOneWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::WriteOption.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),Java::IoVertxExtMongo::WriteOption.valueOf(writeOption),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling remove_one_with_options(collection,query,writeOption)"
end

- (self) remove_with_options(collection = nil, query = nil, writeOption = nil) { ... }

Remove matching documents from a collection with the specified write option

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match documents
  • writeOption (:ACKNOWLEDGED, :UNACKNOWLEDGED, :FSYNCED, :JOURNALED, :REPLICA_ACKNOWLEDGED, :MAJORITY) (defaults to: nil)
    the write option to use

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


322
323
324
325
326
327
328
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 322

def remove_with_options(collection=nil,query=nil,writeOption=nil)
  if collection.class == String && query.class == Hash && writeOption.class == Symbol && block_given?
    @j_del.java_method(:removeWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::WriteOption.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),Java::IoVertxExtMongo::WriteOption.valueOf(writeOption),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling remove_with_options(collection,query,writeOption)"
end

- (self) replace(collection = nil, query = nil, replace = nil) { ... }

Replace matching documents in the specified collection

This operation might change _id field of replace parameter

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match the documents
  • replace (Hash{String => Object}) (defaults to: nil)
    all matching documents will be replaced with this

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


163
164
165
166
167
168
169
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 163

def replace(collection=nil,query=nil,replace=nil)
  if collection.class == String && query.class == Hash && replace.class == Hash && block_given?
    @j_del.java_method(:replace, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(replace),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling replace(collection,query,replace)"
end

- (self) replace_documents(collection = nil, query = nil, replace = nil) { ... }

Replace matching documents in the specified collection and return the handler with MongoClientUpdateResult result

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match the documents
  • replace (Hash{String => Object}) (defaults to: nil)
    all matching documents will be replaced with this

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


176
177
178
179
180
181
182
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 176

def replace_documents(collection=nil,query=nil,replace=nil)
  if collection.class == String && query.class == Hash && replace.class == Hash && block_given?
    @j_del.java_method(:replaceDocuments, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(replace),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.toJson.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling replace_documents(collection,query,replace)"
end

- (self) replace_documents_with_options(collection = nil, query = nil, replace = nil, options = nil) { ... }

Replace matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match the documents
  • replace (Hash{String => Object}) (defaults to: nil)
    all matching documents will be replaced with this
  • options (Hash) (defaults to: nil)
    options to configure the replace

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


206
207
208
209
210
211
212
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 206

def replace_documents_with_options(collection=nil,query=nil,replace=nil,options=nil)
  if collection.class == String && query.class == Hash && replace.class == Hash && options.class == Hash && block_given?
    @j_del.java_method(:replaceDocumentsWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::UpdateOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(replace),Java::IoVertxExtMongo::UpdateOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.toJson.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling replace_documents_with_options(collection,query,replace,options)"
end

- (self) replace_with_options(collection = nil, query = nil, replace = nil, options = nil) { ... }

Replace matching documents in the specified collection, specifying options

This operation might change _id field of replace parameter

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match the documents
  • replace (Hash{String => Object}) (defaults to: nil)
    all matching documents will be replaced with this
  • options (Hash) (defaults to: nil)
    options to configure the replace

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


192
193
194
195
196
197
198
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 192

def replace_with_options(collection=nil,query=nil,replace=nil,options=nil)
  if collection.class == String && query.class == Hash && replace.class == Hash && options.class == Hash && block_given?
    @j_del.java_method(:replaceWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::UpdateOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(replace),Java::IoVertxExtMongo::UpdateOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling replace_with_options(collection,query,replace,options)"
end

- (self) run_command(commandName = nil, command = nil) { ... }

Run an arbitrary MongoDB command.

Parameters:

  • commandName (String) (defaults to: nil)
    the name of the command
  • command (Hash{String => Object}) (defaults to: nil)
    the command

Yields:

  • will be called with the result.

Returns:

  • (self)

Raises:

  • (ArgumentError)


429
430
431
432
433
434
435
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 429

def run_command(commandName=nil,command=nil)
  if commandName.class == String && command.class == Hash && block_given?
    @j_del.java_method(:runCommand, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(commandName,::Vertx::Util::Utils.to_json_object(command),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling run_command(commandName,command)"
end

- (self) save(collection = nil, document = nil) { ... }

Save a document in the specified collection

This operation might change _id field of document parameter

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • document (Hash{String => Object}) (defaults to: nil)
    the document

Yields:

  • result handler will be provided with the id if document didn't already have one

Returns:

  • (self)

Raises:

  • (ArgumentError)


50
51
52
53
54
55
56
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 50

def save(collection=nil,document=nil)
  if collection.class == String && document.class == Hash && block_given?
    @j_del.java_method(:save, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(document),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling save(collection,document)"
end

- (self) save_with_options(collection = nil, document = nil, writeOption = nil) { ... }

Save a document in the specified collection with the specified write option

This operation might change _id field of document parameter

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • document (Hash{String => Object}) (defaults to: nil)
    the document
  • writeOption (:ACKNOWLEDGED, :UNACKNOWLEDGED, :FSYNCED, :JOURNALED, :REPLICA_ACKNOWLEDGED, :MAJORITY) (defaults to: nil)
    the write option to use

Yields:

  • result handler will be provided with the id if document didn't already have one

Returns:

  • (self)

Raises:

  • (ArgumentError)


65
66
67
68
69
70
71
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 65

def save_with_options(collection=nil,document=nil,writeOption=nil)
  if collection.class == String && document.class == Hash && writeOption.class == Symbol && block_given?
    @j_del.java_method(:saveWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::WriteOption.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(document),Java::IoVertxExtMongo::WriteOption.valueOf(writeOption),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling save_with_options(collection,document,writeOption)"
end

- (self) update(collection = nil, query = nil, update = nil) { ... }

Update matching documents in the specified collection

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match the documents
  • update (Hash{String => Object}) (defaults to: nil)
    used to describe how the documents will be updated

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


107
108
109
110
111
112
113
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 107

def update(collection=nil,query=nil,update=nil)
  if collection.class == String && query.class == Hash && update.class == Hash && block_given?
    @j_del.java_method(:update, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(update),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling update(collection,query,update)"
end

- (self) update_collection(collection = nil, query = nil, update = nil) { ... }

Update matching documents in the specified collection and return the handler with MongoClientUpdateResult result

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match the documents
  • update (Hash{String => Object}) (defaults to: nil)
    used to describe how the documents will be updated

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


120
121
122
123
124
125
126
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 120

def update_collection(collection=nil,query=nil,update=nil)
  if collection.class == String && query.class == Hash && update.class == Hash && block_given?
    @j_del.java_method(:updateCollection, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(update),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.toJson.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling update_collection(collection,query,update)"
end

- (self) update_collection_with_options(collection = nil, query = nil, update = nil, options = nil) { ... }

Update matching documents in the specified collection, specifying options and return the handler with MongoClientUpdateResult result

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match the documents
  • update (Hash{String => Object}) (defaults to: nil)
    used to describe how the documents will be updated
  • options (Hash) (defaults to: nil)
    options to configure the update

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


148
149
150
151
152
153
154
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 148

def update_collection_with_options(collection=nil,query=nil,update=nil,options=nil)
  if collection.class == String && query.class == Hash && update.class == Hash && options.class == Hash && block_given?
    @j_del.java_method(:updateCollectionWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::UpdateOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(update),Java::IoVertxExtMongo::UpdateOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.toJson.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling update_collection_with_options(collection,query,update,options)"
end

- (self) update_with_options(collection = nil, query = nil, update = nil, options = nil) { ... }

Update matching documents in the specified collection, specifying options

Parameters:

  • collection (String) (defaults to: nil)
    the collection
  • query (Hash{String => Object}) (defaults to: nil)
    query used to match the documents
  • update (Hash{String => Object}) (defaults to: nil)
    used to describe how the documents will be updated
  • options (Hash) (defaults to: nil)
    options to configure the update

Yields:

  • will be called when complete

Returns:

  • (self)

Raises:

  • (ArgumentError)


134
135
136
137
138
139
140
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mongo/mongo_client.rb', line 134

def update_with_options(collection=nil,query=nil,update=nil,options=nil)
  if collection.class == String && query.class == Hash && update.class == Hash && options.class == Hash && block_given?
    @j_del.java_method(:updateWithOptions, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxExtMongo::UpdateOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(collection,::Vertx::Util::Utils.to_json_object(query),::Vertx::Util::Utils.to_json_object(update),Java::IoVertxExtMongo::UpdateOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling update_with_options(collection,query,update,options)"
end