org.litote.kmongo

Class MongoCollectionsKt

org.litote.kmongo.MongoCollectionsKt

public class MongoCollectionsKt

Constructor Detail

MongoCollectionsKt

public MongoCollectionsKt()

Method Detail

withKMongo

@NotNull
public static <T> com.mongodb.client.MongoCollection<T> withKMongo(@NotNull
                                                                            com.mongodb.client.MongoCollection<T> $this$withKMongo)

Returns a MongoCollection with a KMongo codec.

countDocuments

public static <T> long countDocuments(@NotNull
                                      com.mongodb.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

options - the options describing the count

Returns:

the number of documents in the collection

find

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

Finds all documents in the collection.

Parameters:

filter - the query filter

Returns:

the find iterable interface

find

@NotNull
public static <T> com.mongodb.client.FindIterable<T> find(@NotNull
                                                                   com.mongodb.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

@Nullable
public static <T> T findOne(@NotNull
                                      com.mongodb.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

Returns:

the first item returned or null

findOne

@Nullable
public static <T> T findOne(@NotNull
                                      com.mongodb.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

Returns:

the first item returned or null

findOne

@Nullable
public static <T> T findOne(@NotNull
                                      com.mongodb.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

Returns:

the first item returned or null

findOneById

@Nullable
public static <T> T findOneById(@NotNull
                                          com.mongodb.client.MongoCollection<T> $this$findOneById,
                                          @NotNull
                                          java.lang.Object id)

Finds the document that match the id parameter.

Parameters:

id - the object id

Returns:

the first item returned or null

deleteOne

@NotNull
public static <T> com.mongodb.client.result.DeleteResult deleteOne(@NotNull
                                                                            com.mongodb.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

Returns:

the result of the remove one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete 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

deleteOne

@NotNull
public static <T> com.mongodb.client.result.DeleteResult deleteOne(@NotNull
                                                                            com.mongodb.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

Returns:

the result of the remove one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete 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

deleteOneById

@NotNull
public static <T> com.mongodb.client.result.DeleteResult deleteOneById(@NotNull
                                                                                com.mongodb.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

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete 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

deleteMany

@NotNull
public static <T> com.mongodb.client.result.DeleteResult deleteMany(@NotNull
                                                                             com.mongodb.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

Returns:

the result of the remove many operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete 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

deleteMany

@NotNull
public static <T> com.mongodb.client.result.DeleteResult deleteMany(@NotNull
                                                                             com.mongodb.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:

filters - the query filters to apply the the delete operation

options - the options to apply to the delete operation

Returns:

the result of the remove many operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the delete 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

save

public static <T> void save(@NotNull
                            com.mongodb.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

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> com.mongodb.client.result.UpdateResult replaceOneById(@NotNull
                                                                                 com.mongodb.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

Returns:

the result of the replace 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> com.mongodb.client.result.UpdateResult replaceOne(@NotNull
                                                                             com.mongodb.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

Returns:

the result of the replace 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

replaceOneWithFilter

@NotNull
public static <T> com.mongodb.client.result.UpdateResult replaceOneWithFilter(@NotNull
                                                                                       com.mongodb.client.MongoCollection<T> $this$replaceOneWithFilter,
                                                                                       @NotNull
                                                                                       org.bson.conversions.Bson filter,
                                                                                       @NotNull
                                                                                       T replacement,
                                                                                       @NotNull
                                                                                       com.mongodb.client.model.ReplaceOptions replaceOptions)

Replace a document in the collection according to the specified arguments. Same than MongoCollection.replaceOne but ensure that any _id present in replacement is removed to avoid MongoWriteException such as: "After applying the update, the (immutable) field '_id' was found to have been altered to _id"

Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.

Parameters:

filter - the query filter to apply the the replace operation

replacement - the replacement document

replaceOptions - the options to apply to the replace operation

Returns:

the result of the replace one operation

Throws:

com.mongodb.MongoWriteException - if the write failed due some other failure specific to the replace 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:

replacement

updateOne

@NotNull
public static <T> com.mongodb.client.result.UpdateResult updateOne(@NotNull
                                                                            com.mongodb.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

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> com.mongodb.client.result.UpdateResult updateOne(@NotNull
                                                                            com.mongodb.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

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

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> com.mongodb.client.result.UpdateResult updateOne(@NotNull
                                                                            com.mongodb.client.MongoCollection<T> $this$updateOne,
                                                                            @NotNull
                                                                            org.bson.conversions.Bson filter,
                                                                            @NotNull
                                                                            org.litote.kmongo.SetTo[] updates,
                                                                            @NotNull
                                                                            com.mongodb.client.model.UpdateOptions updateOptions)

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

Parameters:

filter - a document describing the query filter

updates - the setTo describing the updates

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> com.mongodb.client.result.UpdateResult updateOneById(@NotNull
                                                                                com.mongodb.client.MongoCollection<T> $this$updateOneById,
                                                                                @NotNull
                                                                                java.lang.Object id,
                                                                                @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:

id - the object id

update - the update object

options - the options to apply to the update operation

updateOnlyNotNullProperties - if true do not change null properties

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> com.mongodb.client.result.UpdateResult updateMany(@NotNull
                                                                             com.mongodb.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, which may not be null.

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

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> com.mongodb.client.result.UpdateResult updateMany(@NotNull
                                                                             com.mongodb.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

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

findOneAndDelete

@Nullable
public static <T> T findOneAndDelete(@NotNull
                                               com.mongodb.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

Returns:

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

findOneAndReplace

@Nullable
public static <T> T findOneAndReplace(@NotNull
                                                com.mongodb.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

Returns:

the document that was replaced. 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

@Nullable
public static <T> T findOneAndUpdate(@NotNull
                                               com.mongodb.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, which may not be null.

update - a document describing the update, which may not be null. 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> java.lang.String createIndex(@NotNull
                                                        com.mongodb.client.MongoCollection<T> $this$createIndex,
                                                        @NotNull
                                                        java.lang.String keys,
                                                        @NotNull
                                                        com.mongodb.client.model.IndexOptions indexOptions)

Create an index with the given keys and options.

Parameters:

keys - an object describing the index key(s), which may not be null.

indexOptions - the options for the index

Returns:

the index name

ensureIndex

@NotNull
public static <T> java.lang.String ensureIndex(@NotNull
                                                        com.mongodb.client.MongoCollection<T> $this$ensureIndex,
                                                        @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), which may not be null.

indexOptions - the options for the index

Returns:

the index name

ensureIndex

@NotNull
public static <T> java.lang.String ensureIndex(@NotNull
                                                        com.mongodb.client.MongoCollection<T> $this$ensureIndex,
                                                        @NotNull
                                                        kotlin.reflect.KProperty[] properties,
                                                        @NotNull
                                                        com.mongodb.client.model.IndexOptions indexOptions)

Create an ascending 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

ensureUniqueIndex

@NotNull
public static <T> java.lang.String ensureUniqueIndex(@NotNull
                                                              com.mongodb.client.MongoCollection<T> $this$ensureUniqueIndex,
                                                              @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:

indexOptions - the options for the index

Returns:

the index name

ensureIndex

@NotNull
public static <T> java.lang.String ensureIndex(@NotNull
                                                        com.mongodb.client.MongoCollection<T> $this$ensureIndex,
                                                        @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:

keys - an object describing the index key(s), which may not be null.

indexOptions - the options for the index

Returns:

the index name

dropIndex

public static <T> void dropIndex(@NotNull
                                 com.mongodb.client.MongoCollection<T> $this$dropIndex,
                                 @NotNull
                                 java.lang.String keys)

Drops the index given the keys used to create it.

Parameters:

keys - the keys of the index to remove

dropIndexOfKeys

public static <T> void dropIndexOfKeys(@NotNull
                                       com.mongodb.client.MongoCollection<T> $this$dropIndexOfKeys,
                                       @NotNull
                                       java.lang.String json)

Drops the index given the keys used to create it.

Parameters:

json - the keys of the index to remove