org.litote.kmongo.rxjava2

Class MongoCollectionsKt

org.litote.kmongo.rxjava2.MongoCollectionsKt

public class MongoCollectionsKt

Method Detail

count

@Deprecated
 @NotNull
public static <T> io.reactivex.Single<java.lang.Long> count(@NotNull
                                                                                  com.mongodb.async.client.MongoCollection<T> $receiver)

Deprecated.

Counts the number of documents

Returns:

count of all collection

count

@Deprecated
 @NotNull
public static <T> io.reactivex.Single<java.lang.Long> count(@NotNull
                                                                                  com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                  @NotNull
                                                                                  java.lang.String filter,
                                                                                  @NotNull
                                                                                  com.mongodb.client.model.CountOptions options)

Deprecated.

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

Parameters:

filter - the query filter

Returns:

count of filtered collection

countDocuments

@NotNull
public static <T> io.reactivex.Single<java.lang.Long> countDocuments(@NotNull
                                                                              com.mongodb.async.client.MongoCollection<T> $receiver)

Counts the number of documents

Returns:

count of all collection

countDocuments

@NotNull
public static <T> io.reactivex.Single<java.lang.Long> countDocuments(@NotNull
                                                                              com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                              @NotNull
                                                                              java.lang.String filter,
                                                                              @NotNull
                                                                              com.mongodb.client.model.CountOptions options)

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

Parameters:

filter - the query filter

Returns:

count of filtered collection

find

@NotNull
public static <T> com.mongodb.async.client.FindIterable<T> find(@NotNull
                                                                         com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                         @NotNull
                                                                         java.lang.String filter)

Finds all documents that match the filter in the collection.

Parameters:

filter - the query filter

Returns:

the find iterable interface

find

@NotNull
public static <T> com.mongodb.async.client.FindIterable<T> find(@NotNull
                                                                         com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                         @NotNull
                                                                         org.bson.conversions.Bson... filters)

Finds all documents that match the filters in the collection.

Parameters:

filters - the query filter

Returns:

the find iterable interface

findOne

@NotNull
public static <T> io.reactivex.Maybe<T> findOne(@NotNull
                                                         com.mongodb.async.client.MongoCollection<T> $receiver,
                                                         @NotNull
                                                         java.lang.String filter)

Finds the first document that match the filter in the collection.

Parameters:

filter - the query filter

findOne

@NotNull
public static <T> io.reactivex.Maybe<T> findOne(@NotNull
                                                         com.mongodb.async.client.MongoCollection<T> $receiver,
                                                         @NotNull
                                                         org.bson.conversions.Bson filter)

Finds the first document that match the filter in the collection.

Parameters:

filter - the query filter

findOne

@NotNull
public static <T> io.reactivex.Maybe<T> findOne(@NotNull
                                                         com.mongodb.async.client.MongoCollection<T> $receiver,
                                                         @NotNull
                                                         org.bson.conversions.Bson... filters)

Finds the first document that match the filters in the collection.

Parameters:

filters - the query filters

findOneById

@NotNull
public static <T> io.reactivex.Maybe<T> findOneById(@NotNull
                                                             com.mongodb.async.client.MongoCollection<T> $receiver,
                                                             @NotNull
                                                             java.lang.Object id)

Finds the document that match the id parameter.

Parameters:

id - the object id

insertMany

@NotNull
public static <T> io.reactivex.Completable insertMany(@NotNull
                                                               com.mongodb.async.client.MongoCollection<T> $receiver,
                                                               @NotNull
                                                               java.util.List<? extends T> documents,
                                                               @NotNull
                                                               com.mongodb.client.model.InsertManyOptions options)

Inserts one or more documents. A call to this method is equivalent to a call to the {@code bulkWrite} method

Parameters:

documents - the documents to insert

options - the options to apply to the operation

Throws:

com.mongodb.MongoBulkWriteException - if there's an exception in the bulk write operation

com.mongodb.MongoException - if the write failed due some other failure

See Also:

com.mongodb.async.client.MongoCollection

insertOne

@NotNull
public static <TDocument> io.reactivex.Completable insertOne(@NotNull
                                                                      com.mongodb.async.client.MongoCollection<TDocument> $receiver,
                                                                      @NotNull
                                                                      TDocument document,
                                                                      @NotNull
                                                                      com.mongodb.client.model.InsertOneOptions options)

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

Parameters:

document - the document to insert

options - the options to apply to the operation

Throws:

com.mongodb.MongoWriteException - returned via the callback

com.mongodb.MongoWriteConcernException - returned via the callback

com.mongodb.MongoCommandException - returned via the callback

com.mongodb.MongoException - returned via the callback

deleteOne

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.DeleteResult> deleteOne(@NotNull
                                                                                                com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                @NotNull
                                                                                                java.lang.String filter)

Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified.

Parameters:

filter - the query filter to apply the the delete operation

Returns:

the result of the remove one operation

Throws:

com.mongodb.MongoWriteException

com.mongodb.MongoWriteConcernException

com.mongodb.MongoException

deleteOne

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.DeleteResult> deleteOne(@NotNull
                                                                                                com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                @NotNull
                                                                                                org.bson.conversions.Bson... filters)

Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified.

Parameters:

filters - the query filter to apply the the delete operation

Returns:

the result of the remove one operation

Throws:

com.mongodb.MongoWriteException

com.mongodb.MongoWriteConcernException

com.mongodb.MongoException

deleteOneById

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.DeleteResult> deleteOneById(@NotNull
                                                                                                    com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                    @NotNull
                                                                                                    java.lang.Object id)

Removes at most one document from the id parameter. If no documents match, the collection is not modified.

Parameters:

id - the object id

Throws:

com.mongodb.MongoWriteException

com.mongodb.MongoWriteConcernException

com.mongodb.MongoException

deleteMany

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.DeleteResult> deleteMany(@NotNull
                                                                                                 com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                 @NotNull
                                                                                                 java.lang.String filter,
                                                                                                 @NotNull
                                                                                                 com.mongodb.client.model.DeleteOptions options)

Removes all documents from the collection that match the given query filter. If no documents match, the collection is not modified.

Parameters:

filter - the query filter to apply the the delete operation

options - the options to apply to the delete operation

Throws:

com.mongodb.MongoWriteException

com.mongodb.MongoWriteConcernException

com.mongodb.MongoException

deleteMany

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.DeleteResult> deleteMany(@NotNull
                                                                                                 com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                 @NotNull
                                                                                                 org.bson.conversions.Bson[] filters,
                                                                                                 @NotNull
                                                                                                 com.mongodb.client.model.DeleteOptions options)

Removes all documents from the collection that match the given query filter. If no documents match, the collection is not modified.

Parameters:

filters - the query filters to apply the the delete operation

options - the options to apply to the delete operation

Throws:

com.mongodb.MongoWriteException

com.mongodb.MongoWriteConcernException

com.mongodb.MongoException

save

@NotNull
public static <T> io.reactivex.Completable save(@NotNull
                                                         com.mongodb.async.client.MongoCollection<T> $receiver,
                                                         @NotNull
                                                         T document)

Save the document. If the document has no id field, or if the document has a null id value, insert the document. Otherwise, call replaceOneById with upsert true.

Parameters:

document - the document to save

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

See Also:

replaceOneById

replaceOneById

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> replaceOneById(@NotNull
                                                                                                     com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                     @NotNull
                                                                                                     java.lang.Object id,
                                                                                                     @NotNull
                                                                                                     T replacement,
                                                                                                     @NotNull
                                                                                                     com.mongodb.client.model.ReplaceOptions options)

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

Parameters:

id - the object id

replacement - the replacement document

options - the options to apply to the replace operation

Returns:

the result of the replace one operation

Throws:

com.mongodb.MongoWriteException - returned via the callback

com.mongodb.MongoWriteConcernException - returned via the callback

com.mongodb.MongoException - returned via the callback

replaceOne

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> replaceOne(@NotNull
                                                                                                 com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                 @NotNull
                                                                                                 java.lang.String filter,
                                                                                                 @NotNull
                                                                                                 T replacement,
                                                                                                 @NotNull
                                                                                                 com.mongodb.client.model.ReplaceOptions options)

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

Parameters:

filter - the query filter to apply to the replace operation

replacement - the replacement document

options - the options to apply to the replace operation

Returns:

the result of the update one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

replaceOne

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> replaceOne(@NotNull
                                                                                                 com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                 @NotNull
                                                                                                 org.bson.conversions.Bson filter,
                                                                                                 @NotNull
                                                                                                 T replacement,
                                                                                                 @NotNull
                                                                                                 com.mongodb.client.model.ReplaceOptions options)

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

Parameters:

filter - the query filter to apply to the replace operation

replacement - the replacement document

options - the options to apply to the replace operation

Returns:

the result of the update one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

updateOne

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> updateOne(@NotNull
                                                                                                com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                @NotNull
                                                                                                java.lang.String filter,
                                                                                                @NotNull
                                                                                                java.lang.String update,
                                                                                                @NotNull
                                                                                                com.mongodb.client.model.UpdateOptions options)

Update a single document in the collection according to the specified arguments.

Parameters:

filter - a document describing the query filter

update - a document describing the update. The update to apply must include only update operators.

options - the options to apply to the update operation

Returns:

the result of the update one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

updateOne

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> updateOne(@NotNull
                                                                                                com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                @NotNull
                                                                                                java.lang.String filter,
                                                                                                @NotNull
                                                                                                T target,
                                                                                                @NotNull
                                                                                                com.mongodb.client.model.UpdateOptions options)

Update a single document in the collection according to the specified arguments.

Parameters:

filter - a document describing the query filter

target - the update object - must have an non null id

options - the options to apply to the update operation

Returns:

the result of the update one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

updateOne

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> updateOne(@NotNull
                                                                                                com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                @NotNull
                                                                                                org.bson.conversions.Bson filter,
                                                                                                @NotNull
                                                                                                T target,
                                                                                                @NotNull
                                                                                                com.mongodb.client.model.UpdateOptions options)

Update a single document in the collection according to the specified arguments.

Parameters:

filter - a document describing the query filter

target - the update object - must have an non null id

options - the options to apply to the update operation

Returns:

the result of the update one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

updateOneById

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> updateOneById(@NotNull
                                                                                                    com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                    @NotNull
                                                                                                    java.lang.Object id,
                                                                                                    @NotNull
                                                                                                    java.lang.Object update,
                                                                                                    @NotNull
                                                                                                    com.mongodb.client.model.UpdateOptions options)

Update a single document in the collection according to the specified arguments.

Parameters:

id - the object id

update - the update object

options - the options to apply to the update operation

Returns:

the result of the update one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

updateMany

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> updateMany(@NotNull
                                                                                                 com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                 @NotNull
                                                                                                 java.lang.String filter,
                                                                                                 @NotNull
                                                                                                 java.lang.String update,
                                                                                                 @NotNull
                                                                                                 com.mongodb.client.model.UpdateOptions updateOptions)

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

Parameters:

filter - a document describing the query filter

update - a document describing the update. The update to apply must include only update operators.

Returns:

the result of the update many operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

updateMany

@NotNull
public static <T> io.reactivex.Maybe<com.mongodb.client.result.UpdateResult> updateMany(@NotNull
                                                                                                 com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                                                 @NotNull
                                                                                                 org.bson.conversions.Bson filter,
                                                                                                 @NotNull
                                                                                                 org.litote.kmongo.SetTo[] updates,
                                                                                                 @NotNull
                                                                                                 com.mongodb.client.model.UpdateOptions updateOptions)

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

Parameters:

filter - a document describing the query filter

updates - a document describing the update. The update to apply must include only update operators.

updateOptions - the options to apply to the update operation

Returns:

the result of the update many operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the update command

com.mongodb.MongoWriteConcernException - if the write failed due being unable to fulfil the write concern

com.mongodb.MongoException - if the write failed due some other failure

findOneAndDelete

@NotNull
public static <T> io.reactivex.Maybe<T> findOneAndDelete(@NotNull
                                                                  com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                  @NotNull
                                                                  java.lang.String filter,
                                                                  @NotNull
                                                                  com.mongodb.client.model.FindOneAndDeleteOptions options)

Atomically find a document and remove it.

Parameters:

filter - the query filter to find the document with

options - the options to apply to the operation

Returns:

the document that was removed. If no documents matched the query filter, then null will be returned

findOneAndReplace

@NotNull
public static <T> io.reactivex.Maybe<T> findOneAndReplace(@NotNull
                                                                   com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                   @NotNull
                                                                   java.lang.String filter,
                                                                   T replacement,
                                                                   @NotNull
                                                                   com.mongodb.client.model.FindOneAndReplaceOptions options)

Atomically find a document and replace it.

Parameters:

filter - the query filter to apply the the replace operation

replacement - the replacement document

options - the options to apply to the operation

Returns:

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

findOneAndUpdate

@NotNull
public static <T> io.reactivex.Maybe<T> findOneAndUpdate(@NotNull
                                                                  com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                  @NotNull
                                                                  java.lang.String filter,
                                                                  @NotNull
                                                                  java.lang.String update,
                                                                  @NotNull
                                                                  com.mongodb.client.model.FindOneAndUpdateOptions options)

Atomically find a document and update it.

Parameters:

filter - a document describing the query filter

update - a document describing the update. The update to apply must include only update operators.

options - the options to apply to the operation

Returns:

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

createIndex

@NotNull
public static <T> io.reactivex.Maybe<java.lang.String> createIndex(@NotNull
                                                                            com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                            @NotNull
                                                                            java.lang.String key,
                                                                            @NotNull
                                                                            com.mongodb.client.model.IndexOptions options)

Creates an index. If successful, the callback will be executed with the name of the created index as the result.

Parameters:

key - an object describing the index key(s)

options - the options for the index

Returns:

the index name

ensureIndex

@NotNull
public static <T> io.reactivex.Completable ensureIndex(@NotNull
                                                                com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                @NotNull
                                                                java.lang.String keys,
                                                                @NotNull
                                                                com.mongodb.client.model.IndexOptions indexOptions)

Create an index with the given keys and options. If the creation of the index is not doable because an index with the same keys but with different IndexOptions already exists, then drop the existing index and create a new one.

Parameters:

indexOptions - the options for the index

Returns:

the index name

See Also:

IndexOptions

ensureIndex

@NotNull
public static <T> io.reactivex.Completable ensureIndex(@NotNull
                                                                com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                @NotNull
                                                                org.bson.conversions.Bson keys,
                                                                @NotNull
                                                                com.mongodb.client.model.IndexOptions indexOptions)

Create an index with the given keys and options. If the creation of the index is not doable because an index with the same keys but with different IndexOptions already exists, then drop the existing index and create a new one.

Parameters:

keys - an object describing the index key(s)

indexOptions - the options for the index

Returns:

the index name

See Also:

IndexOptions

ensureIndex

@NotNull
public static <T> io.reactivex.Completable ensureIndex(@NotNull
                                                                com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                @NotNull
                                                                kotlin.reflect.KProperty[] properties,
                                                                @NotNull
                                                                com.mongodb.client.model.IndexOptions indexOptions)

Create an index with the given keys and options. If the creation of the index is not doable because an index with the same keys but with different IndexOptions already exists, then drop the existing index and create a new one.

Parameters:

properties - the properties, which must contain at least one

indexOptions - the options for the index

Returns:

the index name

See Also:

IndexOptions

ensureUniqueIndex

@NotNull
public static <T> io.reactivex.Completable ensureUniqueIndex(@NotNull
                                                                      com.mongodb.async.client.MongoCollection<T> $receiver,
                                                                      @NotNull
                                                                      kotlin.reflect.KProperty[] properties,
                                                                      @NotNull
                                                                      com.mongodb.client.model.IndexOptions indexOptions)

Create an IndexOptions.unique index with the given keys and options. If the creation of the index is not doable because an index with the same keys but with different IndexOptions already exists, then drop the existing index and create a new one.

Parameters:

properties - the properties, which must contain at least one

indexOptions - the options for the index

Returns:

the index name

See Also:

IndexOptions.unique, IndexOptions

dropIndex

@NotNull
public static <T> io.reactivex.Completable dropIndex(@NotNull
                                                              com.mongodb.async.client.MongoCollection<T> $receiver,
                                                              @NotNull
                                                              java.lang.String keys)

Drops the index given the keys used to create it.

Parameters:

keys - the keys of the index to remove