gaborkaszab commented on code in PR #16408: URL: https://github.com/apache/iceberg/pull/16408#discussion_r3347484677
########## core/src/main/java/org/apache/iceberg/TrackingBuilder.java: ########## @@ -0,0 +1,179 @@ +/* + * 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.nio.ByteBuffer; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.util.ByteBuffers; + +class TrackingBuilder { + private final EntryStatus status; + private final Long snapshotId; + private final Long dataSequenceNumber; + private final Long fileSequenceNumber; + private final Long firstRowId; + // ID of the snapshot in which the new Tracking instance will be committed. + private final long newSnapshotId; + private Long dvSnapshotId; + private byte[] deletedPositions; + private byte[] replacedPositions; + + /** + * Creates a builder for a newly added file. + * + * @param newSnapshotId the snapshot ID in which the new tracking instance will be committed + */ + static TrackingBuilder added(long newSnapshotId) { + return new TrackingBuilder(newSnapshotId); + } + + /** + * Creates a builder for a tracking row derived from {@code source}. + * + * @param source source tracking from a manifest entry + * @param newSnapshotId the snapshot ID in which the new tracking instance will be committed + */ + static TrackingBuilder from(Tracking source, long newSnapshotId) { + return new TrackingBuilder(source, newSnapshotId); + } + + /** + * Returns a DELETED tracking row derived from {@code source}. + * + * @param source source tracking from a manifest entry + * @param newSnapshotId the snapshot ID in which the new tracking instance will be committed + */ + static Tracking deleted(Tracking source, long newSnapshotId) { + return terminal(EntryStatus.DELETED, source, newSnapshotId); + } + + /** + * Returns a REPLACED tracking row derived from {@code source}. + * + * @param source source tracking from a manifest entry + * @param newSnapshotId the snapshot ID in which the new tracking instance will be committed + */ + static Tracking replaced(Tracking source, long newSnapshotId) { + return terminal(EntryStatus.REPLACED, source, newSnapshotId); + } + + private TrackingBuilder(long newSnapshotId) { + this.status = EntryStatus.ADDED; + this.snapshotId = newSnapshotId; + this.newSnapshotId = newSnapshotId; + this.dataSequenceNumber = null; + this.fileSequenceNumber = null; + this.firstRowId = null; + this.dvSnapshotId = null; + this.deletedPositions = null; + this.replacedPositions = null; + } + + private TrackingBuilder(Tracking source, long newSnapshotId) { + validateSource(source); + validateStatusTransition(source.status(), EntryStatus.EXISTING); + this.status = EntryStatus.EXISTING; + this.snapshotId = source.snapshotId(); + this.newSnapshotId = newSnapshotId; + this.dataSequenceNumber = source.dataSequenceNumber(); + this.fileSequenceNumber = source.fileSequenceNumber(); + this.firstRowId = source.firstRowId(); + this.dvSnapshotId = source.dvSnapshotId(); + this.deletedPositions = null; + this.replacedPositions = null; + } + + /** Indicates that the DV has been updated for the new Tracking. */ + TrackingBuilder dvUpdated() { + // DV applies to data files; deleted/replaced positions apply to manifest files + Preconditions.checkState( + deletedPositions == null && replacedPositions == null, + "Cannot mark DV updated on a manifest entry (deleted/replaced positions are set)"); + this.dvSnapshotId = newSnapshotId; + return this; + } + + TrackingBuilder deletedPositions(ByteBuffer positions) { + Preconditions.checkState( + status == EntryStatus.EXISTING, "Cannot set deleted positions on %s entry", status); + // DV applies to data files; deleted positions apply to manifest files + Preconditions.checkState( + dvSnapshotId == null, + "Cannot set deleted positions on a data file entry (DV snapshot ID is set)"); + this.deletedPositions = ByteBuffers.toByteArray(positions); + return this; + } + + TrackingBuilder replacedPositions(ByteBuffer positions) { + Preconditions.checkState( + status == EntryStatus.EXISTING, "Cannot set replaced positions on %s entry", status); + // DV applies to data files; replaced positions apply to manifest files + Preconditions.checkState( + dvSnapshotId == null, + "Cannot set replaced positions on a data file entry (DV snapshot ID is set)"); + this.replacedPositions = ByteBuffers.toByteArray(positions); + return this; + } + + Tracking build() { + return new TrackingStruct( + status, + snapshotId, + dataSequenceNumber, + fileSequenceNumber, + dvSnapshotId, + firstRowId, + deletedPositions, + replacedPositions); + } + + private static Tracking terminal(EntryStatus to, Tracking source, long newSnapshotId) { + validateSource(source); + validateStatusTransition(source.status(), to); + return new TrackingStruct( + to, + newSnapshotId, Review Comment: nit: this is against the description of Tracking.SNAPSHOT_ID that says `Snapshot ID where the file was added or deleted`. In fact, I think we should include REPLACED and MODIFIED too in the description based on the design here. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
