Package org.apache.iceberg

Interface ManifestFile

All Known Implementing Classes:
GenericManifestFile, ManifestFileBean
public interface ManifestFile
Represents a manifest file that can be scanned to find files in a table.

  • Field Details

  • Method Details

    • schema

      static Schema schema()

    • path

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

    • length

      long length()
      Returns length of the manifest file.

    • partitionSpecId

      int partitionSpecId()
      Returns iD of the PartitionSpec used to write the manifest file.

    • content

      ManifestContent content()
      Returns the content stored in the manifest; either DATA or DELETES.

    • sequenceNumber

      long sequenceNumber()
      Returns the sequence number of the commit that added the manifest file.

    • minSequenceNumber

      long minSequenceNumber()
      Returns the lowest data sequence number of any live file in the manifest.

    • snapshotId

      Long snapshotId()
      Returns iD of the snapshot that added the manifest file to table metadata.

    • hasAddedFiles

      default boolean hasAddedFiles()
      Returns true if the manifest contains ADDED entries or if the count is not known.
      Returns:
      whether this manifest contains entries with ADDED status

    • addedFilesCount

      Integer addedFilesCount()
      Returns the number of files with status ADDED in the manifest file.

    • addedRowsCount

      Long addedRowsCount()
      Returns the total number of rows in all files with status ADDED in the manifest file.

    • hasExistingFiles

      default boolean hasExistingFiles()
      Returns true if the manifest contains EXISTING entries or if the count is not known.
      Returns:
      whether this manifest contains entries with EXISTING status

    • existingFilesCount

      Integer existingFilesCount()
      Returns the number of files with status EXISTING in the manifest file.

    • existingRowsCount

      Long existingRowsCount()
      Returns the total number of rows in all files with status EXISTING in the manifest file.

    • hasDeletedFiles

      default boolean hasDeletedFiles()
      Returns true if the manifest contains DELETED entries or if the count is not known.
      Returns:
      whether this manifest contains entries with DELETED status

    • deletedFilesCount

      Integer deletedFilesCount()
      Returns the number of files with status DELETED in the manifest file.

    • deletedRowsCount

      Long deletedRowsCount()
      Returns the total number of rows in all files with status DELETED in the manifest file.

    • partitions

      List<ManifestFile.PartitionFieldSummary> partitions()
      Returns a list of partition field summaries.

      Each summary corresponds to a field in the manifest file's partition spec, by ordinal. For example, the partition spec [ ts_day=date(ts), type=identity(type) ] will have 2 summaries. The first summary is for the ts_day partition field and the second is for the type partition field.

      Returns:
      a list of partition field summaries, one for each field in the manifest's spec

    • keyMetadata

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

    • copy

      ManifestFile copy()
      Copies this manifest file. Readers can reuse manifest file instances; use this method to make defensive copies.
      Returns:
      a copy of this manifest file