Package io.vena.bosk.drivers.mongo

Record Class PandoFormat

java.lang.Object
java.lang.Record
io.vena.bosk.drivers.mongo.PandoFormat
Record Components:
graftPoints - A list of path strings pointing to Catalog or SideTable tree nodes whose entries (children) are to be stored in their own documents.
All Implemented Interfaces:
MongoDriverSettings.DatabaseFormat, io.vena.bosk.StateTreeNode
public record PandoFormat(io.vena.bosk.ListValue<String> graftPoints) extends Record implements io.vena.bosk.StateTreeNode, MongoDriverSettings.DatabaseFormat
A scalable format that stores the bosk state in multiple documents, thereby overcoming MongoDB's 16MB document size limit.

Named after Pando: looks like a forest, but it's actually one tree with one root system.

  • Constructor Details

    • PandoFormat

      public PandoFormat(io.vena.bosk.ListValue<String> graftPoints)
      Creates an instance of a PandoFormat record class.
      Parameters:
      graftPoints - the value for the graftPoints record component

  • Method Details

    • oneBigDocument

      public static PandoFormat oneBigDocument()
      Differs from Sequoia in that (1) the root document has a different ID, rendering the formats incompatible; and (2) Sequoia is designed not to need multi-document transactions.

    • withGraftPoints

      public static PandoFormat withGraftPoints(Collection<String> pathStrings)

    • withGraftPoints

      public static PandoFormat withGraftPoints(String... pathStrings)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • graftPoints

      public io.vena.bosk.ListValue<String> graftPoints()
      Returns the value of the graftPoints record component.
      Returns:
      the value of the graftPoints record component