Docs: mention performance impact of notification filtering. (#1086)

robsdedude · web-flow · commit f8ec06b2955d · 2023-05-23T09:47:39.000+02:00
diff --git a/packages/core/src/driver.ts b/packages/core/src/driver.ts
@@ -268,7 +268,11 @@ class SessionConfig {
      *
      *
      * Disabling notifications can be done by defining the minimum severity level to 'OFF'.
-     * Default values can be use by omitting the configuration.
+     * At driver level, when omitted, uses the server's default.
+     * At session level, when omitted, defaults to what filters have been configured at driver level.
+     *
+     * Disabling categories or severities allows the server to skip analysis for those, which can speed up query
+     * execution.
      *
      * @example
      * // enabling warning notification, but disabling `HINT` and `DEPRECATION` notifications.
diff --git a/packages/neo4j-driver-deno/lib/core/driver.ts b/packages/neo4j-driver-deno/lib/core/driver.ts
@@ -268,7 +268,11 @@ class SessionConfig {
      *
      *
      * Disabling notifications can be done by defining the minimum severity level to 'OFF'.
-     * Default values can be use by omitting the configuration.
+     * At driver level, when omitted, uses the server's default.
+     * At session level, when omitted, defaults to what filters have been configured at driver level.
+     *
+     * Disabling categories or severities allows the server to skip analysis for those, which can speed up query
+     * execution.
      *
      * @example
      * // enabling warning notification, but disabling `HINT` and `DEPRECATION` notifications.

Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,11 @@ class SessionConfig {`
`268`	`268`	`*`
`269`	`269`	`*`
`270`	`270`	`* Disabling notifications can be done by defining the minimum severity level to 'OFF'.`
`271`		`- * Default values can be use by omitting the configuration.`
	`271`	`+ * At driver level, when omitted, uses the server's default.`
	`272`	`+ * At session level, when omitted, defaults to what filters have been configured at driver level.`
	`273`	`+ *`
	`274`	`+ * Disabling categories or severities allows the server to skip analysis for those, which can speed up query`
	`275`	`+ * execution.`
`272`	`276`	`*`
`273`	`277`	`* @example`
`274`	`278`	* // enabling warning notification, but disabling `HINT` and `DEPRECATION` notifications.