Django's database layer provides various ways to help developers get the most\nout of their databases. This document gathers together links to the relevant\ndocumentation, and adds various tips, organized under a number of headings that\noutline the steps to take when attempting to optimize your database usage.
\n一般的なプログラミング手法と同様に、これは言うまでもないことです。どんなクエリを実行し何がコストなのか を判別してください。QuerySet.explain() を使用し、データベース上で特定の QuerySet がどのように実行されるかを理解してください。また、django-debug-toolbar といった外部のプロジェクトや、データベースを直接監視するツールを使うのもいいでしょう。
要件に従って、速度またはメモリ、およびその両方を最適化することができます。片方を最適化することは、もう片方に悪影響を及ぼすことがありますが、互いに助けになることもあります。また、データベースプロセスによって行われる処理と Python のプロセスによる処理は (あなたにとって) 必ずしも同等のコストとはなりません。その優先順位とバランスを決めるのはあなた自身です。そして、その設計はアプリケーションやサーバーに依存するため、要求通りに設計するのもあなたの仕事です。
\n以下で紹介する項目すべてにおいて、あらゆる変更の後に忘れずに分析を行い、施した変更が有益だったこと、およびその恩恵が可読性の低下を十分上回ることを確認してください。以下の すべて の提案において、一般的な原則があなたの状況に当てはまらない可能性があること、それどころか逆効果になりかねない可能性さえあることに十分注意してください。
\n以下のようなものが上げられます:
\nIndexes. This is a number one priority, after you have determined from\nprofiling what indexes should be added. Use\nMeta.indexes or\nField.db_index to add these from\nDjango. Consider adding indexes to fields that you frequently query using\nfilter(),\nexclude(),\norder_by(), etc. as indexes may help\nto speed up lookups. Note that determining the best indexes is a complex\ndatabase-dependent topic that will depend on your particular application.\nThe overhead of maintaining an index may outweigh any gains in query speed.
フィールドタイプの適切な使用。
We will assume you have done the things listed above. The rest of this document\nfocuses on how to use Django in such a way that you are not doing unnecessary\nwork. This document also does not address other optimization techniques that\napply to all expensive operations, such as general purpose caching.
\nQuerySet を理解するLink to this heading#QuerySet を理解することは、シンプルなコードでパフォーマンスを上げるために極めて重要です。特に:
\nQuerySet の評価を理解するLink to this heading#パフォーマンスの問題を回避するには、以下を理解することが重要です:
\nQuerySet は lazy であること。
どのように データがメモリ上に保持されるか。
QuerySet 全体をキャッシュすることに加えて、ORM オブジェクトの属性の結果のキャッシングも存在します。通常、呼び出し可能ではない属性はキャッシュされます。例として、 Weblog モデルの例 を考えてみましょう:
>>> entry = Entry.objects.get(id=1)\n>>> entry.blog # Blog object is retrieved at this point\n>>> entry.blog # cached version, no DB access\nその一方で、通常呼び出し可能な属性は毎回 DB の検索を引き起こします:
\n>>> entry = Entry.objects.get(id=1)\n>>> entry.authors.all() # query performed\n>>> entry.authors.all() # query performed again\nテンプレート上のコードを読む際には注意が必要です - テンプレートシステムは括弧を許容していませんが、呼び出し可能なオブジェクトは自動的に呼び出されるので、上記の区別が隠れてしまいます。
\n独自のプロパティにも注意が必要です - 必要なときにキャッシングを実装するのはあなた次第です。たとえば cached_property デコレータを使用します。
with テンプレートタグを使用するLink to this heading#QuerySet のキャッシング処理を活用するため、with テンプレートタグの使用が推奨されます。
iterator() を使用するLink to this heading#多くのオブジェクトを扱う際には、QuerySet のキャッシング動作に多くのメモリが使われる可能性があります。この場合、iterator() が有用です。
explain() を使用するLink to this heading#QuerySet.explain() を使うと、使用されているインデックスや結合など、データベースがクエリをどのように実行しているのか、詳細な情報を得られます。この詳細情報は、より効率的になるようにクエリを書き換えたり、パフォーマンスを向上させるために追加できるインデックスを特定するのに役立ちます。
例えば:
\n最も基本的なレベルでは、filter や exclude を使ってデータベース内でフィルタリングを行います。
F expressions を使い、同一モデル内で他のフィールドに基づくフィルタリングを行います。
データベース内の集計をするためアノテーション を使います。
必要な SQL を生成するのに不十分な場合は:
\nRawSQL を使用するLink to this heading#保守性は高くありませんが、より強力な方法は RawSQL 表現です。これにより、SQL を明示的にクエリに追加することができます。これでもまだ不十分な場合は:
モデルの取り出しおよび書き込みをするための独自の SQL を記述します。django.db.connection.queries を使い、Django があなたのために何を書いているのかを理解して、それを元に始めてください。
get() を使って個別オブジェクトを取得する際に、unique や db_index が設定された列を使用するのには 2 つの理由があります。1 つは、データベースインデックスにより受け里が高速になるからです。加えて、複数のオブジェクトが検索にマッチするとクエリは遅くなります; 列にユニーク制限をかけることでこれを完全に防ぐことができます。
したがって、Weblog モデルの例 を使うと:
\n>>> entry = Entry.objects.get(id=10)\n上記は以下よりも高速です:
\n>>> entry = Entry.objects.get(headline="News Item Title")\nこれは、id がデータベースによってインデックス化されていて、ユニークだと保証されているからです。
以下のようにすると非常に遅くなる恐れがあります:
\n>>> entry = Entry.objects.get(headline__startswith="News")\nまず第一に、headline はインデックス化されておらず、データベースのデータ取り出しを遅くします。
そして第二に、この検索では単一のオブジェクトが返されることは保証されません。クエリが 1 つ以上のオブジェクトと一致する場合、すべてのオブジェクトをデータベースから取り出して転送します。この余分な負荷は、100 とか 1000 といった多量のレコードが返されるときには相当な量になります。データベースが複数のサーバーによって構成される場合、ネットワークのオーバーヘッドと待ち時間が発生するため、この負荷はさらに大きくなります。
\nすべての部分を必要とする単一のデータセットの異なる部分に対してデータベースを何度もヒットするのは、一般的に、1 つのクエリですべてを取得するよりも非効率です。 これは、1 つのクエリだけが必要なときにループ内でクエリを実行し、その結果何度もデータベースクエリを実行することになってしまう場合に、特に重要となります。そこで:
\n\nQuerySet.values() や values_list() を使用するLink to this heading#When you only want a dict or list of values, and don't need ORM model\nobjects, make appropriate usage of\nvalues().\nThese can be useful for replacing model objects in template code - as long as\nthe dicts you supply have the same attributes as those used in the template,\nyou are fine.
QuerySet.defer() や only() を使用するLink to this heading#Use defer() and\nonly() if there are database columns\nyou know that you won't need (or won't need in most cases) to avoid loading\nthem. Note that if you do use them, the ORM will have to go and get them in\na separate query, making this a pessimization if you use it inappropriately.
Don't be too aggressive in deferring fields without profiling as the database\nhas to read most of the non-text, non-VARCHAR data from the disk for a single\nrow in the results, even if it ends up only using a few columns. The\ndefer() and only() methods are most useful when you can avoid loading a\nlot of text data or for fields that might take a lot of processing to convert\nback to Python. As always, profile first, then optimize.
QuerySet.count()Link to this heading#...if you only want the count, rather than doing len(queryset).
QuerySet.exists()Link to this heading#...if you only want to find out if at least one result exists, rather than if\nqueryset.
But:
\ncount() and exists()Link to this heading#If you are going to need other data from the QuerySet, evaluate it immediately.
\nFor example, assuming an Email model that has a subject attribute and a\nmany-to-many relation to User, the following code is optimal:
if display_emails:\n emails = user.emails.all()\n if emails:\n print('You have', len(emails), 'emails:')\n for email in emails:\n print(email.subject)\n else:\n print('You do not have any emails.')\nIt is optimal because:
\nSince QuerySets are lazy, this does no database queries if\ndisplay_emails is False.
Storing user.emails.all() in the emails variable allows its result\ncache to be re-used.
The line if emails causes QuerySet.__bool__() to be called, which\ncauses the user.emails.all() query to be run on the database. If there\naren't any results, it will return False, otherwise True.
The use of len(emails) calls QuerySet.__len__(), reusing the result\ncache.
The for loop iterates over the already filled cache.
In total, this code does either one or zero database queries. The only\ndeliberate optimization performed is using the emails variable. Using\nQuerySet.exists() for the if or QuerySet.count() for the count\nwould each cause additional queries.
QuerySet.update() and delete()Link to this heading#Rather than retrieve a load of objects, set some values, and save them\nindividual, use a bulk SQL UPDATE statement, via QuerySet.update(). Similarly, do bulk deletes where possible.
\nNote, however, that these bulk update methods cannot call the save() or\ndelete() methods of individual instances, which means that any custom\nbehavior you have added for these methods will not be executed, including\nanything driven from the normal database object signals.
If you only need a foreign key value, use the foreign key value that is already on\nthe object you've got, rather than getting the whole related object and taking\nits primary key. i.e. do:
\nentry.blog_id\ninstead of:
\nentry.blog.id\nOrdering is not free; each field to order by is an operation the database must\nperform. If a model has a default ordering (Meta.ordering) and you don't need it, remove\nit on a QuerySet by calling\norder_by() with no parameters.
Adding an index to your database may help to improve ordering performance.
\nUse bulk methods to reduce the number of SQL statements.
\nWhen creating objects, where possible, use the\nbulk_create() method to reduce the\nnumber of SQL queries. For example:
Entry.objects.bulk_create([\n Entry(headline='This is a test'),\n Entry(headline='This is only a test'),\n])\n...is preferable to:
\nEntry.objects.create(headline='This is a test')\nEntry.objects.create(headline='This is only a test')\nNote that there are a number of caveats to this method, so make sure it's appropriate\nfor your use case.
When updating objects, where possible, use the\nbulk_update() method to reduce the\nnumber of SQL queries. Given a list or queryset of objects:
entries = Entry.objects.bulk_create([\n Entry(headline='This is a test'),\n Entry(headline='This is only a test'),\n])\nThe following example:
\nentries[0].headline = 'This is not a test'\nentries[1].headline = 'This is no longer a test'\nEntry.objects.bulk_update(entries, ['headline'])\n...is preferable to:
\nentries[0].headline = 'This is not a test'\nentries[0].save()\nentries[1].headline = 'This is no longer a test'\nentries[1].save()\nNote that there are a number of caveats to this method, so make sure it's appropriate\nfor your use case.
When inserting objects into ManyToManyFields, use\nadd() with multiple\nobjects to reduce the number of SQL queries. For example:
my_band.members.add(me, my_friend)\n...is preferable to:
\nmy_band.members.add(me)\nmy_band.members.add(my_friend)\n...where Bands and Artists have a many-to-many relationship.
When inserting different pairs of objects into\nManyToManyField or when the custom\nthrough table is defined, use\nbulk_create() method to reduce the\nnumber of SQL queries. For example:
PizzaToppingRelationship = Pizza.toppings.through\nPizzaToppingRelationship.objects.bulk_create([\n PizzaToppingRelationship(pizza=my_pizza, topping=pepperoni),\n PizzaToppingRelationship(pizza=your_pizza, topping=pepperoni),\n PizzaToppingRelationship(pizza=your_pizza, topping=mushroom),\n], ignore_conflicts=True)\n...is preferable to:
\nmy_pizza.toppings.add(pepperoni)\nyour_pizza.toppings.add(pepperoni, mushroom)\n...where Pizza and Topping have a many-to-many relationship. Note that\nthere are a number of caveats to this method, so make sure it's appropriate\nfor your use case.
When removing objects from ManyToManyFields, use\nremove() with multiple\nobjects to reduce the number of SQL queries. For example:
my_band.members.remove(me, my_friend)\n...is preferable to:
\nmy_band.members.remove(me)\nmy_band.members.remove(my_friend)\n...where Bands and Artists have a many-to-many relationship.
When removing different pairs of objects from ManyToManyFields, use\ndelete() on a\nQ expression with multiple\nthrough model instances to reduce\nthe number of SQL queries. For example:
from django.db.models import Q\nPizzaToppingRelationship = Pizza.toppings.through\nPizzaToppingRelationship.objects.filter(\n Q(pizza=my_pizza, topping=pepperoni) |\n Q(pizza=your_pizza, topping=pepperoni) |\n Q(pizza=your_pizza, topping=mushroom)\n).delete()\n...is preferable to:
\nmy_pizza.toppings.remove(pepperoni)\nyour_pizza.toppings.remove(pepperoni, mushroom)\n...where Pizza and Topping have a many-to-many relationship.