Rename Session.lastBookmark to Session.lastBookmarks

packages/bolt-connection/src/bolt/bolt-protocol-v1.js

@@ -33,7 +33,7 @@ import {
 import { internal } from 'neo4j-driver-core'
 
 const {
-  bookmark: { Bookmark },
+  bookmarks: { Bookmarks },
   constants: { ACCESS_MODE_WRITE, BOLT_PROTOCOL_V1 },
   logger: { Logger },
   txConfig: { TxConfig }
@@ -140,7 +140,7 @@ export default class BoltProtocol {
   /**
    * Begin an explicit transaction.
    * @param {Object} param
-   * @param {Bookmark} param.bookmark the bookmark.
+   * @param {Bookmarks} param.bookmarks the bookmarks.
    * @param {TxConfig} param.txConfig the configuration.
    * @param {string} param.database the target database name.
    * @param {string} param.mode the access mode.
@@ -152,7 +152,7 @@ export default class BoltProtocol {
    * @returns {StreamObserver} the stream observer that monitors the corresponding server response.
    */
   beginTransaction ({
-    bookmark,
+    bookmarks,
     txConfig,
     database,
     mode,
@@ -164,9 +164,9 @@ export default class BoltProtocol {
   } = {}) {
     return this.run(
       'BEGIN',
-      bookmark ? bookmark.asBeginTransactionParameters() : {},
+      bookmarks ? bookmarks.asBeginTransactionParameters() : {},
       {
-        bookmark: bookmark,
+        bookmarks: bookmarks,
         txConfig: txConfig,
         database,
         mode,
@@ -201,7 +201,7 @@ export default class BoltProtocol {
       'COMMIT',
       {},
       {
-        bookmark: Bookmark.empty(),
+        bookmarks: Bookmarks.empty(),
         txConfig: TxConfig.empty(),
         mode: ACCESS_MODE_WRITE,
         beforeError,
@@ -233,7 +233,7 @@ export default class BoltProtocol {
       'ROLLBACK',
       {},
       {
-        bookmark: Bookmark.empty(),
+        bookmarks: Bookmarks.empty(),
         txConfig: TxConfig.empty(),
         mode: ACCESS_MODE_WRITE,
         beforeError,
@@ -249,7 +249,7 @@ export default class BoltProtocol {
    * @param {string} query the cypher query.
    * @param {Object} parameters the query parameters.
    * @param {Object} param
-   * @param {Bookmark} param.bookmark the bookmark.
+   * @param {Bookmarks} param.bookmarks the bookmarks.
    * @param {TxConfig} param.txConfig the transaction configuration.
    * @param {string} param.database the target database name.
    * @param {string} param.impersonatedUser the impersonated user
@@ -267,7 +267,7 @@ export default class BoltProtocol {
     query,
     parameters,
     {
-      bookmark,
+      bookmarks,
       txConfig,
       database,
       mode,
@@ -295,7 +295,7 @@ export default class BoltProtocol {
       lowRecordWatermark
     })
 
-    // bookmark and mode are ignored in this version of the protocol
+    // bookmarks and mode are ignored in this version of the protocol
     assertTxConfigIsEmpty(txConfig, this._onProtocolError, observer)
     // passing in a database name on this protocol version throws an error
     assertDatabaseIsEmpty(database, this._onProtocolError, observer)

packages/bolt-connection/src/bolt/bolt-protocol-v3.js

@@ -28,7 +28,7 @@ import {
 import { internal } from 'neo4j-driver-core'
 
 const {
-  bookmark: { Bookmark },
+  bookmarks: { Bookmarks },
   constants: { BOLT_PROTOCOL_V3 },
   txConfig: { TxConfig }
 } = internal
@@ -75,7 +75,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
   }
 
   beginTransaction ({
-    bookmark,
+    bookmarks,
     txConfig,
     database,
     impersonatedUser,
@@ -100,7 +100,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
     assertImpersonatedUserIsEmpty(impersonatedUser, this._onProtocolError, observer)
 
     this.write(
-      RequestMessage.begin({ bookmark, txConfig, mode }),
+      RequestMessage.begin({ bookmarks, txConfig, mode }),
       observer,
       true
     )
@@ -152,7 +152,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
     query,
     parameters,
     {
-      bookmark,
+      bookmarks,
       txConfig,
       database,
       impersonatedUser,
@@ -187,7 +187,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
 
     this.write(
       RequestMessage.runWithMetadata(query, parameters, {
-        bookmark,
+        bookmarks,
         txConfig,
         mode
       }),
@@ -206,7 +206,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
    * @param {object} param.routingContext The routing context used to define the routing table.
    *  Multi-datacenter deployments is one of its use cases
    * @param {string} param.databaseName The database name
-   * @param {Bookmark} params.sessionContext.bookmark The bookmark used for request the routing table
+   * @param {Bookmarks} params.sessionContext.bookmarks The bookmarks used for requesting the routing table
    * @param {string} params.sessionContext.mode The session mode
    * @param {string} params.sessionContext.database The database name used on the session
    * @param {function()} params.sessionContext.afterComplete The session param used after the session closed

packages/bolt-connection/src/bolt/bolt-protocol-v4x0.js

@@ -27,7 +27,7 @@ import {
 import { internal } from 'neo4j-driver-core'
 
 const {
-  bookmark: { Bookmark },
+  bookmarks: { Bookmarks },
   constants: { BOLT_PROTOCOL_V4_0, FETCH_ALL },
   txConfig: { TxConfig }
 } = internal
@@ -42,7 +42,7 @@ export default class BoltProtocol extends BoltProtocolV3 {
   }
 
   beginTransaction ({
-    bookmark,
+    bookmarks,
     txConfig,
     database,
     impersonatedUser,
@@ -65,7 +65,7 @@ export default class BoltProtocol extends BoltProtocolV3 {
     assertImpersonatedUserIsEmpty(impersonatedUser, this._onProtocolError, observer)
 
     this.write(
-      RequestMessage.begin({ bookmark, txConfig, database, mode }),
+      RequestMessage.begin({ bookmarks, txConfig, database, mode }),
       observer,
       true
     )
@@ -77,7 +77,7 @@ export default class BoltProtocol extends BoltProtocolV3 {
     query,
     parameters,
     {
-      bookmark,
+      bookmarks,
       txConfig,
       database,
       impersonatedUser,
@@ -117,7 +117,7 @@ export default class BoltProtocol extends BoltProtocolV3 {
     const flushRun = reactive
     this.write(
       RequestMessage.runWithMetadata(query, parameters, {
-        bookmark,
+        bookmarks,
         txConfig,
         database,
         mode
@@ -150,7 +150,7 @@ export default class BoltProtocol extends BoltProtocolV3 {
    * @param {object} param.routingContext The routing context used to define the routing table.
    *  Multi-datacenter deployments is one of its use cases
    * @param {string} param.databaseName The database name
-   * @param {Bookmark} params.sessionContext.bookmark The bookmark used for request the routing table
+   * @param {Bookmarks} params.sessionContext.bookmarks The bookmarks used for requesting the routing table
    * @param {string} params.sessionContext.mode The session mode
    * @param {string} params.sessionContext.database The database name used on the session
    * @param {function()} params.sessionContext.afterComplete The session param used after the session closed

packages/bolt-connection/src/bolt/bolt-protocol-v4x3.js

@@ -23,7 +23,7 @@ import { RouteObserver } from './stream-observers'
 import { internal } from 'neo4j-driver-core'
 
 const {
-  bookmark: { Bookmark },
+  bookmarks: { Bookmarks },
   constants: { BOLT_PROTOCOL_V4_3 }
 } = internal
 
@@ -39,7 +39,7 @@ export default class BoltProtocol extends BoltProtocolV42 {
    * @param {object} param.routingContext The routing context used to define the routing table.
    *  Multi-datacenter deployments is one of its use cases
    * @param {string} param.databaseName The database name
-   * @param {Bookmark} params.sessionContext.bookmark The bookmark used for request the routing table
+   * @param {Bookmarks} params.sessionContext.bookmarks The bookmarks used for requesting the routing table
    * @param {function(err: Error)} param.onError
    * @param {function(RawRoutingTable)} param.onCompleted
    * @returns {RouteObserver} the route observer
@@ -56,9 +56,9 @@ export default class BoltProtocol extends BoltProtocolV42 {
       onError,
       onCompleted
     })
-    const bookmark = sessionContext.bookmark || Bookmark.empty()
+    const bookmarks = sessionContext.bookmarks || Bookmarks.empty()
     this.write(
-      RequestMessage.route(routingContext, bookmark.values(), databaseName),
+      RequestMessage.route(routingContext, bookmarks.values(), databaseName),
       observer,
       true
     )

packages/bolt-connection/src/bolt/bolt-protocol-v4x4.js

@@ -24,7 +24,7 @@ import { RouteObserver, ResultStreamObserver } from './stream-observers'
 
 const {
   constants: { BOLT_PROTOCOL_V4_4, FETCH_ALL },
-  bookmark: { Bookmark },
+  bookmarks: { Bookmarks },
 } = internal
 
 export default class BoltProtocol extends BoltProtocolV43 {
@@ -39,7 +39,7 @@ export default class BoltProtocol extends BoltProtocolV43 {
   * @param {object} param.routingContext The routing context used to define the routing table.
   *  Multi-datacenter deployments is one of its use cases
   * @param {string} param.databaseName The database name
-  * @param {Bookmark} params.sessionContext.bookmark The bookmark used for request the routing table
+  * @param {Bookmarks} params.sessionContext.bookmarks The bookmarks used for requesting the routing table
   * @param {function(err: Error)} param.onError
   * @param {function(RawRoutingTable)} param.onCompleted
   * @returns {RouteObserver} the route observer
@@ -57,9 +57,9 @@ export default class BoltProtocol extends BoltProtocolV43 {
       onError,
       onCompleted
     })
-    const bookmark = sessionContext.bookmark || Bookmark.empty()
+    const bookmarks = sessionContext.bookmarks || Bookmarks.empty()
     this.write(
-      RequestMessage.routeV4x4(routingContext, bookmark.values(), { databaseName, impersonatedUser }),
+      RequestMessage.routeV4x4(routingContext, bookmarks.values(), { databaseName, impersonatedUser }),
       observer,
       true
     )
@@ -71,7 +71,7 @@ export default class BoltProtocol extends BoltProtocolV43 {
     query,
     parameters,
     {
-      bookmark,
+      bookmarks,
       txConfig,
       database,
       mode,
@@ -108,7 +108,7 @@ export default class BoltProtocol extends BoltProtocolV43 {
     const flushRun = reactive
     this.write(
       RequestMessage.runWithMetadata(query, parameters, {
-        bookmark,
+        bookmarks,
         txConfig,
         database,
         mode,
@@ -126,7 +126,7 @@ export default class BoltProtocol extends BoltProtocolV43 {
   }
 
   beginTransaction ({
-    bookmark,
+    bookmarks,
     txConfig,
     database,
     mode,
@@ -146,7 +146,7 @@ export default class BoltProtocol extends BoltProtocolV43 {
     observer.prepareToHandleSingleResponse()
 
     this.write(
-      RequestMessage.begin({ bookmark, txConfig, database, mode, impersonatedUser }),
+      RequestMessage.begin({ bookmarks, txConfig, database, mode, impersonatedUser }),
       observer,
       true
     )

packages/bolt-connection/src/bolt/request-message.js

@@ -120,15 +120,15 @@ export default class RequestMessage {
 
   /**
    * Create a new BEGIN message.
-   * @param {Bookmark} bookmark the bookmark.
+   * @param {Bookmarks} bookmarks the bookmarks.
    * @param {TxConfig} txConfig the configuration.
    * @param {string} database the database name.
    * @param {string} mode the access mode.
    * @param {string} impersonatedUser the impersonated user.
    * @return {RequestMessage} new BEGIN message.
    */
-  static begin ({ bookmark, txConfig, database, mode, impersonatedUser } = {}) {
-    const metadata = buildTxMetadata(bookmark, txConfig, database, mode, impersonatedUser)
+  static begin ({ bookmarks, txConfig, database, mode, impersonatedUser } = {}) {
+    const metadata = buildTxMetadata(bookmarks, txConfig, database, mode, impersonatedUser)
     return new RequestMessage(
       BEGIN,
       [metadata],
@@ -156,7 +156,7 @@ export default class RequestMessage {
    * Create a new RUN message with additional metadata.
    * @param {string} query the cypher query.
    * @param {Object} parameters the query parameters.
-   * @param {Bookmark} bookmark the bookmark.
+   * @param {Bookmarks} bookmarks the bookmarks.
    * @param {TxConfig} txConfig the configuration.
    * @param {string} database the database name.
    * @param {string} mode the access mode.
@@ -166,9 +166,9 @@ export default class RequestMessage {
   static runWithMetadata (
     query,
     parameters,
-    { bookmark, txConfig, database, mode, impersonatedUser } = {}
+    { bookmarks, txConfig, database, mode, impersonatedUser } = {}
   ) {
-    const metadata = buildTxMetadata(bookmark, txConfig, database, mode, impersonatedUser)
+    const metadata = buildTxMetadata(bookmarks, txConfig, database, mode, impersonatedUser)
     return new RequestMessage(
       RUN,
       [query, parameters, metadata],
@@ -225,7 +225,7 @@ export default class RequestMessage {
    * Generate the ROUTE message, this message is used to fetch the routing table from the server
    *
    * @param {object} routingContext The routing context used to define the routing table. Multi-datacenter deployments is one of its use cases
-   * @param {string[]} bookmarks The list of the bookmark should be used
+   * @param {string[]} bookmarks The list of the bookmarks should be used
    * @param {string} databaseName The name of the database to get the routing table for.
    * @return {RequestMessage} the ROUTE message.
    */
@@ -244,7 +244,7 @@ export default class RequestMessage {
    * Generate the ROUTE message, this message is used to fetch the routing table from the server
    *
    * @param {object} routingContext The routing context used to define the routing table. Multi-datacenter deployments is one of its use cases
-   * @param {string[]} bookmarks The list of the bookmark should be used
+   * @param {string[]} bookmarks The list of the bookmarks should be used
    * @param {object} databaseContext The context inforamtion of the database to get the routing table for.
    * @param {string} databaseContext.databaseName The name of the database to get the routing table.
    * @param {string} databaseContext.impersonatedUser The name of the user to impersonation when getting the routing table.
@@ -274,17 +274,17 @@ export default class RequestMessage {
 
 /**
  * Create an object that represent transaction metadata.
- * @param {Bookmark} bookmark the bookmark.
+ * @param {Bookmarks} bookmarks the bookmarks.
  * @param {TxConfig} txConfig the configuration.
  * @param {string} database the database name.
  * @param {string} mode the access mode.
  * @param {string} impersonatedUser the impersonated user mode.
  * @return {Object} a metadata object.
  */
-function buildTxMetadata (bookmark, txConfig, database, mode, impersonatedUser) {
+function buildTxMetadata (bookmarks, txConfig, database, mode, impersonatedUser) {
   const metadata = {}
-  if (!bookmark.isEmpty()) {
-    metadata.bookmarks = bookmark.values()
+  if (!bookmarks.isEmpty()) {
+    metadata.bookmarks = bookmarks.values()
   }
   if (txConfig.timeout !== null) {
     metadata.tx_timeout = txConfig.timeout