クエリを指定する

クエリ API

Dlango QuerySet API には、モデル オブジェクトを検索できるメソッドが用意されています。 MongoDBデータベースクエリを実行するには、モデルのマネージャーで QuerySet メソッドを呼び出します。 Managerクラスはデータベース操作を処理し、Diango モデルを参照してMongoDBデータを操作できます。 デフォルトでは 、Dhango は objects という名前の Manager をすべてのモデルクラスに追加します。

変数に QuerySet を割り当てると、変数を評価するまで Diango MongoDBバックエンドは操作を実行しません。 QuerySet を評価した後、Diango はクエリ結果を QuerySetキャッシュに保存します。 QuerySet の将来の評価では、キャッシュされた結果が使用されます。

サンプル データ

このガイドの例では、AtlasサンプルデータセットMovie のsample_mflix.movies コレクションを表す モデルを使用します。Movie モデルには、awardsフィールドの値として埋め込み Award モデルが含まれています。 これらのモデル クラスには、次の定義があります。

from django.db import models
from django_mongodb_backend.models import EmbeddedModel
from django_mongodb_backend.fields import EmbeddedModelField, ArrayField
class Award(EmbeddedModel):
    wins = models.IntegerField(default=0)
    nominations = models.IntegerField(default=0)
    text = models.CharField(max_length=100)
class Movie(models.Model):
    title = models.CharField(max_length=200)
    plot = models.TextField(blank=True)
    runtime = models.IntegerField(default=0)
    released = models.DateTimeField("release date", null=True, blank=True)
    awards = EmbeddedModelField(Award)
    genres = ArrayField(models.CharField(max_length=100), null=True, blank=True)
    imdb = models.JSONField(null=True)
    class Meta:
        db_table = "movies"
        managed = False
    
    def __str__(self):
        return self.title

Movie モデルには、モデルメタデータを指定する内部 Metaクラスと、モデルの string 表現を定義する __str__() メソッドが含まれています。 これらのモデル機能について詳しくは、「 モデルの作成ガイドでモデルを定義する 」を参照してください。

python manage.py shell

from <your application name>.models import Movie, Award
from django.utils import timezone
from datetime import datetime

すべてのドキュメントを検索する

コレクションからすべてのドキュメントを取得するには、モデルのマネージャーで all() メソッドを呼び出します。

次の例では、 all() メソッドを呼び出して、sample_mflix.moviesコレクション内のすべてのドキュメントを検索します。

Movie.objects.all()

<QuerySet [<Movie: The Great Train Robbery>, <Movie: A Corner in Wheat>,
<Movie: Winsor McCay, the Famous Cartoonist of the N.Y. Herald and His Moving Comics>,
<Movie: Traffic in Souls>, <Movie: Gertie the Dinosaur>,
<Movie: In the Land of the Head Hunters>, <Movie: The Perils of Pauline>,
<Movie: The Italian>, <Movie: Regeneration>, <Movie: Civilization>,
'...(remaining elements truncated)...']>

一致するドキュメントの取得

一連の条件に一致するドキュメントをコレクションでクエリするには、モデルのマネージャーで filter() メソッドを呼び出します。 クエリ条件を指定するクエリフィルターを filter() メソッドに渡します。

次の例では、 filter() メソッドを呼び出して、sample_mflix.moviesコレクションで runtime の値が 300 であるドキュメントをクエリします。

Movie.objects.filter(runtime=300)

<QuerySet [<Movie: Wild Palms>, <Movie: Streets of Laredo>,
<Movie: The Way We Live Now>]>

Retrieve One Document

コレクションから 1 つのドキュメントを取得するには、モデルのマネージャーで get() メソッドを呼び出します。 クエリ条件を指定するクエリフィルターを get() メソッドに渡します。

次の例では、 get() メソッドを呼び出して、title の値が "Finding Nemo" であるドキュメントを 1 つ取得します。

Movie.objects.get(title="Finding Nemo")

<Movie: Finding Nemo>

一致するドキュメントの除外

検索条件を満たさないドキュメントのコレクションをクエリするには、モデルのマネージャーで exclude() メソッドを呼び出します。 除外条件を引数として exclude() メソッドに渡します。

次の例では、 exclude() メソッドを呼び出して、datetime(1980, 1, 1) より前にリリースされたドキュメント（1、1980）を結果から除外します。

Movie.objects.exclude(released__lt=timezone.make_aware(datetime(1980, 1, 1)))

<QuerySet [<Movie: The Iron Horse>, <Movie: Le grand jeu>,
<Movie: The Devil Is a Woman>, <Movie: Children in the Wind>,
<Movie: Too Much Johnson>, <Movie: Dots>, <Movie: The Blood of Jesus>,
<Movie: The Land>, <Movie: The Brothers and Sisters of the Toda Family>,
<Movie: Begone Dull Care>, '...(remaining elements truncated)...']>

Raw データベースクエリの実行

Dpango のクエリAPI がサポートしていない複雑なクエリを実行する場合は、raw_aggregate() メソッドを使用できます。 この方法を使用すると、 MongoDB集計パイプラインでクエリ条件を指定し、raw_aggregate() に引数として渡します。

Rawデータベースクエリの実行方法については、「 Raw データベースクエリの実行 」ガイドを参照してください。

テキスト一致検索の使用

次の表では、テキスト値の具体的な一致条件を含むクエリを実行するために使用できるいくつかのルックアップ タイプについて説明します。

Movie.objects.filter(plot__contains="coming-of-age")

<QuerySet [<Movie: Murmur of the Heart>, <Movie: Desert Bloom>,
<Movie: Girls Town>, <Movie: Get Real>, <Movie: Man of Steel>,
<Movie: The Holy Land>, <Movie: Secondhand Lions>, <Movie: How to Be Louise>,
<Movie: Mouth to Mouth>, <Movie: Che ne sarè di noi>, <Movie: Roll Bounce>,
'...(remaining elements truncated)...']>

比較検索の使用

次の表では、指定された値に対してフィールド値を評価するクエリを実行するために使用できるいくつかのルックアップ タイプについて説明します。

Movie.objects.filter(runtime__lte=50)

<QuerySet [<Movie: The Great Train Robbery>, <Movie: A Corner in Wheat>,
<Movie: Winsor McCay, the Famous Cartoonist of the N.Y. Herald and His Moving Comics>,
<Movie: Gertie the Dinosaur>, <Movie: From Hand to Mouth>,
<Movie: High and Dizzy>, <Movie: One Week>, <Movie: Now or Never>,
'...(remaining elements truncated)...']>

組み合わせ検索

複数の一致条件のセットを使用するクエリは、次の方法で実行できます。

• クエリメソッドに複数のクエリフィルターをカンマで区切って渡します。 の例を表示するには、Dpango ドキュメントの「 オブジェクトの取得 」を参照してください。

• クエリ メソッドを連結します。 詳細については、Diango ドキュメントの「 フィルターの連鎖 」を参照してください。

• Q オブジェクトを使用し、各オブジェクトを 論理演算子で区切ります。 詳細については、Dください ドキュメントの「 Q オブジェクトを使用した複雑な検索 」を参照してください。

Movie.objects.filter(
    (Q(title__startswith="Funny") | Q(title__startswith="Laugh")) 
    & ~Q(genres__contains=["Comedy"])
)

<QuerySet [<Movie: Laugh, Clown, Laugh>, <Movie: Funny Games>]>

結果を並べ替える

order_by() メソッドを使用して、クエリ結果の並べ替え順序を指定できます。 特定のフィールドの値に基づいて昇順の並べ替えを指定するには、フィールド名を引数として渡します。 降順のソートを指定するには、マイナス記号（-）を先頭に付けたフィールド名を引数として渡します。

カンマで区切られた複数のフィールド名を order_by() メソッドに渡すことができます。 Dlango MongoDBバックエンドは、指定された順序の各フィールドで結果をソートします。

Movie.objects.filter(title__startswith="Rocky").order_by("released")

<QuerySet [<Movie: Rocky>, <Movie: Rocky II>, <Movie: Rocky III>,
<Movie: Rocky IV>, <Movie: Rocky V>, <Movie: Rocky Marciano>,
<Movie: Rocky Balboa>]>

結果をスキップして結果を制限する

次のコードに示すように、Python の 配列スケーリング構文 を使用して、クエリが返す結果の数を指定できます。

Model.objects.filter(<query filter>)[<start>:<end>]

<start> と <end> のプレースホルダーを、返す結果のサブセットを表す整数値に置き換えます。 開始値は排他的で、終了値は包括的です。

<start> 値を省略すると、クエリは最初の一致から始めて、<end> 値で指定された数値が返されるまで、それぞれの結果を返します。

<end> 値を省略すると、クエリは各結果を返しますが、<start> で指定された初期結果の数はスキップされます。

Movie.objects.filter(released=timezone.make_aware(datetime(2010, 7, 16)))[2:4]

<QuerySet [<Movie: Inception>, <Movie: Winter's Bone>]>

最初の結果を取得

複数の結果に一致する可能性のあるクエリから最初の結果を検索するには、first() メソッドを filter() メソッドに連鎖させます。 クエリ条件を指定するクエリフィルターを filter() メソッドに渡します。

次の例では、 filter() メソッドと first() メソッドを呼び出して、genres 値が ["Crime", "Comedy"] である最初のドキュメントを sample_mflix.moviesコレクションでクエリします。

Movie.objects.filter(genres=["Crime", "Comedy"]).first()

<Movie: The Crew>

埋め込みモデル値のクエリ

埋め込みモデルのフィールドをクエリする操作をモデルに対して実行できます。 これらのフィールドをクエリするには、次のコードに示すように、クエリするフィールドに到達するまで、モデルフィールドと各埋め込みフィールド名を二重アンダースコア（__）で区切って指定します。

Model.objects.filter(<model field>__<embedded model field>=<value>)

フィールドルックアップ を使用して埋め込みモデルクエリを改善することもできます。クエリする埋め込みモデルフィールドの後にルックアップ タイプを追加し、二重アンダースコアをプレフィックスとして付けます。

Movie.objects.filter(awards__wins__gt=150)

<QuerySet [<Movie: The Lord of the Rings: The Return of the King>,
<Movie: No Country for Old Men>, <Movie: Slumdog Millionaire>,
<Movie: Boyhood>, <Movie: The Social Network>, <Movie: Inception>,
<Movie: Gravity>, <Movie: Gravity>, <Movie: The Artist>,
<Movie: 12 Years a Slave>, <Movie: Birdman: Or (The Unexpected Virtue of Ignorance)>]>

クエリ配列の値

標準のクエリ構文を使用して、ArrayField 値に保存されているデータをクエリできます。 Dlango MongoDBバックエンドは、ArrayField 値をクエリするための追加のフィールドルックアップ タイプを提供します。これについては次の表で説明します。

Movie.objects.filter(genres__overlap=["Adventure", "Family"])

<QuerySet [<Movie: The Poor Little Rich Girl>, <Movie: Robin Hood>,
<Movie: Peter Pan>, <Movie: The Thief of Bagdad>, <Movie: Clash of the Wolves>,
<Movie: Beau Geste>, <Movie: The Black Pirate>, <Movie: The Son of the Sheik>,
<Movie: Steamboat Willie>, <Movie: The Big Trail>, <Movie: The Champ>,
'...(remaining elements truncated)...']>

埋め込みモデル配列値のクエリ

埋め込みモデルの配列のフィールドをクエリする操作をモデルに対して実行できます。これらのクエリは、埋め込みモデル値のクエリセクションで説明されているのと同じ構文を使用します。

Model.objects.filter(<model field>__<embedded model field>=<value>)

フィールドルックアップ を使用して埋め込みモデルクエリを改善することもできます。クエリする埋め込みモデルフィールドの後にルックアップ タイプを追加し、二重アンダースコアをプレフィックスとして付けます。 ただし、埋め込みフィールドをクエリするには、次のルックアップ タイプのみを使用できます。

• exact

• iexact

• in

• gt

• gte

• lt

• lte

Movie.objects.filter(cast__len__gt=5)

Movie.objects.filter(cast__0__last_name="Winslet")

Movie.objects.filter(cast__0_2__last_name="Winslet")

多形埋め込みモデル値のクエリ

PolymorphicEmbeddedModelField 値に保存されているデータをクエリするには、前述の埋め込みモデル値のクエリセクションで説明されているのと同じ構文を使用します。埋め込みモデル間で共有されるフィールドまたは特定のモデルに固有のフィールドをクエリできます。

Movie.objects.filter(awards__wins=10)

Movie.objects.filter(awards__best_picture=True)

多形埋め込みモデル配列値のクエリ

PolymorphicEmbeddedModelArrayField 値に保存されているデータをクエリするには、「埋め込みモデル配列値のクエリ」セクションで説明されているものと同じ構文と演算子を使用します。埋め込みモデル間で共有されるフィールドまたは特定のモデルに固有のフィールドをクエリできます。

Movie.objects.filter(awards__year__lt=2000)

Query JSON Values

JSONField「埋め込みモデル値のクエリ」セクションに示されているのと同じ構文を使用して、 値に保存されているデータをクエリできます。クエリするフィールドに到達するまで、各フィールドとネストされたフィールド名を二重アンダースコア（__）で区切って連結します。

次の例では、 JSONField の値を持つ imdbフィールドで、ネストされた votesフィールドの値が 900000 を超える値をクエリします。

Movie.objects.filter(imdb__votes__gt=900000)

<QuerySet [<Movie: La nao capitana>, <Movie: The Godfather>,
<Movie: This Is Spinal Tap>, <Movie: Forrest Gump>, <Movie: Pulp Fiction>,
<Movie: The Shawshank Redemption>, <Movie: Se7en>,
<Movie: The Lord of the Rings: The Fellowship of the Ring>,
<Movie: The Matrix>, <Movie: Fight Club>,
<Movie: The Lord of the Rings: The Return of the King>,
<Movie: The Lord of the Rings: The Two Towers>, <Movie: The Shawshank Redemption>,
<Movie: Landet som icke èr>, <Movie: The Dark Knight>,
<Movie: The Danish Girl>, <Movie: The Dark Knight Rises>, <Movie: Inception>,
<Movie: Catching the Sun>, <Movie: Scouts Guide to the Zombie Apocalypse>,
'...(remaining elements truncated)...']>

from django.db.models.fields.json import KT
Movie.objects.annotate(score=KT("imdb__rating")).all().order_by("-score")

<QuerySet [<Movie: No Tomorrow>, <Movie: The Deposit>, <Movie: Man Down>,
<Movie: Convenience>, <Movie: Scouts Guide to the Zombie Apocalypse>,
<Movie: Another World>, <Movie: The Danish Girl>, <Movie: Ad Inexplorata>,
<Movie: Landet som icke èr>, <Movie: The Ghost and the Whale>,
<Movie: Coming to Terms>, <Movie: La nao capitana>, <Movie: All Eyes and Ears>,
<Movie: Catching the Sun>, <Movie: Manhattan Romance>, <Movie: Anomalisa>,
<Movie: Outliving Emily>, <Movie: Mary Loss of Soul>,
<Movie: The Childhood of a Leader>, <Movie: Krot na more>,
'...(remaining elements truncated)...']>

プライマリキー値のクエリ

pk ルックアップ ショートカットを使用して、 MongoDB がObjectId 値として保存するプライマリキー値をクエリできます。

次の例では、プライマリキーが ObjectId("573a1394f29313caabce0d37") であるドキュメントを sample_mflix.moviesコレクションでクエリします。

from bson import ObjectId
Movie.objects.get(pk=ObjectId("573a1394f29313caabce0d37"))

// Your ObjectId values might differ
<Movie: Vertigo>

sample_mflix.moviesコレクションを表す Movie モデルは、idフィールドをプライマリキーとして使用します。 次の例では、 idフィールド を使用して、前のコードと同じクエリを構築します。

from bson import ObjectId
Movie.objects.get(id=ObjectId("573a1394f29313caabce0d37"))