org.litote.kmongo.MapReduceIterables.kt Maven / Gradle / Ivy
/*
* 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.client.MapReduceIterable
import org.litote.kmongo.util.KMongoUtil
/**
* Sets the global variables that are accessible in the map, reduce and finalize functions.
*
* @param scope the global variables that are accessible in the map, reduce and finalize functions.
* @return this
*/
fun MapReduceIterable.scope(scope: String): MapReduceIterable = scope(KMongoUtil.toBson(scope))
/**
* Sets the sort criteria to apply to the query.
*
* @param sort the sort criteria, which may be null
* @return this
*/
fun MapReduceIterable.sort(sort: String): MapReduceIterable = sort(KMongoUtil.toBson(sort))
/**
* Sets the query filter to apply to the query.
*
* @param filter the filter to apply to the query
* @return this
*/
fun MapReduceIterable.filter(filter: String): MapReduceIterable = filter(KMongoUtil.toBson(filter))