From f88ebf460973880a4ea909847a28c446d58f6f01 Mon Sep 17 00:00:00 2001 From: Robsdedude Date: Mon, 22 May 2023 11:09:33 +0200 Subject: [PATCH] Docs: mention performance impact of warning filtering. --- docs/source/api.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/api.rst b/docs/source/api.rst index 970d08d28..7e59c72d0 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -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`. @@ -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`. @@ -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`. @@ -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`.