Home Reference Source
import BookmarkManager from 'neo4j-driver-core/lib/bookmark-manager.js'
public interface | since 5.0 | source

BookmarkManager

Interface for the piece of software responsible for keeping track of current active bookmarks accross the driver.

Method Summary

Public Methods
public

getBookmarks(): Iterable<string>

Method called by the driver to get the bookmarks.

public

updateBookmarks(previousBookmarks: Iterable<string>, newBookmarks: Iterable<string>): void

Method called when the bookmarks get updated when a transaction finished.

Public Methods

public getBookmarks(): Iterable<string> source

Method called by the driver to get the bookmarks.

Return:

Iterable<string>

The set of bookmarks

public updateBookmarks(previousBookmarks: Iterable<string>, newBookmarks: Iterable<string>): void source

Method called when the bookmarks get updated when a transaction finished.

This method will be called when auto-commit queries finish and when explicit transactions get committed.

Params:

NameTypeAttributeDescription
previousBookmarks Iterable<string>

The bookmarks used when starting the transaction

newBookmarks Iterable<string>

The new bookmarks received at the end of the transaction.

Return:

void