org.litote.kmongo.reactivestreams

Class MongoCollectionsKt

org.litote.kmongo.reactivestreams.MongoCollectionsKt

public class MongoCollectionsKt

Constructor Detail

MongoCollectionsKt

public MongoCollectionsKt()

Method Detail

countDocuments

@NotNull
public static <T> org.reactivestreams.Publisher<java.lang.Long> countDocuments(@NotNull
                                                                                        com.mongodb.reactivestreams.client.MongoCollection<T> $this$countDocuments,
                                                                                        @NotNull
                                                                                        java.lang.String filter)

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

Parameters:

filter - the query filter

countDocuments

@NotNull
public static <T> org.reactivestreams.Publisher<java.lang.Long> countDocuments(@NotNull
                                                                                        com.mongodb.reactivestreams.client.MongoCollection<T> $this$countDocuments,
                                                                                        @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

find

@NotNull
public static <T> com.mongodb.reactivestreams.client.FindPublisher<T> find(@NotNull
                                                                                    com.mongodb.reactivestreams.client.MongoCollection<T> $this$find,
                                                                                    @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.reactivestreams.client.FindPublisher<T> find(@NotNull
                                                                                    com.mongodb.reactivestreams.client.MongoCollection<T> $this$find,
                                                                                    @NotNull
                                                                                    org.bson.conversions.Bson... filters)

Finds all documents in the collection.

Parameters:

filters - the query filters

Returns:

the find iterable interface

findOne

@NotNull
public static <T> org.reactivestreams.Publisher<T> findOne(@NotNull
                                                                    com.mongodb.reactivestreams.client.MongoCollection<T> $this$findOne,
                                                                    @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> org.reactivestreams.Publisher<T> findOne(@NotNull
                                                                    com.mongodb.reactivestreams.client.MongoCollection<T> $this$findOne,
                                                                    @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> org.reactivestreams.Publisher<T> findOne(@NotNull
                                                                    com.mongodb.reactivestreams.client.MongoCollection<T> $this$findOne,
                                                                    @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> org.reactivestreams.Publisher<T> findOneById(@NotNull
                                                                        com.mongodb.reactivestreams.client.MongoCollection<T> $this$findOneById,
                                                                        @NotNull
                                                                        java.lang.Object id)

Finds the document that match the id parameter.

Parameters:

id - the object id

deleteOne

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.DeleteResult> deleteOne(@NotNull
                                                                                                           com.mongodb.reactivestreams.client.MongoCollection<T> $this$deleteOne,
                                                                                                           @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

deleteOne

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.DeleteResult> deleteOne(@NotNull
                                                                                                           com.mongodb.reactivestreams.client.MongoCollection<T> $this$deleteOne,
                                                                                                           @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 filters to apply the the delete operation

deleteOneById

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.DeleteResult> deleteOneById(@NotNull
                                                                                                               com.mongodb.reactivestreams.client.MongoCollection<T> $this$deleteOneById,
                                                                                                               @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

deleteMany

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.DeleteResult> deleteMany(@NotNull
                                                                                                            com.mongodb.reactivestreams.client.MongoCollection<T> $this$deleteMany,
                                                                                                            @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

deleteMany

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.DeleteResult> deleteMany(@NotNull
                                                                                                            com.mongodb.reactivestreams.client.MongoCollection<T> $this$deleteMany,
                                                                                                            @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:

options - the options to apply to the delete operation

save

@NotNull
public static <T> org.reactivestreams.Publisher<?> save(@NotNull
                                                                 com.mongodb.reactivestreams.client.MongoCollection<T> $this$save,
                                                                 @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

See Also:

replaceOneById

replaceOneById

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> replaceOneById(@NotNull
                                                                                                                com.mongodb.reactivestreams.client.MongoCollection<T> $this$replaceOneById,
                                                                                                                @NotNull
                                                                                                                java.lang.Object id,
                                                                                                                @NotNull
                                                                                                                T replacement)

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

Parameters:

id - the object id

replacement - the replacement document

replaceOneById

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> replaceOneById(@NotNull
                                                                                                                com.mongodb.reactivestreams.client.MongoCollection<T> $this$replaceOneById,
                                                                                                                @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

replaceOneWithoutId

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> replaceOneWithoutId(@NotNull
                                                                                                                     com.mongodb.reactivestreams.client.MongoCollection<T> $this$replaceOneWithoutId,
                                                                                                                     @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. The id of the provided document is not used, in order to avoid updated id error. You may have to use UpdateResult.getUpsertedId in order to retrieve the generated id.

Parameters:

filter - the query filter to apply to the replace operation

replacement - the replacement document

options - the options to apply to the replace operation

replaceOne

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> replaceOne(@NotNull
                                                                                                            com.mongodb.reactivestreams.client.MongoCollection<T> $this$replaceOne,
                                                                                                            @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

updateOne

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> updateOne(@NotNull
                                                                                                           com.mongodb.reactivestreams.client.MongoCollection<T> $this$updateOne,
                                                                                                           @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

updateOne

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> updateOne(@NotNull
                                                                                                           com.mongodb.reactivestreams.client.MongoCollection<T> $this$updateOne,
                                                                                                           @NotNull
                                                                                                           java.lang.String filter,
                                                                                                           @NotNull
                                                                                                           java.lang.Object update,
                                                                                                           @NotNull
                                                                                                           com.mongodb.client.model.UpdateOptions options,
                                                                                                           boolean updateOnlyNotNullProperties)

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

Parameters:

filter - a document describing the query filter

update - the update object

options - the options to apply to the update operation

updateOnlyNotNullProperties - if true do not change null properties

updateOne

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> updateOne(@NotNull
                                                                                                           com.mongodb.reactivestreams.client.MongoCollection<T> $this$updateOne,
                                                                                                           @NotNull
                                                                                                           org.bson.conversions.Bson filter,
                                                                                                           @NotNull
                                                                                                           java.lang.Object 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

options - the options to apply to the update operation

updateOneById

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> updateOneById(@NotNull
                                                                                                               com.mongodb.reactivestreams.client.MongoCollection<T> $this$updateOneById,
                                                                                                               @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

updateMany

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> updateMany(@NotNull
                                                                                                            com.mongodb.reactivestreams.client.MongoCollection<T> $this$updateMany,
                                                                                                            @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.

updateOptions - the options to apply to the update operation

updateMany

@NotNull
public static <T> org.reactivestreams.Publisher<com.mongodb.client.result.UpdateResult> updateMany(@NotNull
                                                                                                            com.mongodb.reactivestreams.client.MongoCollection<T> $this$updateMany,
                                                                                                            @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, which may not be null.

updates - a document describing the update, which may not be null. The update to apply must include only update operators.

updateOptions - the options to apply to the update operation

findOneAndDelete

@NotNull
public static <T> org.reactivestreams.Publisher<T> findOneAndDelete(@NotNull
                                                                             com.mongodb.reactivestreams.client.MongoCollection<T> $this$findOneAndDelete,
                                                                             @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

findOneAndReplace

@NotNull
public static <T> org.reactivestreams.Publisher<T> findOneAndReplace(@NotNull
                                                                              com.mongodb.reactivestreams.client.MongoCollection<T> $this$findOneAndReplace,
                                                                              @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

findOneAndUpdate

@NotNull
public static <T> org.reactivestreams.Publisher<T> findOneAndUpdate(@NotNull
                                                                             com.mongodb.reactivestreams.client.MongoCollection<T> $this$findOneAndUpdate,
                                                                             @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

createIndex

@NotNull
public static <T> org.reactivestreams.Publisher<java.lang.String> createIndex(@NotNull
                                                                                       com.mongodb.reactivestreams.client.MongoCollection<T> $this$createIndex,
                                                                                       @NotNull
                                                                                       java.lang.String key)

Creates an index.

Parameters:

key - an object describing the index key(s)

createIndex

@NotNull
public static <T> org.reactivestreams.Publisher<java.lang.String> createIndex(@NotNull
                                                                                       com.mongodb.reactivestreams.client.MongoCollection<T> $this$createIndex,
                                                                                       @NotNull
                                                                                       java.lang.String key,
                                                                                       @NotNull
                                                                                       com.mongodb.client.model.IndexOptions options)

Creates an index.

Parameters:

key - an object describing the index key(s)

options - the options for the index

dropIndexOfKeys

@NotNull
public static <T> org.reactivestreams.Publisher<java.lang.Void> dropIndexOfKeys(@NotNull
                                                                                         com.mongodb.reactivestreams.client.MongoCollection<T> $this$dropIndexOfKeys,
                                                                                         @NotNull
                                                                                         java.lang.String keys)

Drops the index given the keys used to create it.

Parameters:

keys - the keys of the index to remove