Package org.apache.iceberg

Interface Snapshot

All Superinterfaces:
Serializable
public interface Snapshot extends Serializable
A snapshot of the data in a table at a point in time.

A snapshot consist of one or more file manifests, and the complete table contents is the union of all the data files in those manifests.

Snapshots are created by table operations, like AppendFiles and RewriteFiles.

  • Method Details

    • sequenceNumber

      long sequenceNumber()
      Return this snapshot's sequence number.

      Sequence numbers are assigned when a snapshot is committed.

      Returns:
      a long sequence number

    • snapshotId

      long snapshotId()
      Return this snapshot's ID.
      Returns:
      a long ID

    • parentId

      Long parentId()
      Return this snapshot's parent ID or null.
      Returns:
      a long ID for this snapshot's parent, or null if it has no parent

    • timestampMillis

      long timestampMillis()
      Return this snapshot's timestamp.

      This timestamp is the same as those produced by System.currentTimeMillis().

      Returns:
      a long timestamp in milliseconds

    • allManifests

      List<ManifestFile> allManifests(FileIO io)
      Return all ManifestFile instances for either data or delete manifests in this snapshot.
      Parameters:
      io - a FileIO instance used for reading files from storage
      Returns:
      a list of ManifestFile

    • dataManifests

      List<ManifestFile> dataManifests(FileIO io)
      Return a ManifestFile for each data manifest in this snapshot.
      Parameters:
      io - a FileIO instance used for reading files from storage
      Returns:
      a list of ManifestFile

    • deleteManifests

      List<ManifestFile> deleteManifests(FileIO io)
      Return a ManifestFile for each delete manifest in this snapshot.
      Parameters:
      io - a FileIO instance used for reading files from storage
      Returns:
      a list of ManifestFile

    • operation

      String operation()
      Return the name of the data operation that produced this snapshot.
      Returns:
      the operation that produced this snapshot, or null if the operation is unknown
      See Also:

    • summary

      Map<String,String> summary()
      Return a string map of summary data for the operation that produced this snapshot.
      Returns:
      a string map of summary data.

    • addedDataFiles

      Iterable<DataFile> addedDataFiles(FileIO io)
      Return all data files added to the table in this snapshot.

      The files returned include the following columns: file_path, file_format, partition, record_count, and file_size_in_bytes. Data and file sequence number are populated. Other columns will be null.

      Parameters:
      io - a FileIO instance used for reading files from storage
      Returns:
      all data files added to the table in this snapshot.

    • removedDataFiles

      Iterable<DataFile> removedDataFiles(FileIO io)
      Return all data files removed from the table in this snapshot.

      The files returned include the following columns: file_path, file_format, partition, record_count, and file_size_in_bytes. Data and file sequence number are populated. Other columns will be null.

      Parameters:
      io - a FileIO instance used for reading files from storage
      Returns:
      all data files removed from the table in this snapshot.

    • addedDeleteFiles

      default Iterable<DeleteFile> addedDeleteFiles(FileIO io)
      Return all delete files added to the table in this snapshot.

      The files returned include the following columns: file_path, file_format, partition, record_count, and file_size_in_bytes. Other columns will be null.

      Parameters:
      io - a FileIO instance used for reading files from storage
      Returns:
      all delete files added to the table in this snapshot

    • removedDeleteFiles

      default Iterable<DeleteFile> removedDeleteFiles(FileIO io)
      Return all delete files removed from the table in this snapshot.

      The files returned include the following columns: file_path, file_format, partition, record_count, and file_size_in_bytes. Other columns will be null.

      Parameters:
      io - a FileIO instance used for reading files from storage
      Returns:
      all delete files removed from the table in this snapshot

    • manifestListLocation

      String manifestListLocation()
      Return the location of this snapshot's manifest list, or null if it is not separate.
      Returns:
      the location of the manifest list for this Snapshot

    • schemaId

      default Integer schemaId()
      Return the id of the schema used when this snapshot was created, or null if this information is not available.
      Returns:
      schema id associated with this snapshot

    • firstRowId

      default Long firstRowId()
      The row-id of the first newly added row in this snapshot. All rows added in this snapshot will have a row-id assigned to them greater than this value. All rows with a row-id less than this value were created in a snapshot that was added to the table (but not necessarily commited to this branch) in the past.
      Returns:
      the first row-id to be used in this snapshot or null if row lineage was not enabled when the table was created.

    • addedRows

      default Long addedRows()
      The total number of newly added rows in this snapshot. It should be the summation of ManifestFile.ADDED_ROWS_COUNT for every manifest added in this snapshot.

      This field is optional but is required when row lineage is enabled.

      Returns:
      the total number of new rows in this snapshot or null if the value was not stored.