org.litote.kmongo.MongoDatabases.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kmongo-core Show documentation
KMongo synchronous client core extensions
There is a newer version: 5.1.0
/*
 * Copyright (C) 2016/2020 Litote
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.litote.kmongo

import com.mongodb.ReadPreference
import com.mongodb.client.MongoCollection
import com.mongodb.client.MongoDatabase
import org.litote.kmongo.util.KMongoUtil
import org.litote.kmongo.util.KMongoUtil.defaultCollectionName

/**
 * Returns a [MongoDatabase] with a KMongo codec.
 */
fun MongoDatabase.withKMongo(): MongoDatabase =
    withCodecRegistry(KMongo.configureRegistry(codecRegistry))

/**
 * Gets a collection.
 *
 * @param collectionName the name of the collection to return
 * @param             the default target type of the collection to return
 * @return the collection
 */
@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
inline fun  MongoDatabase.getCollection(collectionName: String): MongoCollection =
    getCollectionOfName(collectionName)

/**
 * Gets a collection.
 *
 * @param collectionName the name of the collection to return
 * @param             the default target type of the collection to return
 * @return the collection
 */
inline fun  MongoDatabase.getCollectionOfName(collectionName: String): MongoCollection =
    getCollection(collectionName, T::class.java)

/**
 * Gets a collection.
 *
 * @param             the default target type of the collection to return
 *                       - the name of the collection is determined by [defaultCollectionName]
 * @return the collection
 * @see defaultCollectionName
 */
inline fun  MongoDatabase.getCollection(): MongoCollection =
    getCollection(defaultCollectionName(T::class), T::class.java)

/**
 * Executes the given command in the context of the current database with the given read preference.
 *
 * @param command        the command to be run
 * @param readPreference the {@link com.mongodb.ReadPreference} to be used when executing the command
 * @param       the type of the class to use instead of {@code Document}.
 */
inline fun  MongoDatabase.runCommand(command: String, readPreference: ReadPreference): TResult =
    runCommand(KMongoUtil.toBson(command), readPreference, TResult::class.java)

/**
 * Executes the given command in the context of the current database with the given read preference.
 *
 * @param command        the command to be run
 * @param       the type of the class to use instead of {@code Document}.
 */
inline fun  MongoDatabase.runCommand(command: String): TResult =
    runCommand(command, readPreference)