Skip to content

Commit f267a2f

Browse files
authored
Docs: mention performance impact of warning filtering. (#931)
1 parent bb1839c commit f267a2f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/source/api.rst

+4
Original file line numberDiff line numberDiff line change
@@ -628,6 +628,7 @@ Specify the client agent name.
628628
``notifications_min_severity``
629629
------------------------------
630630
Set the minimum severity for notifications the server should send to the client.
631+
Disabling severities allows the server to skip analysis for those, which can speed up query execution.
631632

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

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

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

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

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

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

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

0 commit comments

Comments
 (0)