Snapshot (Paimon : 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.Snapshot

Direct Known Subclasses:

Changelog, Tag
```
@Public
public class Snapshot
extends Object
```
This file is the entrance to all data committed at some specific time point.
Versioned change list:
- Version 1: Initial version for paimon <= 0.2. There is no "version" field in json file.
- Version 2: Introduced in paimon 0.3. Add "version" field and "changelogManifestList" field.
- Version 3: Introduced in paimon 0.4. Add "baseRecordCount" field, "deltaRecordCount" field and "changelogRecordCount" field.
Unversioned change list:
- Since paimon 0.2 and paimon 0.3, commitIdentifier is changed from a String to a long value. For paimon < 0.2, only Flink connectors have paimon sink and they use checkpointId as commitIdentifier (which is a long value). Json can automatically perform type conversion so there is no compatibility issue.
Since:

0.9.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Snapshot.CommitKind
Type of changes in this snapshot.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Snapshot.CommitKind` Type of changes in this snapshot.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`baseManifestList`
`protected String`	`changelogManifestList`
`protected Long`	`changelogRecordCount`
`protected long`	`commitIdentifier`
`protected Snapshot.CommitKind`	`commitKind`
`protected String`	`commitUser`
`protected static int`	`CURRENT_VERSION`
`protected String`	`deltaManifestList`
`protected Long`	`deltaRecordCount`
`protected static String`	`FIELD_BASE_MANIFEST_LIST`
`protected static String`	`FIELD_CHANGELOG_MANIFEST_LIST`
`protected static String`	`FIELD_CHANGELOG_RECORD_COUNT`
`protected static String`	`FIELD_COMMIT_IDENTIFIER`
`protected static String`	`FIELD_COMMIT_KIND`
`protected static String`	`FIELD_COMMIT_USER`
`protected static String`	`FIELD_DELTA_MANIFEST_LIST`
`protected static String`	`FIELD_DELTA_RECORD_COUNT`
`protected static String`	`FIELD_ID`
`protected static String`	`FIELD_INDEX_MANIFEST`
`protected static String`	`FIELD_LOG_OFFSETS`
`protected static String`	`FIELD_SCHEMA_ID`
`protected static String`	`FIELD_STATISTICS`
`protected static String`	`FIELD_TIME_MILLIS`
`protected static String`	`FIELD_TOTAL_RECORD_COUNT`
`protected static String`	`FIELD_VERSION`
`protected static String`	`FIELD_WATERMARK`
`static long`	`FIRST_SNAPSHOT_ID`
`protected long`	`id`
`protected String`	`indexManifest`
`protected Map<Integer,Long>`	`logOffsets`
`protected long`	`schemaId`
`protected String`	`statistics`
`static int`	`TABLE_STORE_02_VERSION`
`protected long`	`timeMillis`
`protected Long`	`totalRecordCount`
`protected Integer`	`version`
`protected Long`	`watermark`

Constructor Summary

Constructors
Constructor and Description
`Snapshot(Integer version, long id, long schemaId, String baseManifestList, String deltaManifestList, String changelogManifestList, String indexManifest, String commitUser, long commitIdentifier, Snapshot.CommitKind commitKind, long timeMillis, Map<Integer,Long> logOffsets, Long totalRecordCount, Long deltaRecordCount, Long changelogRecordCount, Long watermark, String statistics)`
`Snapshot(long id, long schemaId, String baseManifestList, String deltaManifestList, String changelogManifestList, String indexManifest, String commitUser, long commitIdentifier, Snapshot.CommitKind commitKind, long timeMillis, Map<Integer,Long> logOffsets, Long totalRecordCount, Long deltaRecordCount, Long changelogRecordCount, Long watermark, String statistics)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`baseManifestList()`
`String`	`changelogManifestList()`
`Long`	`changelogRecordCount()`
`long`	`commitIdentifier()`
`Snapshot.CommitKind`	`commitKind()`
`String`	`commitUser()`
`String`	`deltaManifestList()`
`Long`	`deltaRecordCount()`
`boolean`	`equals(Object o)`
`static Snapshot`	`fromJson(String json)`
`static Snapshot`	`fromPath(FileIO fileIO, Path path)`
`int`	`hashCode()`
`long`	`id()`
`String`	`indexManifest()`
`Map<Integer,Long>`	`logOffsets()`
`long`	`schemaId()`
`String`	`statistics()`
`long`	`timeMillis()`
`String`	`toJson()`
`Long`	`totalRecordCount()`
`static Snapshot`	`tryFromPath(FileIO fileIO, Path path)`
`int`	`version()`
`Long`	`watermark()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIRST_SNAPSHOT_ID
```
public static final long FIRST_SNAPSHOT_ID
```
See Also:

Constant Field Values

TABLE_STORE_02_VERSION
```
public static final int TABLE_STORE_02_VERSION
```
See Also:

Constant Field Values

CURRENT_VERSION
```
protected static final int CURRENT_VERSION
```
See Also:

Constant Field Values

FIELD_VERSION

protected static final String FIELD_VERSION

See Also:: Constant Field Values

FIELD_ID
```
protected static final String FIELD_ID
```
See Also:

Constant Field Values

FIELD_SCHEMA_ID

protected static final String FIELD_SCHEMA_ID

See Also:: Constant Field Values

FIELD_BASE_MANIFEST_LIST

protected static final String FIELD_BASE_MANIFEST_LIST

See Also:: Constant Field Values

FIELD_DELTA_MANIFEST_LIST

protected static final String FIELD_DELTA_MANIFEST_LIST

See Also:: Constant Field Values

FIELD_CHANGELOG_MANIFEST_LIST

protected static final String FIELD_CHANGELOG_MANIFEST_LIST

See Also:: Constant Field Values

FIELD_INDEX_MANIFEST

protected static final String FIELD_INDEX_MANIFEST

See Also:: Constant Field Values

FIELD_COMMIT_USER

protected static final String FIELD_COMMIT_USER

See Also:: Constant Field Values

FIELD_COMMIT_IDENTIFIER

protected static final String FIELD_COMMIT_IDENTIFIER

See Also:: Constant Field Values

FIELD_COMMIT_KIND

protected static final String FIELD_COMMIT_KIND

See Also:: Constant Field Values

FIELD_TIME_MILLIS

protected static final String FIELD_TIME_MILLIS

See Also:: Constant Field Values

FIELD_LOG_OFFSETS

protected static final String FIELD_LOG_OFFSETS

See Also:: Constant Field Values

FIELD_TOTAL_RECORD_COUNT

protected static final String FIELD_TOTAL_RECORD_COUNT

See Also:: Constant Field Values

FIELD_DELTA_RECORD_COUNT

protected static final String FIELD_DELTA_RECORD_COUNT

See Also:: Constant Field Values

FIELD_CHANGELOG_RECORD_COUNT

protected static final String FIELD_CHANGELOG_RECORD_COUNT

See Also:: Constant Field Values

FIELD_WATERMARK

protected static final String FIELD_WATERMARK

See Also:: Constant Field Values

FIELD_STATISTICS

protected static final String FIELD_STATISTICS

See Also:: Constant Field Values

version

@Nullable
protected final Integer version

id
```
protected final long id
```

schemaId
```
protected final long schemaId
```

baseManifestList

protected final String baseManifestList

deltaManifestList

protected final String deltaManifestList

changelogManifestList

@Nullable
protected final String changelogManifestList

indexManifest
```
protected final String indexManifest
```

commitUser
```
protected final String commitUser
```

commitIdentifier
```
protected final long commitIdentifier
```

commitKind

protected final Snapshot.CommitKind commitKind

timeMillis
```
protected final long timeMillis
```

logOffsets

@Nullable
protected final Map<Integer,Long> logOffsets

totalRecordCount

@Nullable
protected final Long totalRecordCount

deltaRecordCount

@Nullable
protected final Long deltaRecordCount

changelogRecordCount

@Nullable
protected final Long changelogRecordCount

watermark

@Nullable
protected final Long watermark

statistics

@Nullable
protected final String statistics

Constructor Detail

Snapshot

public Snapshot(long id,
                long schemaId,
                String baseManifestList,
                String deltaManifestList,
                @Nullable
                String changelogManifestList,
                @Nullable
                String indexManifest,
                String commitUser,
                long commitIdentifier,
                Snapshot.CommitKind commitKind,
                long timeMillis,
                Map<Integer,Long> logOffsets,
                @Nullable
                Long totalRecordCount,
                @Nullable
                Long deltaRecordCount,
                @Nullable
                Long changelogRecordCount,
                @Nullable
                Long watermark,
                @Nullable
                String statistics)

Snapshot

public Snapshot(@Nullable
                Integer version,
                long id,
                long schemaId,
                String baseManifestList,
                String deltaManifestList,
                @Nullable
                String changelogManifestList,
                @Nullable
                String indexManifest,
                String commitUser,
                long commitIdentifier,
                Snapshot.CommitKind commitKind,
                long timeMillis,
                @Nullable
                Map<Integer,Long> logOffsets,
                @Nullable
                Long totalRecordCount,
                @Nullable
                Long deltaRecordCount,
                @Nullable
                Long changelogRecordCount,
                @Nullable
                Long watermark,
                @Nullable
                String statistics)

Method Detail

version
```
public int version()
```

id
```
public long id()
```

schemaId
```
public long schemaId()
```

baseManifestList
```
public String baseManifestList()
```

deltaManifestList
```
public String deltaManifestList()
```

changelogManifestList

@Nullable
public String changelogManifestList()

indexManifest

@Nullable
public String indexManifest()

commitUser
```
public String commitUser()
```

commitIdentifier
```
public long commitIdentifier()
```

commitKind

public Snapshot.CommitKind commitKind()

timeMillis
```
public long timeMillis()
```

logOffsets

@Nullable
public Map<Integer,Long> logOffsets()

totalRecordCount

@Nullable
public Long totalRecordCount()

deltaRecordCount

@Nullable
public Long deltaRecordCount()

changelogRecordCount

@Nullable
public Long changelogRecordCount()

watermark
```
@Nullable
public Long watermark()
```

statistics
```
@Nullable
public String statistics()
```

toJson
```
public String toJson()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

fromJson

public static Snapshot fromJson(String json)

fromPath

public static Snapshot fromPath(FileIO fileIO,
                                Path path)

tryFromPath

public static Snapshot tryFromPath(FileIO fileIO,
                                   Path path)
                            throws FileNotFoundException

Throws:: FileNotFoundException

Back to Paimon Website

Class Snapshot

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIRST_SNAPSHOT_ID

TABLE_STORE_02_VERSION

CURRENT_VERSION

FIELD_VERSION

FIELD_ID

FIELD_SCHEMA_ID

FIELD_BASE_MANIFEST_LIST

FIELD_DELTA_MANIFEST_LIST

FIELD_CHANGELOG_MANIFEST_LIST

FIELD_INDEX_MANIFEST

FIELD_COMMIT_USER

FIELD_COMMIT_IDENTIFIER

FIELD_COMMIT_KIND

FIELD_TIME_MILLIS

FIELD_LOG_OFFSETS

FIELD_TOTAL_RECORD_COUNT

FIELD_DELTA_RECORD_COUNT

FIELD_CHANGELOG_RECORD_COUNT

FIELD_WATERMARK

FIELD_STATISTICS

version

id

schemaId

baseManifestList

deltaManifestList

changelogManifestList

indexManifest

commitUser

commitIdentifier

commitKind

timeMillis

logOffsets

totalRecordCount

deltaRecordCount

changelogRecordCount

watermark

statistics

Constructor Detail

Snapshot

Snapshot

Method Detail

version

id

schemaId

baseManifestList

deltaManifestList

changelogManifestList

indexManifest

commitUser

commitIdentifier

commitKind

timeMillis

logOffsets

totalRecordCount

deltaRecordCount

changelogRecordCount

watermark

statistics

toJson

hashCode

equals

fromJson

fromPath

tryFromPath

Back to Paimon Website