Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 10 additions & 10 deletions packages/core/src/driver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -271,14 +271,14 @@ class SessionConfig {
* This configuration enables filter notifications by:
*
* * the minimum severity level ({@link NotificationFilterMinimumSeverityLevel})
* * disabling notification categories ({@link NotificationFilterDisabledCategory})
* * disabling notification classification ({@link NotificationFilterDisabledClassification})
*
*
* Disabling notifications can be done by defining the minimum severity level to 'OFF'.
* 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
* Disabling classifications or severities allows the server to skip analysis for those, which can speed up query
* execution.
*
* @example
Expand All @@ -287,9 +287,9 @@ class SessionConfig {
* database: 'neo4j',
* notificationFilter: {
* minimumSeverityLevel: neo4j.notificationFilterMinimumSeverityLevel.WARNING, // or 'WARNING
* disabledCategories: [
* neo4j.notificationFilterDisabledCategory.HINT, // or 'HINT'
* neo4j.notificationFilterDisabledCategory.DEPRECATION // or 'DEPRECATION'
* disabledClassifications: [
* neo4j.notificationFilterDisabledClassification.HINT, // or 'HINT'
* neo4j.notificationFilterDisabledClassification.DEPRECATION // or 'DEPRECATION'
* ]
* }
* })
Expand All @@ -309,18 +309,18 @@ class SessionConfig {
* // or driver.session({ database: 'neo4j', notificationFilter: undefined })
*
* // using default minimum severity level, but disabling 'HINT' and 'UNRECOGNIZED'
* // notification categories
* // notification classifications
* const sessionWithDefaultSeverityLevel = driver.session({
* database: 'neo4j',
* notificationFilter: {
* disabledCategories: [
* neo4j.notificationFilterDisabledCategory.HINT, // or 'HINT'
* neo4j.notificationFilterDisabledCategory.UNRECOGNIZED // or 'UNRECOGNIZED'
* disabledClassifications: [
* neo4j.notificationFilterDisabledClassification.HINT, // or 'HINT'
* neo4j.notificationFilterDisabledClassification.UNRECOGNIZED // or 'UNRECOGNIZED'
* ]
* }
* })
*
* // using default disabled categories, but configuring minimum severity level to 'WARNING'
* // using default disabled classifications, but configuring minimum severity level to 'WARNING'
* const sessionWithDefaultSeverityLevel = driver.session({
* database: 'neo4j',
* notificationFilter: {
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/notification-filter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ type NotificationFilterDisabledCategory = ExcludeUnknown<NotificationCategory>
*/
/**
* Constants that represents the disabled categories in the {@link NotificationFilter}
* @deprecated use {@link notificationFilterDisabledClassification} instead.
*/
const notificationFilterDisabledCategory: EnumRecord<NotificationFilterDisabledCategory> = {
HINT: 'HINT',
Expand All @@ -65,7 +66,7 @@ type NotificationFilterDisabledClassification = ExcludeUnknown<NotificationClass
/**
* Constants that represents the disabled classifications in the {@link NotificationFilter}
*
* @type {notificationFilterDisabledCategory}
* @type {NotificationFilterDisabledClassification}
*/
const notificationFilterDisabledClassification: EnumRecord<NotificationFilterDisabledClassification> = notificationFilterDisabledCategory

Expand Down Expand Up @@ -103,6 +104,7 @@ class NotificationFilter {
* and it must not be enabled at same time.
*
* @type {?NotificationFilterDisabledCategory[]}
* @deprecated use{@link NotificationFilter#disabledClassifications}
*/
this.disabledCategories = undefined

Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/notification.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ type NotificationCategory = 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMAN
* @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN' } NotificationCategory
*/
/**
* Constants that represents the Category in the {@link GqlStatusObject}
* Constants that represents the Category in the {@link Notification}
* @deprecated use {@link notificationClassification} instead.
*/
const notificationCategory: { [key in NotificationCategory]: key } = {
HINT: 'HINT',
Expand Down
20 changes: 10 additions & 10 deletions packages/neo4j-driver-deno/lib/core/driver.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion packages/neo4j-driver-deno/lib/core/notification-filter.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion packages/neo4j-driver-deno/lib/core/notification.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.