Package org.apache.polaris.persistence.nosql.api.ref

Interface Reference

@PolarisImmutable public interface Reference

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.apache.polaris.persistence.nosql.api.ref.ImmutableReference.Builder
    builder()
     
    long
    createdAtMicros()
    Timestamp in microseconds since (Unix) epoch when the reference was created in the database.
    String
    name()
     
    Optional<ObjRef>
    pointer()
    Current pointer of this reference.
    long[]
    previousPointers()
    List of previously assigned pointers.

  • Method Details

    • name

      String name()

    • pointer

      Optional<ObjRef> pointer()
      Current pointer of this reference.

      Note that the pointer can only be Optional.empty() when a reference has been created without a current pointer. If a reference ever had a pointer value, it cannot be "reset" to become Optional.empty() again.

      Returns:
      current pointer, Optional.empty() for references that have been created without a current pointer.

    • createdAtMicros

      long createdAtMicros()
      Timestamp in microseconds since (Unix) epoch when the reference was created in the database.

    • previousPointers

      long[] previousPointers()
      List of previously assigned pointers.

      This list can be useful in case of disaster recovery scenarios in combination with geographically distributed databases / replication, when in the disaster recovery case the whole database content is not consistently available.

      The "full" ObjRefs can be re-constructed by using the pointer().get().Obj.type().

    • builder

      static org.apache.polaris.persistence.nosql.api.ref.ImmutableReference.Builder builder()