データベース API リファレンス

自動主キーの値を明示的に指定する

モデルが AutoField を持っていて、新たなオブジェクトの ID を保存時に明示 的に指定したい場合、 ID を自動的に決定させずに保存前に明示的に指定してくだ さい。

例えば:

b3 = Blog(id=3, name='Cheddar Talk', tagline='Thoughts on cheese.')
b3.id     # Returns 3.
b3.save()
b3.id     # Returns 3.

自動主キーの値を手動で割り当てる場合、決して既に存在する主キーの値を割り当 てないようにしてください! 明示的な主キー値を持った新たなオブジェクトを作成 し、その主キーがすでにデータベース上に存在する場合、 Django は保存操作を新 たなオブジェクトの作成ではなく、既存のオブジェクトの変更とみなします。

上の 'Cheddar Talk' ブログを例にとると、以下の例はデータベース上の既存 のレコードをオーバライドしてしまいます:

b4 = Blog(id=3, name='Not Cheddar', tagline='Anything but cheese.')
b4.save()  # Overrides the previous blog with ID=3!

この理由については後述の UPDATE と INSERT の区別 を参照してください。

主キーの衝突がないとはっきり判っている場合なら、自動主キーの値の明示的な指 定は大量のオブジェクトを保存する際にきわめて便利です。

フィルタの連鎖

クエリセットをリファインした結果は、それ自体クエリセットになります。従って、 リファイン操作は連鎖させられます。例えば:

Entry.objects.filter(
    headline__startswith='What').exclude(
        pub_date__gte=datetime.now()).filter(
            pub_date__gte=datetime(2005, 1, 1))

上の例は、データベースの全てのエントリを表す初期クエリセットに対し、 filter() をかけた後に exclude() を実行し、さらにもう一つ filter() をかけています。最終的に得られるのは、 "What" で始まる ヘッドラインのうち、 January 1, 2005 から今日までの間に公開されたエントリに なります。

クエリセットはいつ評価されるのか

以下の方法を使うと、クエリセットを評価できます:

• イテレーション。 クエリセットはイテレーション可能オブジェクトであ り、オブジェクトに対して最初にイテレーション操作を行ったときにデータ ベースクエリを実行します。例えば、以下の例はデータベース中の全てのエ ントリのヘッドラインを出力します:

  for e in Entry.objects.all():
      print e.headline
  

• スライス。 クエリセットに制約を課す の節で説明しているように、 Python の配列スライス表記を使うとクエリセットをスライスできます。通常、 クエリセットに対するスライスは (未評価の) 別のクエリセットを返します が、スライス表記に「ステップ (step)」パラメタを使った場合には、データ ベースクエリを実行します。

• repr(). クエリセットに対して repr() を呼び出すと、クエリセッ トは値評価されます。これは Python 対話インタプリタでの利便性のための 仕様で、 API を対話的に使うときに結果を即座に見られるようにしています。

• len(). クエリセットに対して len() を呼び出すと、クエリセッ トは値評価されます。予想に違わず、 len() はクエリ結果リストの長さ を返します。

  注意: クエリセット中のレコードの数を知りたいだけなら、 len() は 使わないでください 。レコード数の計算はデータベース上で SQL 文の SELECT COUNT(*) 使って行う方が遥かに効率的であり、まさにその理由 から Django では count() メソッドを提供しています。後述の count() を参照してください。

• list(). クエリセットに対して list() を呼び出すと、値評価を強 制できます。例えば:

  entry_list = list(Entry.objects.all())
  

  とはいえ、この方法を使うと、Django が全ての要素のリストをメモリ上にロー ドするため、巨大なメモリオーバヘッドを引き起こす可能性があるので十分 注意してください。これに対し、クエリセットに対するイテレーション操作 では、必要な分だけデータをロードしてオブジェクトをインスタンス化する という利点があります。

クエリセットの pickle 化

クエリセットを pickle 化すると、クエリセットによって得られる内容は pickle 化に先立って全てのメモリ上にロードされます。このため、 pickle はしばしばキャッ シュに先駆けて使われたり、すでにクエリ結果が存在する場合にクエリセットをリ ロードする目的で使われます。逆に、クエリセットを逆 pickle 化すると、現在の データベース上の値ではなく、 pickle 化した当時の結果を返します。

単にクエリセットを再構築する上で必要な情報だけを pickle 化したいのなら、ク エリセットの query 属性だけを pickle 化してください。レコードの pickle 化を伴わずにクエリセットを再構築したければ、以下のようにしてください:

>>> import pickle
>>> query = pickle.loads(s)     # pickle 化文字列を 's' とします。
>>> qs = MyModel.objects.all()
>>> qs.query = query            # もとの 'query' を代入して再構築します。

filter(**kwargs)

指定の照合パラメタに一致するオブジェクトの入った新たなクエリセットを返しま す。

照合パラメタ (**kwargs) は後述の フィールドの照合 で説明するフォーマッ トにします。複数のパラメタを指定すると、背後の SQL 文では AND で結合さ れます。

exclude(**kwargs)

指定の照合パラメタに一致 しない オブジェクトの入った新たなクエリセットを 返します。

照合パラメタ (**kwargs) は後述の フィールドの照合 で説明するフォーマッ トにします。複数のパラメタを指定すると、背後の SQL 文では AND で結合さ れ、制約条件節全体を NOT() で囲みます。

以下の例では、 pub_date が 2005 年 1 月 3 日より未来の日時になっていて、 かつ headline が "Hello" で始まる全てのエントリを除外します:

Entry.objects.exclude(pub_date__gt=datetime.date(2005, 1, 3), headline='Hello')

SQL 用語でいうと、以下のようなクエリの評価になります:

SELECT ...
WHERE NOT (pub_date > '2005-1-3' AND headline = 'Hello')

また、以下の例では、 pub_date が 2005 年 1 月 3 日より未来の日時で あるか、 または headline が "Hello" で始まる全てのエントリを除外しま す:

Entry.objects.exclude(pub_date__gt=datetime.date(2005, 1, 3)).exclude(headline='Hello')

SQL 用語でいうと、以下のようなクエリの評価になります:

SELECT ...
WHERE NOT pub_date > '2005-1-3'
AND NOT headline = 'Hello'

二つ目の例の方が厳しい制約になっていることに注意して下さい。

order_by(*fields)

デフォルトでは、 QuerySet の返す結果はモデルの Meta の ordering オプションに指定した整列条件のタプルに従って整列されます。 order_by を 使うと、この挙動を QuerySet 単位でオーバライドできます。

例えば:

Entry.objects.filter(pub_date__year=2005).order_by('-pub_date', 'headline')

このクエリの結果は、まず pub_date で降順に並べ、次いで headline で 昇順に並べたものになります。 "-pub_date" の先頭にあるマイナス記号が 降順 表しています。何も指定しないと昇順になります。整列をランダムに したければ、以下のように "?" を使います:

Entry.objects.order_by('?')

注意: order_by('?') を使うと、使っているバックエンドによってはコストの かかる低速なクエリになります。

別のモデル内のフィールドを使ってモデルを整列させるには、モデルのリレーショ ン追跡と同じ構文を使ってフィールドを指定します。すなわち、フィールド名の後 ろにアンダースコア 2 つ (__) 、さらに新たなモデルのフィールド名を続けま す。この調子で、任意の深さまでモデルを追跡できます。例えば:

Entry.objects.order_by('blog__name', 'headline')

他のモデルへのリレーションを使ってモデルインスタンスを整列しようとすると、 Django はリレーション先のモデルのデフォルトの整列順 (Meta.ordering が指 定されていなければプライマリキー) を使います。例えば:

Entry.objects.order_by('blog')

は、 Blog モデルにデフォルトの整列順が指定されていないので、以下のコー ドと同じです:

Entry.objects.order_by('blog__id')

Be cautious when ordering by fields in related models if you are also using distinct(). See the note in the distinct() section for an explanation of how related model ordering can change the expected results.

It is permissible to specify a multi-valued field to order the results by (for example, a ManyToMany field). Normally this won't be a sensible thing to do and it's really an advanced usage feature. However, if you know that your queryset's filtering or available data implies that there will only be one ordering piece of data for each of the main items you are selecting, the ordering may well be exactly what you want to do. Use ordering on multi-valued fields with care and make sure the results are what you expect.

開発版の Django で新たに追加された機能: クエリをデフォルトの整列も含め て一切整列させたくない場合には、 order_by() を引数なしで呼び出してくだ さい。

開発版の Django で新たに追加された機能: リレーションをまたいでモデルを 整列する際の構文が変更されました。 以前の動作は Django 0.96 のドキュメント を参照してください。

大小文字の区別を考慮して整列するかどうかを指定する方法はありません。大小文 字の区別については、 Django は現在使っているデータベースバックエンドの整列 方法に従います。

reverse()

開発版の Django で新たに追加された機能

クエリセットの要素を逆順で返させたい場合は、 reverse() メソッドを使って ください。 reverse() を 2 度呼び出すと、並び順を元の正順に戻します。

例えば、「最新の」 5 要素を取り出すには、以下のようにします:

my_queryset.reverse()[:5]

これは、 Python の配列を末尾部分から数えてスライスするのとは少し違います。 上の例は、最末尾の要素が最初に、最後から 2 つ目は要素を次に、という順序で要 素を返します。Python の配列で seq[-5:] とすると、最後から 5 つめの要素 以降を順に返します。 Django では、 SQL の効率の観点から、このようなアクセス (末尾からの要素数での指定) をサポートしていません。

distinct()

SQL クエリに SELECT DISTINCT を使う新たな QuerySet を返します。 distinct() を使うと、クエリ結果から重複する行をなくします。

デフォルトでは、 QuerySet は重複する行を除去しません。通常は、 Blog.objects.all() のような単純なクエリは重複する行を含むような結果にな らないため、これはあまり問題にはなりません。しかし、クエリが複数のテーブル にわたる場合、 QuerySet の評価結果に重複する結果が入る場合があります。 その場合には distinct() を使って下さい。

values(*fields)

ValueQuerySet を返します。 ValueQuerySet は QuerySet のサブクラ スで、評価結果としてモデルインスタンスオブジェクトの代りに辞書のリストを返 す QuerySet です。

リスト中の各辞書は個々のオブジェクトを表現しており、キーがモデルオブジェク トの各属性名に、対応しています。

以下の例では、 values() の辞書と通常のモデルオブジェクトを比較していま す:

# リストには Blog オブジェクトが入ります。
>>> Blog.objects.filter(name__startswith='Beatles')
[Beatles Blog]

# リストには辞書が入ります。
>>> Blog.objects.filter(name__startswith='Beatles').values()
[{'id': 1, 'name': 'Beatles Blog', 'tagline': 'All the latest Beatles news.'}]

values() オプションの可変長の引数 *fields を取れます。このオプションは SELECT の制限に使うフィールド名を列挙したものです。 fields を指定し た場合、辞書には指定した名前のフィールドのキーと値だけが入ります。 *fields を指定しなければ、辞書にはテーブルの全てのフィールドのキーと値 が入ります。

例を示します:

>>> Blog.objects.values()
[{'id': 1, 'name': 'Beatles Blog', 'tagline': 'All the latest Beatles news.'}],
>>> Blog.objects.values('id', 'name')
[{'id': 1, 'name': 'Beatles Blog'}]

ForeignKey リレーションをまたいで values() を使うには、 filter() コマンドと同様に、フィールド名を二重アンダースコアで区切って指 定します。例えば:

>>> Entry.objects.values('blog__name').distinct()
[{'name': 'Beatles Blog'}]

注意すべき点が 2 つほどあります:

• values() メソッドに ManyToManyField を渡して結果を得ることは できません。 ManyToManyField 型のフィールドを渡すと、エラーを送出 します。

• ForeignKey のフィールド foo がモデルに入っている場合、 values() がデフォルトで返す辞書には、 foo_id というキーが入っ ています。これは、リレーションの実際の値が入っているモデル内部の隠し フィールドの名前です (foo はリレーション先のモデルインスタンスを 参照しています)。一方、 values() にフィールド名を指定して呼び出す 場合は、 foo と foo_id のどちらでも渡せますが、得られる結果は 同じ (辞書のキーは渡したフィールド名と同じ) で、リレーションの実際の 値です。

  例を以下に示します:

  >>> Entry.objects.values()
  [{'blog_id: 1, 'headline': u'First Entry', ...}, ...]
  
  >>> Entry.objects.values('blog')
  [{'blog': 1}, ...]
  
  >>> Entry.objects.values('blog_id')
  [{'blog_id': 1}, ...]
  

• values() と distinct() を組み合わせて使う場合、カラム値による 並べ替えが結果に思わぬ影響をもたらすことがあります。詳しくは distinct() の節を参照してください。

開発版の Django で新たに追加された機能: 以前は、 values() に渡せる のは blog だけで、 blog_id は使えませんでした。

ValuesQuerySet が便利なのは、わずかな数のフィールドの値しか必要でなく、 モデルインスタンスオブジェクトの機能が必要でないと分かっている場合です。 必要なフィールドだけを選択すると、さらに効率的になります。

最後に、 ValuesQuerySet は QuerySet のサブクラスなので、 QuerySet の全てのメソッドを持っている点に注意してください。 ValuesQuerySet に対して filter() や order_by() といった操作を行 えます。そう、以下の二つの呼び出しは等価になります:

Blog.objects.values().order_by('id')
Blog.objects.order_by('id').values()

Django の作者たちは、全ての SQL 関係のメソッドを先に配置し、その後に (必要 なら) 出力関係のメソッド (values() など) を配置するやり方を好んでいます。 とはいえ、これは実際上問題ではないので、個人的な信条を反映させてかまいませ ん。

values_list(*fields)

開発版の Django で新たに追加された機能です

values() に似ていますが、辞書のリストを返すのではなく、タプルのリストを 返します。各タプルには values_list() の引数に渡したフィールドの値が、引 数の順番に一致して入っています。例えば:

>>> Entry.objects.values_list('id', 'headline')
[(1, u'First entry'), ...]

フィールドを一つだけ指定する場合、 flat というパラメタも指定できます。 このパラメタを True にすると、結果は 1 要素のタプルではなく一つの値とし て返されます。以下の例を見れば、違いがはっきりするでしょう:

>>> Entry.objects.values_list('id').order_by('id')
[(1,), (2,), (3,), ...]

>>> Entry.objects.values_list('id', flat=True).order_by('id')
[1, 2, 3, ...]

複数のフィールドを指定しているときに flat を渡すとエラーを送出します。

values_list() に引数を渡さなければ、モデルの全てのフィールドを定義順に 並べたタプルのリストを返します。

dates(field, kind, order='ASC')

DateQuerySet を返します。 DateQuerySet は QuerySet のサブクラス で、評価結果としてクエリセット内のコンテンツの全日付を datetime.datetime オブジェクトとして返す QuerySet です。

field はモデルの DateField または DateTimeField の名前です。

kind は "year", "month" または "day" です。 結果リスト中の各 datetime.datetime オブジェクトは type の指定に従っ て切り詰められます。

• "year" フィールドの年部分の値の重複しないリストを返します。
• "month" フィールドの年／月部分の値の重複しないリストを返します。
• "day" フィールドの年／月／日部分の値の重複しないリストを返します。

order には結果の並び順を指定します。デフォルト値は 'ASC' で、 "ASC" または "DESC" にできます。

例を示します:

>>> Entry.objects.dates('pub_date', 'year')
[datetime.datetime(2005, 1, 1)]
>>> Entry.objects.dates('pub_date', 'month')
[datetime.datetime(2005, 2, 1), datetime.datetime(2005, 3, 1)]
>>> Entry.objects.dates('pub_date', 'day')
[datetime.datetime(2005, 2, 20), datetime.datetime(2005, 3, 20)]
>>> Entry.objects.dates('pub_date', 'day', order='DESC')
[datetime.datetime(2005, 3, 20), datetime.datetime(2005, 2, 20)]
>>> Entry.objects.filter(headline__contains='Lennon').dates('pub_date', 'day')
[datetime.datetime(2005, 3, 20)]

none()

開発版の Django で新たに追加された機能です

EmptyQuerySet を返します。 EmptyQuerySet とは、評価結果が常に空の リストになるクエリセットです。関数の戻り値などで空の照合結果を返したいが、 呼び出し側が (空のリストなどではなく) クエリセットオブジェクトの戻り値を期 待している場合に便利です。

例:

>>> Entry.objects.none()
[]

all()

開発版の Django で新たに追加された機能です

クエリセット（またサブクラス）の「コピー」を返します。モデルマネジャやクエ リセットを引数に渡してフィルタ処理を行わせたいような場合に便利です。モデル マネジャもクエリセットも all() を呼び出して、適切なクエリセットを取り出 せるからです。

select_related()

自動的に外部キーのリレーションを「追跡」し、クエリを実行したときにリレーショ ン先のオブジェクトも加えて選択するような QuerySet を返します。 これはパフォーマンスを向上させるための機構で、クエリは (ときに非常に) 巨大 になりますが、以後の外部キーへのリレーションでデータベースクエリが必要なく なります。

以下の例では、通常の照合と select_related() を使った照合との違いを比較 しています。通常の照合は以下のようになります:

# データベースを操作します。
e = Entry.objects.get(id=5)

# リレーション先の Blog オブジェクトを取得するために再度データベースを
# 操作します。
b = e.blog

select_related() を使った照合は以下のようになります:

# データベースを操作します。
e = Entry.objects.select_related().get(id=5)

# e.blog は上のクエリで取得済みなので、データベースを操作しません。
b = e.blog

select_related は可能な限り外部キーを追跡することに注意してください。以 下のようなモデル:

class City(models.Model):
    # ...

class Person(models.Model):
    # ...
    hometown = models.ForeignKey(City)

class Book(models.Model):
    # ...
    author = models.ForeignKey(Person)

の場合、 Book.objects.select_related().get(id=4) を実行すると、リレーションの張られた Person に加えて City もキャッ シュします:

b = Book.objects.select_related().get(id=4)
p = b.author         # Doesn't hit the database.
c = p.hometown       # Doesn't hit the database.

b = Book.objects.get(id=4) # No select_related() in this example.
p = b.author         # Hits the database.
c = p.hometown       # Hits the database.

select_related() は、デフォルトの状態では null=True であるような外 部キーカラムを追跡しないので注意してください。

通常、 select_related() を使うと、データベースの呼び出し回数を減らせる ので、大幅にパフォーマンスを向上できます。しかし、リレーションが深くネスト しているような状況では、 select_related() が追跡するリレーションが「多 すぎる」ために、巨大なクエリを生成してしまい、結果的にパフォーマンスの低下 を招く場合があります。

こうした状況に対応するため、 select_related() に depth 引数を指定す ると、以下の例のようにリレーションを何「レベル」まで追跡するかを制御できま す:

b = Book.objects.select_related(depth=1).get(id=4)
p = b.author         # 追跡済みのリレーション。データベースを操作しません。
c = p.hometown       # 未追跡のリレーション。データベースを呼び出します。

depth 引数は開発版の Django で新たに追加された機能です。

開発版の Django で新たに追加された機能: あるモデルからリレーションをた どるとき、そのモデルからリレーションを張っている全てのモデルを追跡するので はなく、特定のモデルだけを追跡したい場合があります。そのような場合には、 select_related() に追跡したいフィールドの名前を指定すれば、指定フィール ドだけを追跡できます。二重アンダースコアの表記法を使えば、追跡したいフィー ルドにいくつか先のリレーションも指定できます。例えば、以下のようなモデルが あったとします:

class Room(models.Model):
    # ...
    building = models.ForeignKey(...)

class Group(models.Model):
    # ...
    teacher = models.ForeignKey(...)
    room = models.ForeignKey(Room)
    subject = models.ForeignKey(...)

room と subject だけを追加したいときには、以下のようにします:

g = Group.objects.select_related('room', 'subject')

以下のように書いても構いません:

g = Group.objects.select_related('room__building', 'subject')

いずれの場合も、リレーション building を追跡します。

select_related に渡せるのは、 ForeignKey で定義したリレーションだけ です。また、(デフォルトの select_related() と違って) null=True であ るような外部キーも参照 できます 。 フィールド名と depth パラメタは、 互いに衝突する内容のオプションなので、 select_related() に同時に指定す るとエラーを引き起こします。

extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)

時として、 Django のクエリ表記法だけでは複雑な WHERE 節を容易に表現でき ない場合があります。こうした特異な場合のために、 Django では extra() というクエリセット修飾子を提供しています。このメソッドは、クエリセットが 生成する SQL 文中に特定の SQL 節を挿入するためのフックです。

定義上、これらの拡張照合機能は (直接 SQL コードを書いているため) データベー スエンジン間の可搬性がありません。また、 DRY 則の侵犯でもあります。可能な限 り使わないようにして下さい。

params, select, where, tables のいずれかを指定します。 いずれの引数も必須ではありませんが、少なくとも一つは指定せねばなりません。

select

select キーワードを使うと、 SELECT 節に追加のフィールドを選択で きます。この引数は、属性名とその属性値を計算するための SQL 節を対応づけ た辞書にします。

例えば:

Entry.objects.extra(select={'is_recent': "pub_date > '2006-01-01'"})

のようにすると、 Entry オブジェクトは、エントリの pub_date が Jan. 1, 2006 より大きいかどうかを示すブール値の属性 is_recent を 持つようになります。

Django は指定された SQL を直接 SELECT 文に挿入するので、上の例の SQL 文は以下のようになります:

SELECT blog_entry.*, (pub_date > '2006-01-01')
FROM blog_entry;

次の例はもっと高度です。この例では、 Blog オブジェクトに関連づけら れている Entry オブジェクトの個数を表す整数を、 Blog オブジェク トの entry_count 属性に持たせるためにサブクエリを実行しています:

Blog.objects.extra(
    select={
        'entry_count': 'SELECT COUNT(*) FROM blog_entry ' \
                       'WHERE blog_entry.blog_id = blog_blog.id'
    },
)

(上の場合では、クエリの FROM 節に blog_blog が入るという事実を 利用しています。)

上の例の場合、 SQL は以下のようになります:

SELECT blog_blog.*, (SELECT COUNT(*) FROM blog_entry WHERE blog_entry.blog_id = blog_blog.id)
FROM blog_blog;

ほとんどのデータベースエンジンでは、サブセレクションの周りに丸括弧が必 要ですが、Django の select 節では必要ないということに注意してくださ い。また、 MySQL の一部のバージョンのように、データベースバックエンドに よってはサブクエリをサポートしないので注意してください。

開発版の Django で新たに追加された機能 ごく稀に、 extra(select=...) に指定する SQL にパラメタを渡したい場 場合があります。そんなときは select_params パラメタを使ってください。 ただし、 select_params はシーケンス型で、 select は辞書なので、 select= の中でパラメタが正しく一致するように注意する必要があります。 select に通常の辞書型を渡す代わりに django.utils.datastructures.SortedDict を指定すれば、こうした状況を うまく扱えます。

例えば、以下のコードは期待通りに動作します:

Blog.objects.extra(
    select=SortedDict(('a', '%s'), ('b', '%s')),
    select_params=('one', 'two'))

where / tables

明示的に追加の WHERE 節を渡す必要がある場合 -- おそらく非明示的な結 合を行っている場合 -- には、 where キーワードを使って下さい。 tables を使えば、 SQL の FROM 節に手動でテーブル名を追加できま す。

where や tables は、ともに文字列のリストを引数にとります。 where パラメタの内容は全て、多の検索条件と "AND" で結合されます。

例えば:

Entry.objects.extra(where=['id IN (3, 4, 5, 20)'])

は、(大雑把にいって) 以下のような SQL 文に変換されます:

SELECT * FROM blog_entry WHERE id IN (3, 4, 5, 20);

tables パラメタを使う場合、クエリ中にすでに登場しているテーブルを指 定していないか注意が必要です。 tables パラメタに追加のテーブル名を 指定して、それがすでにクエリ中に含まれているテーブルであった場合、 Django はユーザがそのテーブルをさらに加えようとしているものとみなします。 その場合、追加されたテーブルの名前にはエイリアスがつけられるので、問題 を引き起こします。 SQL 文の中に同じテーブルを複数回登場させる場合、デー タベースがそれぞれのテーブルを区別できるように、2度目以降のテーブル名に はエイリアスをつけねばなりません。そのため、 where パラメタにすでに クエリ中に存在するテーブル名を渡すと、エラーを引き起こすのです。

通常は、すでにクエリ中に存在するテーブル名を追加するような作業はしない はずです。しかし、上で述べたようなことが起きてしまう場合には、いくつか 解決方法があります。まず、追加でテーブル名を指定しなくても正しくクエリ を実行できるか試してください。それがだめなら、クエリセットを構築する際 に、 extra() を先に呼び出して、テーブル名を最初に登場させてみてく ださい。最後に、どうしてもうまくいかないのなら、生成されるクエリを見て、 where を書き直し、テーブル名にエイリアスを与えてみてください。 エイリアスは同じ方法でクエリセットを生成している限り同じ名前を持つので、 エイリアス名は変化しないものとして扱えます。

order_by

クエリセットの評価結果を、 extra() に入れたフィールドやテーブルに基 づいて並べ替えたい場合は、 extra() に order_by パラメタを指定し てください。 order_by は文字列のシーケンスで指定します。各文字列は (order_by() メソッドで指定するような) モデルフィールド名か、 table_name.column_name 形式か、 extra() の select パラメ タに指定したカラムのエイリアスのいずれかで指定します。

例を示しましょう:

q = Entry.objects.extra(select={'is_recent': "pub_date > '2006-01-01'"})
q = q.extra(order_by = ['-is_recent'])

上の例は、 is_recent が真であるような結果を先に表示します (True よりも False が先にくるのは降順のときだからです)。

ちなみに、上の例でわかるように、 extra() は何度も呼び出しできます。 (その度に、制約条件が追加されてゆきます)。

params

上で説明した where パラメタでは、標準の Python の文字列プレースホル ダ '%s' を使って、データベースエンジンが自動的にパラメタをクオート するよう指示できます。 params 引数には、プレースホルダで置き換えら れるパラメタのリストを指定します。

例えば:

Entry.objects.extra(where=['headline=%s'], params=['Lennon'])

where の中に直接値を埋め込まず、常に params を使うようにしてく ださい。というのも、 params を使えば、バックエンド固有の方法でパラ メタの値を正しくクオートするからです。 (例えば引用符文字などを正しくエ スケープします)

悪い例:

Entry.objects.extra(where=["headline='Lennon'"])

良い例:

Entry.objects.extra(where=['headline=%s'], params=['Lennon'])

select や where の中に入れるプレースホルダの個数合計と、 params リストに入れる値の個数は一致させねばなりません。

開発版の Django で新たに追加された機能 extra() の引数として、 新たに select_params が追加されました。以前は、 params を使って select のパラメタを渡そうとするしかありませんでしたが、その挙動はあまり 信頼できませんでした。

get(**kwargs)

照合パラメタに一致するオブジェクトを返します。照合パラメタは後述の フィールドの照合 で説明するフォーマットにします。

AssertionError

複数のオブジェクトが見つかった場合、 get() は MultipleObjectsReturned を送出します。 MultipleObjectsReturned 例外は、モデルクラスの属性です。例えば、以下の ようなコードで 'John' という名前の作者が複数見つかると、 MultipleObjectsReturned が送出されます:

Author.objects.get(name='John') # raises Author.MultipleObjectsReturned

指定パラメタに対するオブジェクトが見つからなかった場合には DoesNotExist 例外を送出します。 DoesNotExist 例外はモデルクラスの属性の一つです。 例えば:

Entry.objects.get(id='foo') # raises Entry.DoesNotExist

DoesNotExist 例外は django.core.exceptions.ObjectDoesNotExist を継 承しているので、複数の DoesNotExist 例外を except: のターゲットにで きます。例えば:

from django.core.exceptions import ObjectDoesNotExist
try:
    e = Entry.objects.get(id=3)
    b = Blog.objects.get(id=1)
except ObjectDoesNotExist:
    print "Either the entry or blog doesn't exist."

create(**kwargs)

ワンステップでオブジェクトを生成して保存するための便宜メソッドです。 すなわち、以下の文:

p = Person.objects.create(first_name="Bruce", last_name="Springsteen")

と、以下の文:

p = Person(first_name="Bruce", last_name="Springsteen")
p.save()

は等価です。

get_or_create(**kwargs)

kwargs に指定したオブジェクトを照合し、なければ生成するための便宜メソッドで す。

(object, created) の形式のタプルを返します。 object は取得または作 成されたオブジェクトであり、 created はブール値で、オブジェクトが新たに 生成されたかどうかを示します。

このメソッドは、お決まりのコードを書く上でのショートカットとして定義されて おり、データを取り込むスクリプトを書くときに便利です。例えば:

try:
    obj = Person.objects.get(first_name='John', last_name='Lennon')
except Person.DoesNotExist:
    obj = Person(first_name='John', last_name='Lennon', birthday=date(1940, 10, 9))
    obj.save()

このようなコードパターンでは、モデル中のフィールドが増えると手に負えなくな ります。 get_or_create() を使うと、上のコード例は以下のように書き直せま す:

obj, created = Person.objects.get_or_create(first_name='John', last_name='Lennon',
                  defaults={'birthday': date(1940, 10, 9)})

get_or_create() に渡されたキーワード引数は、 (オプションの引数である defaults を除いて) 全て get() の呼び出し時の引数として渡されます。 オブジェクトが見つかった場合、 get_or_create() は見つかったオブジェクト と False を返します。オブジェクトが 見つからなかった 場合、新たに生成 されたオブジェクトと True を返します。新たなオブジェクトは以下のアルゴ リズムで作成されます:

defaults = kwargs.pop('defaults', {})
params = dict([(k, v) for k, v in kwargs.items() if '__' not in k])
params.update(defaults)
obj = self.model(**params)
obj.save()

上のコードを日本語で表すなら、まず 'defaults' でないキーワード引数のう ち、二重アンダースコアを含まないもの (二重アンダースコアはあいまい照合のキー ワードなので除外します) を使ってパラメタ params を作成し、必要に応じて デフォルト値 defaults で内容を更新して、その結果をモデルクラスを呼び出 すときのキーワード引数に使います。

defaults という名前のフィールド名を持っていて、 get_or_create() の 中で厳密照合に使いたければ、以下のように 'defaults__exact' を使います:

Foo.objects.get_or_create(defaults__exact='bar', defaults={'defaults': 'baz'})

最後に、 Django ビューの中で get_or_create() を使う場合についてひとこと 注意しておきましょう。上で説明したように、主として get_or_create() が有 用なのは、データを解析し、該当する既存のデータが存在しない場合に新たなレコー ドを生成するようなスクリプトを書く場合です。ビューで get_or_create() を 使いたいのなら、特に理由のない限り POST リクエスト中で使うようにしましょ う。一般論として、 GET リクエストの処理中ではデータに影響を及ぼすべきで はありません。データに副作用をもたらすようなページのリクエストには常に POST を使うようにしましょう。詳しくは、 HTTP 仕様における 安全なメソッド を参照してください。

count()

クエリセットに一致するデータベース上のオブジェクトの個数を表す整数を返しま す。 count() は例外を送出しません。

例えば:

# データベース中のエントリの総数を返します。
Entry.objects.count()

# ヘッドラインが 'Lennon' を含むエントリの総数を返します。
Entry.objects.filter(headline__contains='Lennon').count()

count() は背後で SELECT COUNT(*) を実行するので、単にオブジェクトの 個数を数えたい場合には、全てのレコードを Python オブジェクトとしてロードし てから len() を呼び出すのではなく、常に count() を使うようにしてく ださい。

(PostgreSQL や MySQL といった) どのデータベースを使っているかによって、戻り 値が Python の通常の整数型ではなく、長整数になることもあります。これは実装 上の問題であり、現実的に問題になることはありません。

in_bulk(id_list)

主キーの値のリストを引数にとり、各主キー値とオブジェクトを対応づけた辞書を 返します。

例えば:

>>> Blog.objects.in_bulk([1])
{1: Beatles Blog}
>>> Blog.objects.in_bulk([1, 2])
{1: Beatles Blog, 2: Cheddar Talk}
>>> Blog.objects.in_bulk([])
{}

in_bulk() に空のリストを渡すと空の辞書を返します。

iterator()

QuerySet を評価し (クエリを実行し) て、その結果の入った イテレータ を返します。 QuerySet は通常、最初にアクセスした時点で、全ての検索結果 を読み込んで、対応するオブジェクトのインスタンスを生成してしまいます。 一方、 iterator() は、離散的なチャンク単位で検索結果を読み出し、オブジェ クトをインスタンス化して、一度に一つづつ yield します。 QuerySet は膨大 な数のオブジェクトを返す場合があるので、その場合には iterator() を使う ことでパフォーマンスを改善し、メモリの使用量を劇的に減らせます。

すでに値にアクセス済みの QuerySet に対して iterator() を呼び出すと、 値の評価が再度行われ、クエリが繰り返し発行されるので注意してください。

latest(field_name=None)

日付フィールドである field_name の値に応じて、テーブル中の最新のオブジェ クトを返します。

以下の例では、 pub_date フィールドに応じて、テーブル中の最新の Entry を返します:

Entry.objects.latest('pub_date')

モデルの Meta で get_latest_by を指定している場合、 latest() の field_name 引数は省略できます。 Django は get_latest_by に指定し たフィールドをデフォルト値にします。

get() と同様、 latest() は指定パラメタに一致するオブジェクトがない 場合に DoesNotExist を送出します。

latest() は純粋に利便性と可読性のためだけに存在しています。

exact

厳密な一致です、比較対象の値を None にすると、SQL における NULL と の比較として扱われます (詳しくは isnull を参照してください)。

例:

Entry.objects.get(id__exact=14)
Entry.objects.get(id__exact=None)

等価な SQL 文:

SELECT ... WHERE id = 14;
SELECT ... WHERE id IS NULL;

開発版の Django で新たに追加された機能: 開発版では、 id__exact=None のセマンティクスが変更されました。以前は SQL レベルで (意図的に) WHERE id = NULL に置き換えられていましたが、この SQL はいかなるレコード にもマッチしません。開発版では、 id__isnull=True と同じ挙動を示すように 変更されています。

iexact

大小文字の区別をしない一致です。

例:

Blog.objects.get(name__iexact='beatles blog')

等価な SQL 文:

SELECT ... WHERE name ILIKE 'beatles blog';

この例は、 'Beatles Blog', 'beatles blog', 'BeAtLes BLoG' などにマッチします。

contains

大小文字を区別する包含テストです。

例:

Entry.objects.get(headline__contains='Lennon')

等価な SQL 文:

SELECT ... WHERE headline LIKE '%Lennon%';

この例では、 'Today Lennon honored' というヘッドラインには一致しますが、 'today lennon honored' には一致しません。

SQLite は大小文字を区別する LIKE をサポートしないので、 contains は icontains と同じになります。

icontains

大小文字を区別しない包含テストです。

例:

Entry.objects.get(headline__icontains='Lennon')

等価な SQL 文:

SELECT ... WHERE headline ILIKE '%Lennon%';

gt

より大きい値に一致します。

例:

Entry.objects.filter(id__gt=4)

等価な SQL 文:

SELECT ... WHERE id > 4;

gte

等しいか、より大きい値に一致します。

lt

より少ない値に一致します。

lte

等しいか、より少ない値に一致します。

in

指定のリストに入っているものに一致します。

例:

Entry.objects.filter(id__in=[1, 3, 4])

等価な SQL 文:

SELECT ... WHERE id IN (1, 3, 4);

リテラル値のリストを渡す代わりに、クエリセットを使って動的なリストとして評 価してもかまいません。クエリセットは values() メソッドを使って個々のオ ブジェクト値からなるリストに変換できねばならず、 query 属性を使ってクエ リセットに変換してから渡さねばなりません:

Entry.objects.filter(blog__in=Blog.objects.filter(name__contains='Cheddar').values('pk').query)

上のクエリセットを評価すると、以下の SQL 文のようになります:

SELECT ... WHERE blog.id IN (SELECT id FROM ... WHERE NAME LIKE '%Cheddar%')

startswith

大小文字を区別する starts-with です。

例:

Entry.objects.filter(headline__startswith='Will')

等価な SQL 文:

SELECT ... WHERE headline LIKE 'Will%';

SQLite は大小文字を区別する LIKE をサポートしないので、 startswith は istartswith と同じになります。

istartswith

大小文字を区別しない starts-with です。

例:

Entry.objects.filter(headline__istartswith='will')

等価な SQL 文:

SELECT ... WHERE headline ILIKE 'Will%';

endswith

大小文字を区別する ends-with です。

例:

Entry.objects.filter(headline__endswith='cats')

等価な SQL 文:

SELECT ... WHERE headline LIKE '%cats';

SQLite は大小文字を区別する LIKE をサポートしないので、 endswith は iendswith と同じになります。

iendswith

大小文字を区別しない ends-with です。

例:

Entry.objects.filter(headline__iendswith='will')

等価な SQL 文:

SELECT ... WHERE headline ILIKE '%will'

range

範囲テスト (閉包テスト) です。

例:

start_date = datetime.date(2005, 1, 1)
end_date = datetime.date(2005, 3, 31)
Entry.objects.filter(pub_date__range=(start_date, end_date))

等価な SQL 文:

SELECT ... WHERE pub_date BETWEEN '2005-01-01' and '2005-03-31';

range は日付、数値、文字など、SQL で BETWEEN を使える場所ならどこで も使えます。

year

date/datetime フィールドにおける、 year の厳密一致です。

例:

Entry.objects.filter(pub_date__year=2005)

等価な SQL 文:

SELECT ... WHERE EXTRACT('year' FROM pub_date) = '2005';

(厳密な SQL シンタクスはデータベースエンジンによって違います。)

month

date/datetime フィールドにおける、 month の厳密一致です。 1 (1月) から 12 (12 月) までの整数を引数にとります。

例:

Entry.objects.filter(pub_date__month=12)

等価な SQL 文:

SELECT ... WHERE EXTRACT('month' FROM pub_date) = '12';

(厳密な SQL シンタクスはデータベースエンジンによって違います。)

day

date/datetime フィールドにおける、 day の厳密一致です。

例:

Entry.objects.filter(pub_date__day=3)

等価な SQL 文:

SELECT ... WHERE EXTRACT('day' FROM pub_date) = '3';

(厳密な SQL シンタクスはデータベースエンジンによって違います。) このクエリ文は、「1 月 3 日」や「7 月 3 日」のように、毎月 3 日、にマッチし ます。

isnull

True または False を引数にとり、それぞれが IS NULL および IS NOT NULL に対応しています。

例:

Entry.objects.filter(pub_date__isnull=True)

等価な SQL 文:

SELECT ... WHERE pub_date IS NULL;

search

全文インデクスを活用した全文検索で、ブール値を返します。このメソッドは contains に似ていますが、全文インデクスを使うためはるかに高速です。

この機能は MySQL でだけ利用可能です。また、全文インデクスを追加するにはデー タベースを直接操作する必要があります。

regex

開発版の Django で新たに追加された機能です

正規表現による大小文字を区別した検索を行います。

正規表現の構文は各データベースバックエンドで使われているものと同じです。 正規表現による照合をサポートしない sqlite バックエンドの場合に、Python の re モジュールと同じ構文を使います。

使い方の例を示します:

Entry.objects.get(title__regex=r'^(An?|The) +')

同じ意味の SQL 文は以下のようになります:

SELECT ... WHERE title REGEXP BINARY '^(An?|The) +'; -- MySQL

SELECT ... WHERE REGEXP_LIKE(title, '^(an?|the) +', 'c'); -- Oracle

SELECT ... WHERE title ~ '^(An?|The) +'; -- PostgreSQL

SELECT ... WHERE title REGEXP '^(An?|The) +'; -- SQLite

正規表現を指定する場合には raw 文字列を使う ('foo' でなく r'foo' を 使う)よう勧めます。

iregex

開発版の Django で新たに追加された機能です

正規表現による大小文字を区別しない検索を行います。

使い方の例を示します:

Entry.objects.get(title__iregex=r'^(an?|the) +')

同じ意味の SQL 文は以下のようになります:

SELECT ... WHERE title REGEXP '^(an?|the) +'; -- MySQL

SELECT ... WHERE REGEXP_LIKE(title, '^(an?|the) +', 'i'); -- Oracle

SELECT ... WHERE title ~* '^(an?|the) +'; -- PostgreSQL

SELECT ... WHERE title REGEXP '(?i)^(an?|the) +'; -- SQLite

多値のリレーションをスパンする

開発版の Django で新たに追加された機能です

ManyToManyField や ForeignKey の逆リレーションを使ってフィルタを行 う場合、 2 種類の異なるフィルタ方法があります。 Blog / Entry のリレー ション (Blog から Entry が 1 対多であるようなリレーション) を考えて みましょう。このようなモデルでは、例えばヘッドラインに 'Lennon' を含み、 かつ 今日公開されたエントリを持つようなブログを検索したい場合があるでしょ う。あるいは、ヘッドラインに 'Lennon' を含むか、 あるいは 今日公開さ れたエントリを含むようなブログの検索もあり得ます。複数のエントリが一つの Blog に関連付けられているので、いずれのクエリも実行可能ですし、意味をな す場合があるでしょう。

ManyToManyField を使っている場合にも、同じような状況が起こります。例え ば、 Entry に tags という名前の ManyToManyField があり、 'music' や 'band' というタグに関連付けられたエントリを検索したい場合や、 'music' タグのついた 'public' 状態のエントリを取り出したい場合があるで しょう。

こうした状況をうまく扱うために、 Django には filter() および exclude() といった呼び出しがあります。 filter() に指定した条件は同 時に適用され、条件全てに一致する要素をフィルタします。 filter() を連続 して呼び出すと、通常はオブジェクトの集合により狭い制約をかけますが、多値リ レーションの場合、新たな制約は、前の filter() で絞り込んだリレーション 先をさらに絞り込むのではなく、前の filter() で絞り込んだリレーション先 にリンクしているリレーション元からリレーションを張られている全てのオブジェ クトに対して適用されてしまいます。

この話はちょっとややこしいので、例を挙げて解説しましょう。 'Lennon' をヘッ ドラインに含み、今日公開されたエントリを含むブログを選択するには、以下の ように書きます:

Blog.objects.filter(entry__headline__contains='Lennon',
        entry__pub_date=datetime.date.today())

一方、 'Lennon' をヘッドラインに含むか、 あるいは 今日公開されたエン リを含むブログを検索するには、以下のように書きます:

Blog.objects.filter(entry__headline__contains='Lennon').filter(
        entry__pub_date=datetime.date.today())

後者の例では、最初の filter() でクエリセットに制約をかけ、特定のエント リにリンクを持つブログだけを取り出しています。次の filter() では、取り 出した Blog オブジェクトから、 さらに 二つ目の条件に合うものに制約を かけています。従って、二つ目の filter() で制約をかけている対象の entry は、最初のフィルタで絞り込んだエントリと同じとも、違うとも言い切 れません。一つめの filter() でフィルタしているのはあくまでも Blog であって、 Entry ではないからです。

この挙動は、 exclude() にもあてはまります。一つの exclude() に指定 した条件は、 (多値リレーションの場合は) 各インスタンスに同時に適用されます。 filter() や exclude() を連続して呼び出すと、毎回違うリンク先集合を 使ってフィルタを行ってしまう可能性があるのです。

順方向

モデルに ForeignKey フィールドがある場合、そのモデルのインスタンスは、 単に属性を使ってリレーション先 (外部) のオブジェクトを参照できます。

例:

e = Entry.objects.get(id=2)
e.blog # リレーション先の Blog オブジェクトを返します。

外部キー属性の値は取得 (get) も設定 (set) もできます。当然ながら、外部キー への変更は save() を呼び出すまでデータベースに反映されません。

例:

e = Entry.objects.get(id=2)
e.blog = some_blog
e.save()

ForeignKey フィールドに null=True が設定されていた場合 (NULL 値 を許している場合)、以下の例のように None を代入できます:

e = Entry.objects.get(id=2)
e.blog = None
e.save() # "UPDATE blog_entry SET blog_id = NULL ...;"

一対多のリレーションにおける順方向のアクセスは、リレーション先のオブジェク トに最初にアクセスした際にキャッシュされます。それ以降のアクセスでは、同じ オブジェクトインスタンスの外部キーへのアクセスはキャッシュされた値を返しま す。例えば:

e = Entry.objects.get(id=2)
print e.blog  # データベースを検索して、関連づけられた Blog を返します。
print e.blog  # データベースは検索せず、キャッシュを使います。

クエリセットのメソッド select_related() を使うと、一対多のリレーション のリレーション先オブジェクト全てをあらかじめ再帰的にキャッシュに取り込みま す。例えば:

e = Entry.objects.select_related().get(id=2)
print e.blog  # Doesn't hit the database; uses cached version.
print e.blog  # Doesn't hit the database; uses cached version.

select_related() のドキュメントは、前述の 「 新たなクエリセットを返すクエリセットメソッド 」の節にあります。

逆方向

あるモデルが ForeignKey で別のモデルにリレーションを張っている場合、リ レーションを張られた側のモデルのインスタンスは、リレーションを張った側のモ デルの全てのインスタンスを返すマネジャにアクセスできるようになります。リレー ションを張っている側のモデル名を全て小文字にしたものを FOO とすると、マ ネジャの名前のデフォルト値は FOO_set になります。このマネジャはクエリセッ トを返します。クエリセットには前述の「オブジェクトの取得」の節で説明したフィ ルタや操作を行えます。

例:

b = Blog.objects.get(id=1)
b.entry_set.all() # Blog に関連づけられた全ての Entry を返します。

# b.entry_set はクエリセットを返すマネジャです。
b.entry_set.filter(headline__contains='Lennon')
b.entry_set.count()

ForeignKey を定義するときに related_name パラメタを設定しておくと、 FOO_set の名前をオーバライドできます。例えば、 Entry モデルの定義を blog = ForeignKey(Blog, related_name='entries') のように改めると、上の コード例は以下のようになります:

b = Blog.objects.get(id=1)
b.entries.all() # Blog に関連づけられた全ての Entry を返します。

# b.entries はクエリセットを返すマネジャです。
b.entries.filter(headline__contains='Lennon')
b.entries.count()

ForeignKey のマネジャへの逆のアクセスはできません。 ForeignKey はイ ンスタンスとしてアクセスせねばなりません。例えば:

# AttributeError: "Manager must be accessed via instance" を送出します。
Blog.entry_set

前述の「オブジェクトの取得」で説明したクエリセットのメソッドに加えて、 ForeignKey を介したマネジャは以下の追加のメソッドを備えています:

• add(obj1, obj2, ...): 指定のモデルオブジェクトをリレーション先オ ブジェクトのセットに加えます。

  例:

  b = Blog.objects.get(id=1)
  e = Entry.objects.get(id=234)
  b.entry_set.add(e) # Associates Entry e with Blog b.
  

• create(**kwargs): 新たなオブジェクトを作成し、保存して、リレーショ ン先オブジェクトのセットに加えます。作成したオブジェクトを返します。

  例:

  b = Blog.objects.get(id=1)
  e = b.entry_set.create(headline='Hello', body_text='Hi',
      pub_date=datetime.date(2005, 1, 1))
  # 自動的に save() されるので、 e.save() を呼ぶ必要はありません。
  

  これは以下の操作と同じです (ただし前者の方が簡潔です):

  b = Blog.objects.get(id=1)
  e = Entry(blog=b, headline='Hello', body_text='Hi',
      pub_date=datetime.date(2005, 1, 1))
  e.save()
  

  モデルからオブジェクトを作成するときに、リレーションを定義するための キーワード引数を必要としないことに注意して下さい。上の例では、 create() に blog パラメタを渡していません。 Django は Entry オブジェクトの blog フィールドの値が b であることを 自分で判別します。

• remove(obj1, obj2, ...): リレーション先オブジェクトのセットから、 指定のオブジェクトを除去します。

  例:

  b = Blog.objects.get(id=1)
  e = Entry.objects.get(id=234)
  b.entry_set.remove(e) # Blog b から Entry e を除去します。
  

  データベースの一貫性を壊さないようにするため、このメソッドは null=True である ForeignKey オブジェクトでしか使えません。リ レーション先のフィールドを None (NULL) にできない場合、あるオ ブジェクトを削除しようとしたときに、必ず何らかの別のオブジェクトに追 加せねばならなくなるからです。上の例では、 b.entry_set() から e を除去する操作は e.blog = None と同じになり、 外部キー blog が null=True でないために無効な操作になります。

• clear(): リレーション先オブジェクトのセットから全てのオブジェクト を除去します。

  例:

  b = Blog.objects.get(id=1)
  b.entry_set.clear()
  

  リレーション先のオブジェクト全てを削除するわけではありません。単にリ レーションを解除するだけです。

  remove() や clear() と同様、 null=True であるような外部キー でしか使えません。

リレーション先セットのメンバを一括で代入するには、イテレーション可能オブジェ クトを代入します。例えば:

b = Blog.objects.get(id=1)
b.entry_set = [e1, e2]

clear() メソッドを利用できる場合、イテレーション可能オブジェクト (上の 例ではリスト) からオブジェクトを entry_set に追加する前に、代入先のセッ トに既に存在するオブジェクトを全て除去します。 clear() メソッドを利用 できない 場合、既に存在するオブジェクトを削除せず、単にイテレーション可能 オブジェクト上の全てのオブジェクトを追加します。

この節で説明した「逆方向の」操作は、いずれもデータベースを即時変更します。 操作結果は追加、新規作成、削除といった操作を行う度に即座に自動的にデータベー スに保存されます。