rdblue commented on code in PR #15049: URL: https://github.com/apache/iceberg/pull/15049#discussion_r2898396244
########## core/src/main/java/org/apache/iceberg/TrackingInfo.java: ########## @@ -0,0 +1,153 @@ +/* + * 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.types.Types; + +/** + * Tracking information for a tracked file entry in a v4 manifest. + * + * <p>This groups the status, snapshot, and sequence number information for the entry. This enables + * accessing the fields for the entry and provides an isolated structure that can be modified. + */ +interface TrackingInfo { + Types.NestedField STATUS = + Types.NestedField.required( + 0, + "status", + Types.IntegerType.get(), + "Entry status: 0=existing, 1=added, 2=deleted, 3=replaced"); + Types.NestedField SNAPSHOT_ID = + Types.NestedField.optional( + 1, + "snapshot_id", + Types.LongType.get(), + "Snapshot ID where the file was added or deleted"); + Types.NestedField DV_SNAPSHOT_ID = + Types.NestedField.optional( + 157, + "dv_snapshot_id", + Types.LongType.get(), + "Snapshot ID where the DV was added. May only be defined when a deletion vector is present"); + Types.NestedField SEQUENCE_NUMBER = + Types.NestedField.optional( + 3, "sequence_number", Types.LongType.get(), "Data sequence number of the file"); + Types.NestedField FILE_SEQUENCE_NUMBER = + Types.NestedField.optional( + 4, + "file_sequence_number", + Types.LongType.get(), + "File sequence number indicating when the file was added"); + Types.NestedField FIRST_ROW_ID = + Types.NestedField.optional( + 142, "first_row_id", Types.LongType.get(), "ID of the first row in the data file"); + + Types.NestedField CHANGED_POSITIONS_DELETED = + Types.NestedField.optional( + 158, + "deleted", + Types.BinaryType.get(), + "Bitmap of positions deleted in this specific snapshot"); + Types.NestedField CHANGED_POSITIONS_REPLACED = + Types.NestedField.optional( + 159, + "replaced", + Types.BinaryType.get(), + "Bitmap of positions replaced in this specific snapshot"); + + Types.NestedField CHANGED_POSITIONS = + Types.NestedField.optional( + 153, + "changed_positions", + Types.StructType.of(CHANGED_POSITIONS_DELETED, CHANGED_POSITIONS_REPLACED), + "Bitmaps of deleted and replaced positions in this specific snapshot"); + + static Types.StructType schema() { + return Types.StructType.of( + STATUS, + SNAPSHOT_ID, + DV_SNAPSHOT_ID, + SEQUENCE_NUMBER, + FILE_SEQUENCE_NUMBER, + FIRST_ROW_ID, + CHANGED_POSITIONS); + } + + /** + * Returns the status of the entry. + * + * <p>Status values: + * + * <ul> + * <li>0: EXISTING - file was already in the table + * <li>1: ADDED - file newly added + * <li>2: DELETED - file removed + * <li>3: REPLACED - entry replaced by a column update or DV change (v4 only) Review Comment: We don't need to duplicate docs in so many places. Small duplication is okay, but there's a lot here, which means it is a lot to keep up to date. In that case, I prefer keeping docs minimal and deciding carefully where things should be documented. -- 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]
