Plugin Usage¶
The plugin supports some optional parameters that are defined below.
Customizing the Save Path¶
--django-db-bench=PATH
Output file for storing the results. Default: .pytest-queries
Backing Up Results¶
The easiest way is to run the django-queries backup
command which will create a copy of the current results.
Another way is by passing the --django-backup-queries
parameter to backup previous results to .pytest-django.old`.
Or pass a custom path.
--django-backup-queries=[PATH]
Whether the old results should be backed up or not before overriding.
Running Tests Separately¶
To only run the count_queries
marked tests and nothing else, you can run pytest -v -m count_queries
.
CLI Usage¶
Usage: django-queries [OPTIONS] COMMAND [ARGS]...
Command line tool for pytest-django-queries.
Options:
--help Show this message and exit.
Commands:
html Render the results as HTML instead of a raw table.
show View a given rapport.
The HTML Command¶
Usage: django-queries html [OPTIONS] [INPUT_FILE] [-o OUTPUT FILE]
Render the results as HTML instead of a raw table.
Options:
-o The path to save the HTML file into
django-queries.html by default.
You can pass a dash (-) to write to stdout as well.
--template JINJA2_FILE Use a custom jinja2 template for rendering HTML results.
--help Show this message and exit.
The SHOW Command¶
Usage: django-queries show [OPTIONS] [INPUT_FILE]
View a given rapport.
Options: none
The DIFF Command¶
Usage: django-queries diff [OPTIONS] [LEFT_FILE] [RIGHT_FILE]
Render the diff as a console table with colors.
Options: none