クエリを指定する

Overview

このガイドでは、 Kotlin Sync ドライバーを使用してクエリを指定する方法を学習できます。

クエリフィルターを作成することで、クエリが返すドキュメントのセットを絞り込むことができます。 クエリフィルター は、MongoDB が読み取りまたは書込み (write) 操作でドキュメントを照合するために使用する検索条件を指定する 式 です。 クエリフィルターでは、クエリに完全に一致するドキュメントを検索するようにドライバーに指示することも、より複雑な一致条件をExpressするためにクエリフィルターを作成することもできます。

{ "_id": 1, "name": "apples", "quantity": 5, "rating": 3, "color": "red", "type": ["fuji", "honeycrisp"] },
{ "_id": 2, "name": "bananas", "quantity": 7, "rating": 4, "color": "yellow", "type": ["cavendish"] },
{ "_id": 3, "name": "oranges", "quantity": 6, "rating": 2, "type": ["naval", "mandarin"] },
{ "_id": 4, "name": "pineapple", "quantity": 3, "rating": 5, "color": "yellow" },

data class Fruit(
    @BsonId
    val id: Int,
    val name: String,
    val quantity: Int,
    val rating: Int,
    val color: String,
    val type: List<String>
)

val uri = "<connection string URI>"
val settings = MongoClientSettings.builder()
    .applyConnectionString(ConnectionString(uri))
    .retryWrites(true)
    .build()
val mongoClient = MongoClient.create(settings)
val database = mongoClient.getDatabase("sample_fruit")
val collection = database.getCollection<Fruit>("fruits")
collection.insertMany(listOf(
    Fruit(1, "apples", 5, 3, "red", listOf("fuji", "honeycrisp")),
    Fruit(2, "bananas", 7, 4, "yellow", listOf("cavendish")),
    Fruit(3, "oranges", 6, 2, null, listOf("naval", "mandarin")),
    Fruit(4, "pineapples", 3, 5, "yellow", null)
))

完全一致

リテラル値クエリは、クエリフィルターに完全に一致するドキュメントを返します。

次の例えでは、 find()メソッドのパラメーターとしてクエリフィルターを指定します。 このコードは、 colorフィールドの値が"yellow"であるすべてのドキュメントを返します。

val results = collection.find(eq(Fruit::color.name, "yellow"))
results.forEach { result ->
    println(result);
}

Fruit(id=2, name=bananas, quantity=7, rating=4, color=yellow, type=[cavendish])
Fruit(id=4, name=pineapples, quantity=3, rating=5, color=yellow, type=null)

比較演算子

比較演算子は、クエリフィルター内の指定された値に対してドキュメント フィールド値を評価します。 以下は、一般的な比較演算子のリストです。

• $gt: より大きい

• $lte: 以下

• $ne: 等しくない

比較演算子の完全なリストを表示するには、 マニュアルの「 比較クエリ演算子 」MongoDB Server ガイドを参照してください。

次の例では、クエリフィルター内の 比較演算子をfind()メソッドへのパラメーターとして指定しています。 コードは、 ratingフィールドの値が2より大きいすべてのドキュメントを返します。

val results = collection.find(gt(Fruit::rating.name, 2))
results.forEach { result ->
    println(result)
}

Fruit(id=1, name=apples, quantity=5, rating=3, color=red, type=[fuji, honeycrisp])
Fruit(id=2, name=bananas, quantity=7, rating=4, color=yellow, type=[cavendish])
Fruit(id=4, name=pineapples, quantity=3, rating=5, color=yellow, type=null)

論理演算子

論理演算子は、2 つ以上の式のセットの結果に適用されたロジックを使用してドキュメントを一致させます。 以下は論理演算子のリストです。

• $andは、すべての句の条件に一致するすべてのドキュメントを返します。

• $orは、 1 つの句の条件に一致するすべてのドキュメントを返します

• $norは、どの句の条件にも一致しないすべてのドキュメントを返します。

• $notは、式に一致しないすべてのドキュメントを返します。

論理演算子の詳細については、 MongoDB Serverマニュアルの「 論理クエリ演算子 」ガイドを参照してください。

次の例えでは、クエリフィルターで論理演算子をfind()メソッドへのパラメーターとして指定します。 このコードでは、 quantityフィールドの値が5より大きいか、 colorフィールドの値が"yellow"であるすべてのドキュメントが返されます。

val results = collection.find(
    or(
        gt(Fruit::quantity.name, 5),
        eq(Fruit::color.name, "yellow")
    )
)
results.forEach { result ->
    println(result)
}

Fruit(id=2, name=bananas, quantity=7, rating=4, color=yellow, type=[cavendish])
Fruit(id=3, name=oranges, quantity=6, rating=2, color=null, type=[naval, mandarin])
Fruit(id=4, name=pineapples, quantity=3, rating=5, color=yellow, type=null)

配列演算子

配列演算子は、配列フィールド内の要素の値または量に基づいてドキュメントを一致させます。 以下は、使用可能な配列演算子のリストです。

• $allは、クエリ内のすべての要素を含む配列を持つドキュメントを返します

• $elemMatchは、配列フィールド内の要素がクエリ内のすべての条件に一致する場合にドキュメントを返します。

• $sizeは、指定されたサイズの配列を持つすべてのドキュメントを返します

配列演算子の詳細については、MongoDB Server マニュアルの「 配列クエリ演算子 」ガイドを参照してください。

次の例では、クエリフィルター内の配列演算子をfind()メソッドへのパラメーターとして指定しています。 このコードは、 2要素のみを含むtype配列フィールドを持つすべてのドキュメントを返します。

val results = collection.find(size(Fruit::type.name, 2))
results.forEach { result ->
    println(result)
}

Fruit(id=1, name=apples, quantity=5, rating=3, color=red, type=[fuji, honeycrisp])
Fruit(id=3, name=oranges, quantity=6, rating=2, color=null, type=[naval, mandarin])

要素演算子

要素演算子は、フィールドの存在または型に基づいてデータをクエリします。

要素演算子の詳細については、 MongoDB Serverマニュアルの「 要素クエリ演算子 」ガイドを参照してください。

次の例では、クエリフィルター内の要素演算子をfind()メソッドへのパラメーターとして指定しています。 このコードでは、 colorフィールドを持つすべてのドキュメントが返されます。

val results = collection.find(exists(Fruit::color.name))
results.forEach { result ->
    println(result)
}

Fruit(id=1, name=apples, quantity=5, rating=3, color=red, type=[fuji, honeycrisp])
Fruit(id=2, name=bananas, quantity=7, rating=4, color=yellow, type=[cavendish])
Fruit(id=4, name=pineapples, quantity=3, rating=5, color=yellow, type=null)

評価演算子

評価演算子は、個々のフィールドまたはコレクションのドキュメント全体の評価に基づいてデータを返します。

以下は、一般的な評価演算子のリストです。

• $textは、ドキュメントに対してテキスト検索を実行します

• $regexは、指定された正規表現に一致するドキュメントを返します

• $modは、フィールドの値に対して剰余操作を実行し、余りが指定された値であるドキュメントを返します

評価演算子の完全なリストを表示するには、 マニュアルの「 評価クエリ演算子MongoDB Server 」ガイドを参照してください。

次の例では、クエリフィルターで評価演算子をfind()メソッドへのパラメーターとして指定しています。 このコードでは正規表現を使用して、少なくとも 2 文字が連続する"p" nameフィールド値を持つすべてのドキュメントが返されます。

val results = collection.find(regex(Fruit::name.name, "p{2,}"))
results.forEach { result ->
    println(result)
}

Fruit(id=1, name=apples, quantity=5, rating=3, color=red, type=[fuji, honeycrisp])
Fruit(id=4, name=pineapples, quantity=3, rating=5, color=yellow, type=null)

詳細情報

ドキュメントのクエリの詳細については、MongoDB Server マニュアルの 「ドキュメントのクエリ」 ガイドを参照してください。

Kotlin Sync ドライバーを使用してドキュメントを取得する方法の詳細については、「 データの取得 」を参照してください。