Skip to content

Filtering Performance: Add opt-in setting for converting to string ba… #10038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 26, 2024
Merged

Filtering Performance: Add opt-in setting for converting to string ba… #10038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b1642d7
Filtering Performance: Add opt-in setting for converting to string ba…
Maffooch Apr 26, 2024
9f1900b
Fix ruff error
Maffooch Apr 26, 2024
e43659c
Fix Flake8
Maffooch Apr 26, 2024
9831918
Update unit tests..
Maffooch Apr 26, 2024
fbb7c4f
Correct filter
Maffooch Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/content/en/usage/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ draft: false
weight: 4
---

## Filter String Matching Optimization

IN the UI, many of the filters for a given object will also query related objects
for an easy visual match of an item to filter on. For instances with many objects,
this could lead to a considerable performance hit. To alleviate this constriction,
enable the "Filter String Matching Optimization" setting in the System Settings to
change many filters to only search on names, rather than the objects themselves.
This change will save many large queries, and will improve the performance of UI
based interactions.

## Asynchronous Import

DefectDojo offers an experimental feature to aynschronously import security reports.
Expand Down
18 changes: 18 additions & 0 deletions dojo/db_migrations/0210_system_settings_filter_string_matching.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Generated by Django 4.1.13 on 2024-04-25 18:22

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('dojo', '0209_alter_finding_severity'),
]

operations = [
migrations.AddField(
model_name='system_settings',
name='filter_string_matching',
field=models.BooleanField(default=False, help_text='When turned on, all filter operations in the UI will require string matches rather than ID. This is a performance enhancement to avoid fetching objects unnecessarily.', verbose_name='Filter String Matching Optimization'),
),
]
Loading