Package org.apache.iceberg.deletes

Interface PositionDeleteIndex

public interface PositionDeleteIndex

  • Method Summary

    Modifier and Type
    Method
    Description
    default long
    cardinality()
    Returns the cardinality of this index.
    void
    delete(long position)
    Set a deleted row position.
    void
    delete(long posStart, long posEnd)
    Set a range of deleted row positions.
    default Collection<DeleteFile>
    deleteFiles()
    Returns delete files that this index was created from or an empty collection if unknown.
    static PositionDeleteIndex
    deserialize(byte[] bytes, DeleteFile deleteFile)
    Deserializes a position delete index.
    static PositionDeleteIndex
    empty()
    Returns an empty immutable position delete index.
    default void
    forEach(LongConsumer consumer)
    Traverses all positions in the index in ascending order, applying the provided consumer.
    boolean
    isDeleted(long position)
    Checks whether a row at the position is deleted.
    boolean
    isEmpty()
    Returns true if this collection contains no element.
    default boolean
    isNotEmpty()
    Returns true if this collection contains elements.
    default void
    merge(PositionDeleteIndex that)
    Adds positions from the other index, modifying this index in place.
    default ByteBuffer
    serialize()
    Serializes this index.

  • Method Details

    • delete

      void delete(long position)
      Set a deleted row position.
      Parameters:
      position - the deleted row position

    • delete

      void delete(long posStart, long posEnd)
      Set a range of deleted row positions.
      Parameters:
      posStart - inclusive beginning of position range
      posEnd - exclusive ending of position range

    • merge

      default void merge(PositionDeleteIndex that)
      Adds positions from the other index, modifying this index in place.
      Parameters:
      that - the other index to merge

    • isDeleted

      boolean isDeleted(long position)
      Checks whether a row at the position is deleted.
      Parameters:
      position - deleted row position
      Returns:
      whether the position is deleted

    • isEmpty

      boolean isEmpty()
      Returns true if this collection contains no element.

    • isNotEmpty

      default boolean isNotEmpty()
      Returns true if this collection contains elements.

    • forEach

      default void forEach(LongConsumer consumer)
      Traverses all positions in the index in ascending order, applying the provided consumer.
      Parameters:
      consumer - a consumer for the positions

    • deleteFiles

      default Collection<DeleteFile> deleteFiles()
      Returns delete files that this index was created from or an empty collection if unknown.
      Returns:
      delete files that this index was created from

    • cardinality

      default long cardinality()
      Returns the cardinality of this index.

    • serialize

      default ByteBuffer serialize()
      Serializes this index.
      Returns:
      a buffer containing the serialized index

    • deserialize

      static PositionDeleteIndex deserialize(byte[] bytes, DeleteFile deleteFile)
      Deserializes a position delete index.
      Parameters:
      bytes - an array containing the serialized index
      deleteFile - the delete file that the index is created for
      Returns:
      the deserialized index

    • empty

      static PositionDeleteIndex empty()
      Returns an empty immutable position delete index.