org.apache.iceberg.Snapshot Maven / Gradle / Ivy
Show all versions of iceberg-api Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.iceberg;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
/**
* 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 {@link AppendFiles} and {@link RewriteFiles}.
*/
public interface Snapshot extends Serializable {
/**
* Return this snapshot's sequence number.
*
* Sequence numbers are assigned when a snapshot is committed.
*
* @return a long sequence number
*/
long sequenceNumber();
/**
* Return this snapshot's ID.
*
* @return a long ID
*/
long snapshotId();
/**
* Return this snapshot's parent ID or null.
*
* @return a long ID for this snapshot's parent, or null if it has no parent
*/
Long parentId();
/**
* Return this snapshot's timestamp.
*
* This timestamp is the same as those produced by {@link System#currentTimeMillis()}.
*
* @return a long timestamp in milliseconds
*/
long timestampMillis();
/**
* Return all {@link ManifestFile} instances for either data or delete manifests in this snapshot.
*
* @return a list of ManifestFile
*/
List allManifests();
/**
* Return a {@link ManifestFile} for each data manifest in this snapshot.
*
* @return a list of ManifestFile
*/
List dataManifests();
/**
* Return a {@link ManifestFile} for each delete manifest in this snapshot.
*
* @return a list of ManifestFile
*/
List deleteManifests();
/**
* Return the name of the {@link DataOperations data operation} that produced this snapshot.
*
* @return the operation that produced this snapshot, or null if the operation is unknown
* @see DataOperations
*/
String operation();
/**
* Return a string map of summary data for the operation that produced this snapshot.
*
* @return a string map of summary data.
*/
Map summary();
/**
* Return all 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.
*
* @return all files added to the table in this snapshot.
*/
Iterable addedFiles();
/**
* Return all files deleted 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.
*
* @return all files deleted from the table in this snapshot.
*/
Iterable deletedFiles();
/**
* Return the location of this snapshot's manifest list, or null if it is not separate.
*
* @return the location of the manifest list for this Snapshot
*/
String manifestListLocation();
/**
* Return the id of the schema used when this snapshot was created, or null if this information is not available.
*
* @return schema id associated with this snapshot
*/
default Integer schemaId() {
return null;
}
}