Skip to content

Commit 18c3feb

Browse files
angrykoalarsill-neo4jmjfwebb
authored
Apply suggestions from code review
Co-authored-by: Richard Sill <[email protected]> Co-authored-by: Michael Webb <[email protected]>
1 parent 6ac2de4 commit 18c3feb

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

modules/ROOT/pages/subscriptions/customize-cdc.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
[[customize-cdc]]
2-
= Customize CDC Subscriptions
2+
= Customize CDC subscriptions
33
:page-aliases: subscriptions/plugins/index.adoc, subscriptions/plugins/amqp.adoc, subscriptions/plugins/single-instance.adoc
4-
:description: This page describes how to customize the behaviour of subscriptions.
4+
:description: This page describes how to customize the behavior of subscriptions.
55

66
== Neo4jGraphQLSubscriptionsCDCEngine
77

8-
By default, the GraphQL library will use the same driver passed to `Neo4jGraphQL` to poll for events every second. This behaviour can be changed by creating a custom instance of `Neo4jGraphQLSubscriptionsCDCEngine`.
8+
By default, the GraphQL library uses the same driver passed to `Neo4jGraphQL` to poll for events every second.
9+
This behavior can be changed by creating a custom instance of `Neo4jGraphQLSubscriptionsCDCEngine`.
910

1011
The following options can be passed to the constructor:
1112

1213
* `driver`: The driver to be used for CDC queries.
1314
* `pollTime`: The interval, in milliseconds, between queries to CDC.
1415
Defaults to 1000ms.
15-
Note that poll time is the period between one request finishing and the next one starting.
16-
The actual time it takes for CDC events to trigger the subscription also depend on your network.
16+
Note that poll time is the period between a finished request and the start of the next.
17+
The actual time it takes for CDC events to trigger the subscription also depends on your network.
1718
* `queryConfig`: An object with the driver query options to be passed to CDC requests.
1819
Use the `db` field to define the target database for CDC.
1920

modules/ROOT/pages/subscriptions/getting-started.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ This guide shows how to start using subscription capabilities on a GraphQL serve
99
If you use link:https://studio.apollographql.com/[Apollo Studio], make sure to select the link:https://www.npmjs.com/package/graphql-ws[graphql-ws] implementation in the connection settings.
1010
====
1111

12-
Subscriptions allow to listen to changes to the database, including changes done outside of the GraphQL library.
12+
Subscriptions can listen to changes to the database, including changes unrelated to the GraphQL library.
1313

1414
== Enable subscription capabilities
1515

16-
Neo4j GraphQL subscriptions rely on Neo4j Change Data Capture. Make sure to follow the steps described on the link:https://neo4j.com/docs/cdc/current/[CDC Documentation] to enable it in `FULL` mode for your Neo4j instance.
16+
Neo4j GraphQL subscriptions rely on Neo4j Change Data Capture.
17+
Make sure to follow the steps described in the link:https://neo4j.com/docs/cdc/current/[CDC Documentation] to enable it in `FULL` mode for your Neo4j instance.
1718

1819
Before using subscriptions on a GraphQL server, you must enable them by passing the `subscriptions` feature to `Neo4jGraphQL`:
1920

0 commit comments

Comments
 (0)