Package org.apache.iceberg.spark

Class SparkContentFile<F>

java.lang.Object
org.apache.iceberg.spark.SparkContentFile<F>
All Implemented Interfaces:
ContentFile<F>
Direct Known Subclasses:
SparkDataFile, SparkDeleteFile
public abstract class SparkContentFile<F> extends Object implements ContentFile<F>

  • Method Details

    • wrap

      public F wrap(org.apache.spark.sql.Row row)

    • asFile

      protected abstract F asFile()

    • pos

      public Long pos()
      Description copied from interface: ContentFile
      Returns the ordinal position of the file in a manifest, or null if it was not read from a manifest.
      Specified by:
      pos in interface ContentFile<F>

    • specId

      public int specId()
      Description copied from interface: ContentFile
      Returns id of the partition spec used for partition metadata.
      Specified by:
      specId in interface ContentFile<F>

    • content

      public FileContent content()
      Description copied from interface: ContentFile
      Returns type of content stored in the file; one of DATA, POSITION_DELETES, or EQUALITY_DELETES.
      Specified by:
      content in interface ContentFile<F>

    • path

      public CharSequence path()
      Description copied from interface: ContentFile
      Returns fully qualified path to the file, suitable for constructing a Hadoop Path.
      Specified by:
      path in interface ContentFile<F>

    • format

      public FileFormat format()
      Description copied from interface: ContentFile
      Returns format of the file.
      Specified by:
      format in interface ContentFile<F>

    • partition

      public StructLike partition()
      Description copied from interface: ContentFile
      Returns partition for this file as a StructLike.
      Specified by:
      partition in interface ContentFile<F>

    • recordCount

      public long recordCount()
      Description copied from interface: ContentFile
      Returns the number of top-level records in the file.
      Specified by:
      recordCount in interface ContentFile<F>

    • fileSizeInBytes

      public long fileSizeInBytes()
      Description copied from interface: ContentFile
      Returns the file size in bytes.
      Specified by:
      fileSizeInBytes in interface ContentFile<F>

    • columnSizes

      public Map<Integer,Long> columnSizes()
      Description copied from interface: ContentFile
      Returns if collected, map from column ID to the size of the column in bytes, null otherwise.
      Specified by:
      columnSizes in interface ContentFile<F>

    • valueCounts

      public Map<Integer,Long> valueCounts()
      Description copied from interface: ContentFile
      Returns if collected, map from column ID to the count of its values (including null and NaN values), null otherwise.
      Specified by:
      valueCounts in interface ContentFile<F>

    • nullValueCounts

      public Map<Integer,Long> nullValueCounts()
      Description copied from interface: ContentFile
      Returns if collected, map from column ID to its null value count, null otherwise.
      Specified by:
      nullValueCounts in interface ContentFile<F>

    • nanValueCounts

      public Map<Integer,Long> nanValueCounts()
      Description copied from interface: ContentFile
      Returns if collected, map from column ID to its NaN value count, null otherwise.
      Specified by:
      nanValueCounts in interface ContentFile<F>

    • lowerBounds

      public Map<Integer,ByteBuffer> lowerBounds()
      Description copied from interface: ContentFile
      Returns if collected, map from column ID to value lower bounds, null otherwise.
      Specified by:
      lowerBounds in interface ContentFile<F>

    • upperBounds

      public Map<Integer,ByteBuffer> upperBounds()
      Description copied from interface: ContentFile
      Returns if collected, map from column ID to value upper bounds, null otherwise.
      Specified by:
      upperBounds in interface ContentFile<F>

    • keyMetadata

      public ByteBuffer keyMetadata()
      Description copied from interface: ContentFile
      Returns metadata about how this file is encrypted, or null if the file is stored in plain text.
      Specified by:
      keyMetadata in interface ContentFile<F>

    • copy

      public F copy()
      Description copied from interface: ContentFile
      Copies this file. Manifest readers can reuse file instances; use this method to copy data when collecting files from tasks.
      Specified by:
      copy in interface ContentFile<F>
      Returns:
      a copy of this data file

    • copyWithoutStats

      public F copyWithoutStats()
      Description copied from interface: ContentFile
      Copies this file without file stats. Manifest readers can reuse file instances; use this method to copy data without stats when collecting files.
      Specified by:
      copyWithoutStats in interface ContentFile<F>
      Returns:
      a copy of this data file, without lower bounds, upper bounds, value counts, null value counts, or nan value counts

    • splitOffsets

      public List<Long> splitOffsets()
      Description copied from interface: ContentFile
      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.

      Specified by:
      splitOffsets in interface ContentFile<F>

    • sortOrderId

      public Integer sortOrderId()
      Description copied from interface: ContentFile
      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.
      Specified by:
      sortOrderId in interface ContentFile<F>

    • equalityFieldIds

      public List<Integer> equalityFieldIds()
      Description copied from interface: ContentFile
      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.

      Specified by:
      equalityFieldIds in interface ContentFile<F>
      Returns:
      IDs of the fields used in equality comparison with the records in this delete file