Skip to content

Docs: mention performance impact of warning filtering. #931

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 2 commits into from
May 24, 2023
Merged

Docs: mention performance impact of warning filtering. #931

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f88ebf4
Docs: mention performance impact of warning filtering.
robsdedude May 22, 2023
6734acf
Merge branch '5.0' into warning-filter-performance-impact
robsdedude May 22, 2023
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
4 changes: 4 additions & 0 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,7 @@ Specify the client agent name.
``notifications_min_severity``
------------------------------
Set the minimum severity for notifications the server should send to the client.
Disabling severities allows the server to skip analysis for those, which can speed up query execution.

Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`.ResultSummary.summary_notifications`.

Expand All @@ -650,6 +651,7 @@ Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`
``notifications_disabled_categories``
-------------------------------------
Set categories of notifications the server should not send to the client.
Disabling categories allows the server to skip analysis for those, which can speed up query execution.

Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`.ResultSummary.summary_notifications`.

Expand Down Expand Up @@ -1053,6 +1055,7 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki/preview-features
``notifications_min_severity``
------------------------------
Set the minimum severity for notifications the server should send to the client.
Disabling severities allows the server to skip analysis for those, which can speed up query execution.

Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`.ResultSummary.summary_notifications`.

Expand All @@ -1075,6 +1078,7 @@ Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`
``notifications_disabled_categories``
-------------------------------------
Set categories of notifications the server should not send to the client.
Disabling categories allows the server to skip analysis for those, which can speed up query execution.

Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`.ResultSummary.summary_notifications`.

Expand Down