Module org.neo4j.driver
Package org.neo4j.driver

Interface Bookmark

public interface Bookmark
Causal chaining is carried out by passing bookmarks between transactions.

When starting a session with initial bookmarks, the first transaction will be ensured to run at least after the database is as up-to-date as the latest transaction referenced by the supplied bookmarks.

Within a session, bookmark propagation is carried out automatically. Thus, all transactions in a session (both managed and unmanaged) are guaranteed to be carried out one after another.

To opt out of this mechanism for unrelated units of work, applications can use multiple sessions.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Bookmark
    from(String value)
    Reconstruct bookmark from bookmark string value.
    static Bookmark
    from(Set<String> values)
    Deprecated.
    boolean
    isEmpty()
    Deprecated.
    String
    value()
    Returns a string that this bookmark instance identifies.
    Set<String>
    values()
    Deprecated.

  • Method Details

    • value

      String value()
      Returns a string that this bookmark instance identifies.
      Returns:
      a string that this bookmark instance identifies.

    • values

      @Deprecated Set<String> values()
      Deprecated.
      Returns a read-only set of bookmark strings that this bookmark instance identifies.
      Returns:
      a read-only set of bookmark strings that this bookmark instance identifies.

    • from

      static Bookmark from(String value)
      Reconstruct bookmark from bookmark string value.
      Parameters:
      value - value obtained from a previous bookmark.
      Returns:
      A bookmark.

    • from

      @Deprecated static Bookmark from(Set<String> values)
      Deprecated.
      Reconstruct bookmark from bookmarks string values.
      Parameters:
      values - values obtained from a previous bookmark.
      Returns:
      A bookmark.

    • isEmpty

      @Deprecated boolean isEmpty()
      Deprecated.
      Return true if the bookmark is empty.
      Returns:
      true if the bookmark is empty.