commonMain.models.Count.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dsl Show documentation

Kotlin-first DSL for writing expressive and typesafe MongoDB queries

The newest version!

/*
 * Copyright (c) 2024, OpenSavvy and contributors.
 *
 * 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 opensavvy.ktmongo.dsl.models

import opensavvy.ktmongo.bson.BsonContext
import opensavvy.ktmongo.dsl.KtMongoDsl
import opensavvy.ktmongo.dsl.expr.FilterExpression
import opensavvy.ktmongo.dsl.expr.FilterOperators
import opensavvy.ktmongo.dsl.options.CountOptions

/**
 * Counting a number of documents in a collection.
 *
 * ### Example
 *
 * ```kotlin
 * users.count({ limit(99) }) {
 *     User::age lt 18
 * }
 * ```
 *
 * @see FilterOperators Filter operators
 * @see CountOptions Options
 */
@KtMongoDsl
class Count private constructor(
	val context: BsonContext,
	val options: CountOptions,
	val filter: FilterOperators,
) {

	constructor(context: BsonContext) : this(context, CountOptions(context), FilterExpression(context))

}