Package org.apache.iceberg

Interface ContentFile<F>

Type Parameters:
F - the concrete Java class of a ContentFile instance.
All Known Subinterfaces:
DataFile, DeleteFile
All Known Implementing Classes:
SparkContentFile, SparkDataFile, SparkDeleteFile
public interface ContentFile<F>
Superinterface of DataFile and DeleteFile that exposes common methods.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<Integer,Long>
    columnSizes()
    Returns if collected, map from column ID to the size of the column in bytes, null otherwise.
    FileContent
    content()
    Returns type of content stored in the file; one of DATA, POSITION_DELETES, or EQUALITY_DELETES.
    F
    copy()
    Copies this file.
    default F
    copy(boolean withStats)
    Copies this file (potentially without file stats).
    F
    copyWithoutStats()
    Copies this file without file stats.
    default F
    copyWithStats(Set<Integer> requestedColumnIds)
    Copies this file with column stats only for specific columns.
    default Long
    dataSequenceNumber()
    Returns the data sequence number of the file.
    List<Integer>
    equalityFieldIds()
    Returns the set of field IDs used for equality comparison, in equality delete files.
    default Long
    fileSequenceNumber()
    Returns the file sequence number.
    long
    fileSizeInBytes()
    Returns the file size in bytes.
    FileFormat
    format()
    Returns format of the file.
    ByteBuffer
    keyMetadata()
    Returns metadata about how this file is encrypted, or null if the file is stored in plain text.
    Map<Integer,ByteBuffer>
    lowerBounds()
    Returns if collected, map from column ID to value lower bounds, null otherwise.
    Map<Integer,Long>
    nanValueCounts()
    Returns if collected, map from column ID to its NaN value count, null otherwise.
    Map<Integer,Long>
    nullValueCounts()
    Returns if collected, map from column ID to its null value count, null otherwise.
    StructLike
    partition()
    Returns partition for this file as a StructLike.
    CharSequence
    path()
    Returns fully qualified path to the file, suitable for constructing a Hadoop Path.
    Long
    pos()
    Returns the ordinal position of the file in a manifest, or null if it was not read from a manifest.
    long
    recordCount()
    Returns the number of top-level records in the file.
    default Integer
    sortOrderId()
    Returns the sort order id of this file, which describes how the file is ordered.
    int
    specId()
    Returns id of the partition spec used for partition metadata.
    List<Long>
    splitOffsets()
    Returns list of recommended split locations, if applicable, null otherwise.
    Map<Integer,ByteBuffer>
    upperBounds()
    Returns if collected, map from column ID to value upper bounds, null otherwise.
    Map<Integer,Long>
    valueCounts()
    Returns if collected, map from column ID to the count of its values (including null and NaN values), null otherwise.

  • Method Details

    • pos

      Long pos()
      Returns the ordinal position of the file in a manifest, or null if it was not read from a manifest.

    • specId

      int specId()
      Returns id of the partition spec used for partition metadata.

    • content

      FileContent content()
      Returns type of content stored in the file; one of DATA, POSITION_DELETES, or EQUALITY_DELETES.

    • path

      CharSequence path()
      Returns fully qualified path to the file, suitable for constructing a Hadoop Path.

    • format

      FileFormat format()
      Returns format of the file.

    • partition

      StructLike partition()
      Returns partition for this file as a StructLike.

    • recordCount

      long recordCount()
      Returns the number of top-level records in the file.

    • fileSizeInBytes

      long fileSizeInBytes()
      Returns the file size in bytes.

    • columnSizes

      Map<Integer,Long> columnSizes()
      Returns if collected, map from column ID to the size of the column in bytes, null otherwise.

    • valueCounts

      Map<Integer,Long> valueCounts()
      Returns if collected, map from column ID to the count of its values (including null and NaN values), null otherwise.

    • nullValueCounts

      Map<Integer,Long> nullValueCounts()
      Returns if collected, map from column ID to its null value count, null otherwise.

    • nanValueCounts

      Map<Integer,Long> nanValueCounts()
      Returns if collected, map from column ID to its NaN value count, null otherwise.

    • lowerBounds

      Map<Integer,ByteBuffer> lowerBounds()
      Returns if collected, map from column ID to value lower bounds, null otherwise.

    • upperBounds

      Map<Integer,ByteBuffer> upperBounds()
      Returns if collected, map from column ID to value upper bounds, null otherwise.

    • keyMetadata

      ByteBuffer keyMetadata()
      Returns metadata about how this file is encrypted, or null if the file is stored in plain text.

    • splitOffsets

      List<Long> splitOffsets()
      Returns list of recommended split locations, if applicable, null otherwise.

      When available, this information is used for planning scan tasks whose boundaries are determined by these offsets. The returned list must be sorted in ascending order.

    • equalityFieldIds

      List<Integer> equalityFieldIds()
      Returns the set of field IDs used for equality comparison, in equality delete files.

      An equality delete file may contain additional data fields that are not used by equality comparison. The subset of columns in a delete file to be used in equality comparison are tracked by ID. Extra columns can be used to reconstruct changes and metrics from extra columns are used during job planning.

      Returns:
      IDs of the fields used in equality comparison with the records in this delete file

    • sortOrderId

      default Integer sortOrderId()
      Returns the sort order id of this file, which describes how the file is ordered. This information will be useful for merging data and equality delete files more efficiently when they share the same sort order id.

    • dataSequenceNumber

      default Long dataSequenceNumber()
      Returns the data sequence number of the file.

      This method represents the sequence number to which the file should apply. Note the data sequence number may differ from the sequence number of the snapshot in which the underlying file was added (a.k.a the file sequence number). New snapshots can add files that belong to older sequence numbers (e.g. compaction). The data sequence number also does not change when the file is marked as deleted.

      This method can return null if the data sequence number is unknown. This may happen while reading a v2 manifest that did not persist the data sequence number for manifest entries with status DELETED (older Iceberg versions).

    • fileSequenceNumber

      default Long fileSequenceNumber()
      Returns the file sequence number.

      The file sequence number represents the sequence number of the snapshot in which the underlying file was added. The file sequence number is always assigned at commit and cannot be provided explicitly, unlike the data sequence number. The file sequence number does not change upon assigning. In case of rewrite (like compaction), file sequence number can be higher than the data sequence number.

      This method can return null if the file sequence number is unknown. This may happen while reading a v2 manifest that did not persist the file sequence number for manifest entries with status EXISTING or DELETED (older Iceberg versions).

    • copy

      F copy()
      Copies this file. Manifest readers can reuse file instances; use this method to copy data when collecting files from tasks.
      Returns:
      a copy of this data file

    • copyWithoutStats

      F copyWithoutStats()
      Copies this file without file stats. Manifest readers can reuse file instances; use this method to copy data without stats when collecting files.
      Returns:
      a copy of this data file, without lower bounds, upper bounds, value counts, null value counts, or nan value counts

    • copyWithStats

      default F copyWithStats(Set<Integer> requestedColumnIds)
      Copies this file with column stats only for specific columns. Manifest readers can reuse file instances; use this method to copy data with stats only for specific columns when collecting files.
      Parameters:
      requestedColumnIds - column IDs for which to keep stats.
      Returns:
      a copy of data file, with lower bounds, upper bounds, value counts, null value counts, and nan value counts for only specific columns.

    • copy

      default F copy(boolean withStats)
      Copies this file (potentially without file stats). Manifest readers can reuse file instances; use this method to copy data when collecting files from tasks.
      Parameters:
      withStats - Will copy this file without file stats if set to false.
      Returns:
      a copy of this data file. If withStats is set to false the file will not contain lower bounds, upper bounds, value counts, null value counts, or nan value counts