コードから発行されたクエリを理解して制御するために、Django は、データベースクエリの実行周辺にラッパー関数をインストールするためのフックを提供しています。たとえば、ラッパーは、クエリのカウント、クエリの実行時間の測定、クエリのログ、さらにクエリの実行の防止までもできます (たとえば、プリフェッチされたデータを使用してテンプレートをレンダリングする間にクエリが発行されないようにするため)。
\nラッパーは ミドルウェア にならったもので、別の呼び出し可能オブジェクトを引数の1つとして受け取ります。ラッパーはデータベースクエリ(ラップされている可能性があります)を呼び出すために callable を呼び出します。しかし、これらはユーザーコードによって作成され、インストールされるため、ミドルウェアのように個別のファクトリを必要としません。
\nラッパーのインストールは、コンテキストマネージャで行われます。そのため、ラッパーは一時的なもので、コード内の特定のフローに特化したものです。
\n前述したように、ラッパーの例はクエリ実行ブロッカーです。以下のようなものです:
\ndef blocker(*args):\n raise Exception("No database access allowed here.")\nそして、テンプレートからのクエリをブロックするには、ビューでこのように使用します:
\nfrom django.db import connection\nfrom django.shortcuts import render\n\n\ndef my_view(request):\n context = {...} # Code to generate context with all data.\n template_name = ...\n with connection.execute_wrapper(blocker):\n return render(request, template_name, context)\nラッパーに送られるパラメーターは以下の通りです:
\nexecute -- クエリを実行するために、残りのパラメータと一緒に呼び出される呼び出し可能オブジェクト。
sql -- データベースに送信する SQL クエリの str。
params -- SQL コマンドのパラメータ値のリストまたはタプル、または、ラップされた呼び出しが executemany() の場合はリストまたはタプルのリストまたはタプル。
many -- 最終的に呼び出すのが execute() なのか executemany() なのかを示す bool (params が値のシーケンスなのか、値のシーケンスのシーケンスなのかを示します)。
context -- 呼び出しのコンテキストに関するデータを含む辞書。これにはコネクションとカーソルが含まれます。
このパラメータを使用することで、次のように、もう少し複雑なバージョンのブロッカーで、エラーメッセージにコネクション名を含めることができます。
\ndef blocker(execute, sql, params, many, context):\n alias = context["connection"].alias\n raise Exception("Access to database '{}' blocked here".format(alias))\nより完全な例として、クエリロガーは次のようになります。
\nimport time\n\n\nclass QueryLogger:\n def __init__(self):\n self.queries = []\n\n def __call__(self, execute, sql, params, many, context):\n current_query = {"sql": sql, "params": params, "many": many}\n start = time.monotonic()\n try:\n result = execute(sql, params, many, context)\n except Exception as e:\n current_query["status"] = "error"\n current_query["exception"] = e\n raise\n else:\n current_query["status"] = "ok"\n return result\n finally:\n duration = time.monotonic() - start\n current_query["duration"] = duration\n self.queries.append(current_query)\nこれを使用するには、ロガーオブジェクトを作成し、ラッパーとしてインストールします。
\nfrom django.db import connection\n\nql = QueryLogger()\nwith connection.execute_wrapper(ql):\n do_queries()\n# Now we can print the log.\nprint(ql.queries)\nconnection.execute_wrapper()Link to this heading#入力すると、データベースクエリ実行の周囲にラッパーをインストールし、終了するとラッパーを削除するコンテキストマネージャを返します。ラッパーはスレッドローカルのコネクションオブジェクトにインストールされます。
\nwrapper は5つの引数を取る呼び出し可能オブジェクトです。 上記のように、 execute, sql, params, many, context を引数として、コンテキストマネージャのスコープ内でクエリを実行するたびに呼び出されます。 execute(sql、params、many、context) を呼び出して、その戻り値を返すことが期待されます。