django-query-prefixer

Django查询前缀器允许您在Django项目内执行的每个查询前添加注释。这可以用于监控。通过为查询添加自定义前缀，您可以深入了解它们的来源，并可以更有序地跟踪它们的性能。

安装

您可以使用pip安装django-query-prefixer

pip install django-query-prefixer

用法

1. 将您的settings.py中的数据库引擎更改为django_query_prefixer.backends.<database backend>。

DATABASES = {
    "default": {
        "ENGINE": "django_query_prefixer.backends.postgresql",
        "HOST": "127.0.0.1",
        "NAME": "postgres",
        "PASSWORD": "postgres",
        "USER": "postgres",
    }
}

2. (可选) 将django_query_prefixer.middlewares.request_route添加到MIDDLEWARE列表中。此中间件将添加route和view_name前缀到SQL查询中。

MIDDLEWARE = [
    "django_query_prefixer.middlewares.request_route",
    # ... 
]

3. 现在，只要在您的Django项目中执行查询，配置的前缀将自动添加到这些查询中。例如，一个查询如下

User.objects.filter(username='bob')

将执行为

/* view_name=example route=/example */ SELECT ... FROM "auth_user" WHERE ("auth_user"."username" = 'bob')

您可以使用sql_prefixes 上下文管理器向查询添加更多上下文

from django_query_prefixer import sql_prefixes 

with sql_prefixes(user_id=request.user.id, foo="bar"):
    User.objects.filter(username='bob')

/* user_id=X foo=bar view_name=example route=/example */ SELECT ... FROM "auth_user" WHERE ("auth_user"."username" = 'bob')

贡献

欢迎为django-query-prefixer做出贡献！如果您发现了一个错误，想要添加新功能或改进文档，请在该GitHub存储库中打开一个问题或提交一个拉取请求。