ドライバーアーティファクトのバージョンを管理するには、アプリケーションにJVMドライバーの請求書（BOM）をアプリケーションに追加することをお勧めします。これにより、BOM でカバーされる個々のパッケージのバージョンを指定する必要がなくなり、依存関係の管理が簡素化されます。詳しくは、クイックスタートガイドの「ドライバー請求の追加」ステップを参照してください。

Gradle と Mavenパッケージマネージャーを使用してプロジェクトに拡張依存関係を追加する方法を確認するには、次のタブからを選択します。

Gradle を使用して依存関係を管理している場合は、次のものをbuild.gradle.kts 依存関係リストに追加します。

build. Gradle.kts

implementation("org.mongodb:mongodb-driver-kotlin-extensions")

Maven を使用して依存関係を管理している場合は、次のものをpom.xml 依存関係リストに追加します。

pom.xml

<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>mongodb-driver-kotlin-extensions</artifactId>
</dependency>

After you install the extensions dependency, you can use the extension methods by importing classes and methods from the com.mongodb.kotlin.client.model path. You can mix usage of these methods and the standard builder methods in the same application, as shown in the Aggregates example in this guide.

ビルダの例

このセクションには、拡張機能パッケージのビルダクラスメソッドを使用してデータクラスプロパティを直接使用する方法を示す例えが含まれています。

Tip

データクラスの注釈

拡張ビルダクラスがデータクラスをメソッドを使用する場合、メソッドは bson-kotlin パッケージと bson-kotlinx パッケージのデータクラスの注釈を尊重します。注釈の詳細については、ドキュメントデータ形式: データクラスガイドの「注釈を使用したコンポーネント変換の指定」セクション、およびKotlin直列化ガイドの「データクラスの注釈」セクションを参照してください。

サンプルデータ

このセクションの例では、学校の学生を説明する studentsコレクション内のドキュメントを使用します。studentsコレクション内のドキュメントは、次のKotlinデータクラスによってモデル化されます。

data class Student(
    val name: String,
    val teachers: List<String>,
    val gradeAverage: Double
)

フィルター

Filters ビルダークラスのヘルパーを使用して、データクラスプロパティをクエリできます。このクラスの詳細については、フィルタービルダのガイドを参照してください。

次のコードは、Filters 拡張メソッドを使用して Student データクラスでクエリを実行するさまざまな方法を示しています。

import com.mongodb.kotlin.client.model.Filters.eq
import com.mongodb.kotlin.client.model.Filters.all

val student = Student(
    "Sandra Nook",
    listOf("Alvarez", "Gruber"),
    85.7
)
// Equivalent equality queries
Student::name.eq(student.name)
eq(Student::name, student.name)
Student::name eq student.name // Infix notation
// Equivalent array queries
all(Student::teachers, student.teachers)
Student::teachers.all(student.teachers)
Student::teachers all student.teachers // Infix notation

Indexes

Indexes ビルダークラスのヘルパーを使用して、データクラスプロパティにインデックスを作成できます。このクラスの詳細については、インデックスビルダのガイドを参照してください。

次のコードは、Indexes 拡張メソッドを使用して Student データクラスのインデックスを作成するさまざまな方法を示しています。

import com.mongodb.kotlin.client.model.Indexes.ascending
import com.mongodb.kotlin.client.model.Indexes.descending

val ascendingIdx = Indexes.ascending(Student::name)
val descendingIdx = Indexes.descending(Student::teachers)
val ascIdxName = collection.createIndex(ascendingIdx)
val descIdxName = collection.createIndex(descendingIdx)

プロジェクション

Projections ビルダークラスのヘルパーを使用して、データクラスプロパティのプロジェクションを作成できます。このクラスの詳細については、「プロジェクションビルダガイド」を参照してください。

次のコードは、Projections 拡張メソッドを使用して Student データクラスにプロジェクションを作成する方法を示しています。

import com.mongodb.kotlin.client.model.Projections.excludeId
import com.mongodb.kotlin.client.model.Projections.fields
import com.mongodb.kotlin.client.model.Projections.include

val combinedProj = fields(
    include(Student::name, Student::gradeAverage),
    excludeId()
)
collection.find().projection(combinedProj)

ソート

Sorts ビルダークラスのヘルパーを使用して、データクラスプロパティでソートできます。このクラスの詳細については、ソートビルダのガイドを参照してください。

次のコードは、Sorts 拡張メソッドを使用して Student データクラスでさまざまな並べ替えを作成する方法を示しています。

import com.mongodb.client.model.Sorts.orderBy
import com.mongodb.kotlin.client.model.Sorts

val sort = orderBy(
    Sorts.descending(Student::gradeAverage),
    Sorts.ascending(Student::name)
)
collection.find().sort(sort)

Updates

Updates ビルダークラスのヘルパーを使用して、データクラスのプロパティを使用してアップデートを実行できます。このクラスの詳細については、アップデートビルダのガイドを参照してください。

次のコードは、Sorts 拡張メソッドを使用して Student データクラスでさまざまな並べ替えを作成する方法を示しています。

import com.mongodb.kotlin.client.model.Filters.gte
import com.mongodb.kotlin.client.model.Updates.addToSet
import com.mongodb.kotlin.client.model.Updates.combine
import com.mongodb.kotlin.client.model.Updates.max

val filter = Student::gradeAverage gte 85.0
val update = combine(
    addToSet(Student::teachers, "Soto"),
    Student::gradeAverage.max(90.0)
)
collection.updateMany(filter, update)

集計

Aggregates と Accumulators ビルダークラスのヘルパーを使用して、データクラスのプロパティを使用して集計を実行できます。これらのクラスの詳細については、集計ビルダのガイドを参照してください。

次のコードは、Accumulators 拡張メソッドと Aggregatesヘルパーメソッドを使用して Student データクラスで集計を実行する方法を示しています。

import com.mongodb.client.model.Aggregates.group
import com.mongodb.client.model.Aggregates.limit
import com.mongodb.client.model.Aggregates.sort
import com.mongodb.kotlin.client.model.Accumulators.avg

// Data class to store aggregation result
data class Summary ( val average: Double )
val pipeline = listOf(
    // Sorts grades from high to low
    sort(Sorts.descending(Student::gradeAverage)),
    // Selects the top 3 students
    limit(3),
    // Calculates the average of their grades and stores value in a Summary instance
    group(null, avg(Summary::average, "\$${Student::gradeAverage.name}"))
)
val result = collection.aggregate<Summary>(pipeline)