[core] Add field-id.one-based option for strictly positive Iceberg field ids #9347
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * 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.paimon.types; | ||
|
|
||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| /** | ||
| * Shift every field id in a type by a fixed offset. Unlike {@link ReassignFieldId} this preserves | ||
| * the relative order and gaps of the existing ids, so the result is exactly the original id space | ||
| * translated by {@code offset}. | ||
| */ | ||
| public class ShiftFieldId extends DataTypeDefaultVisitor<DataType> { | ||
|
|
||
| private final int offset; | ||
|
|
||
| public ShiftFieldId(int offset) { | ||
| this.offset = offset; | ||
| } | ||
|
|
||
| public static DataType shift(DataType input, int offset) { | ||
| return input.accept(new ShiftFieldId(offset)); | ||
| } | ||
|
|
||
| @Override | ||
| public DataType visit(ArrayType arrayType) { | ||
| return new ArrayType(arrayType.isNullable(), arrayType.getElementType().accept(this)); | ||
| } | ||
|
|
||
| @Override | ||
| public DataType visit(VectorType vectorType) { | ||
| return new VectorType( | ||
| vectorType.isNullable(), | ||
| vectorType.getLength(), | ||
| vectorType.getElementType().accept(this)); | ||
| } | ||
|
|
||
| @Override | ||
| public DataType visit(MultisetType multisetType) { | ||
| return new MultisetType( | ||
| multisetType.isNullable(), multisetType.getElementType().accept(this)); | ||
| } | ||
|
|
||
| @Override | ||
| public DataType visit(MapType mapType) { | ||
| return new MapType( | ||
| mapType.isNullable(), | ||
| mapType.getKeyType().accept(this), | ||
| mapType.getValueType().accept(this)); | ||
| } | ||
|
|
||
| @Override | ||
| public DataType visit(RowType rowType) { | ||
| List<DataField> fields = | ||
| rowType.getFields().stream() | ||
| .map( | ||
| f -> | ||
| new DataField( | ||
| f.id() + offset, | ||
| f.name(), | ||
| f.type().accept(this), | ||
| f.description(), | ||
| f.defaultValue())) | ||
| .collect(Collectors.toList()); | ||
| return new RowType(rowType.isNullable(), fields); | ||
| } | ||
|
|
||
| @Override | ||
| protected DataType defaultMethod(DataType dataType) { | ||
| return dataType; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| /* | ||
| * 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.paimon.schema; | ||
|
|
||
| import org.apache.paimon.CoreOptions; | ||
| import org.apache.paimon.fs.Path; | ||
| import org.apache.paimon.fs.local.LocalFileIO; | ||
| import org.apache.paimon.types.ArrayType; | ||
| import org.apache.paimon.types.DataField; | ||
| import org.apache.paimon.types.DataTypes; | ||
| import org.apache.paimon.types.MapType; | ||
| import org.apache.paimon.types.RowType; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| import java.util.List; | ||
| import java.util.UUID; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
|
||
| /** Tests for {@link CoreOptions#FIELD_ID_ONE_BASED} at table creation and evolution. */ | ||
| public class FieldIdOneBasedTest { | ||
|
|
||
| @TempDir java.nio.file.Path tempDir; | ||
|
|
||
| private Schema.Builder schemaBuilder() { | ||
| return Schema.newBuilder() | ||
| .column("a", DataTypes.INT()) | ||
| .column( | ||
| "s", | ||
| DataTypes.ROW( | ||
| DataTypes.FIELD(0, "x", DataTypes.INT()), | ||
| DataTypes.FIELD(0, "y", DataTypes.STRING()))) | ||
| .column("m", DataTypes.MAP(DataTypes.STRING(), DataTypes.ARRAY(DataTypes.INT()))); | ||
| } | ||
|
|
||
| private SchemaManager newSchemaManager(String name) { | ||
| return new SchemaManager( | ||
| LocalFileIO.create(), | ||
| new Path(tempDir.toString() + "/" + name + UUID.randomUUID())); | ||
| } | ||
|
|
||
| @Test | ||
| public void testDefaultRemainsZeroBased() throws Exception { | ||
| TableSchema schema = newSchemaManager("t").createTable(schemaBuilder().build()); | ||
| assertThat(topLevelIds(schema)).containsExactly(0, 1, 4); | ||
| RowType nested = (RowType) schema.fields().get(1).type(); | ||
| assertThat(nested.getFields().get(0).id()).isEqualTo(2); | ||
| assertThat(nested.getFields().get(1).id()).isEqualTo(3); | ||
| assertThat(schema.highestFieldId()).isEqualTo(4); | ||
| } | ||
|
|
||
| @Test | ||
| public void testOneBasedShiftsAllIds() throws Exception { | ||
| TableSchema schema = | ||
| newSchemaManager("t") | ||
| .createTable( | ||
| schemaBuilder() | ||
| .option(CoreOptions.FIELD_ID_ONE_BASED.key(), "true") | ||
| .build()); | ||
| assertThat(topLevelIds(schema)).containsExactly(1, 2, 5); | ||
| RowType nested = (RowType) schema.fields().get(1).type(); | ||
| assertThat(nested.getFields().get(0).id()).isEqualTo(3); | ||
| assertThat(nested.getFields().get(1).id()).isEqualTo(4); | ||
| // map/array types carry no ids of their own; ensure the structure survived the shift | ||
| MapType map = (MapType) schema.fields().get(2).type(); | ||
| assertThat(map.getValueType()).isInstanceOf(ArrayType.class); | ||
| assertThat(schema.highestFieldId()).isEqualTo(5); | ||
| } | ||
|
|
||
| @Test | ||
| public void testEvolutionContinuesFromShiftedIds() throws Exception { | ||
| SchemaManager manager = newSchemaManager("t"); | ||
| manager.createTable( | ||
| schemaBuilder().option(CoreOptions.FIELD_ID_ONE_BASED.key(), "true").build()); | ||
| TableSchema evolved = manager.commitChanges(SchemaChange.addColumn("z", DataTypes.INT())); | ||
| DataField added = | ||
| evolved.fields().stream() | ||
| .filter(f -> f.name().equals("z")) | ||
| .findFirst() | ||
| .orElseThrow(IllegalStateException::new); | ||
| assertThat(added.id()).isEqualTo(6); | ||
| assertThat(evolved.highestFieldId()).isEqualTo(6); | ||
| } | ||
|
|
||
| @Test | ||
| public void testOneBasedImmutableAndCreateTimeOnly() throws Exception { | ||
| // registered as immutable, so ALTER is rejected once the table has snapshots | ||
| assertThat(CoreOptions.IMMUTABLE_OPTIONS).contains(CoreOptions.FIELD_ID_ONE_BASED.key()); | ||
| // ids are assigned once at creation, so changing the value is rejected even before the | ||
| // first snapshot: the ids would keep their base while the option claims another one | ||
| SchemaManager manager = newSchemaManager("t"); | ||
| manager.createTable(schemaBuilder().build()); | ||
| assertThatThrownBy( | ||
| () -> | ||
| manager.commitChanges( | ||
| SchemaChange.setOption( | ||
| CoreOptions.FIELD_ID_ONE_BASED.key(), "true"))) | ||
| .isInstanceOf(UnsupportedOperationException.class) | ||
| .hasMessageContaining(CoreOptions.FIELD_ID_ONE_BASED.key()); | ||
| // removing the option from a one-based table would change the effective value back | ||
| SchemaManager oneBased = newSchemaManager("t2"); | ||
| oneBased.createTable( | ||
| schemaBuilder().option(CoreOptions.FIELD_ID_ONE_BASED.key(), "true").build()); | ||
| assertThatThrownBy( | ||
| () -> | ||
| oneBased.commitChanges( | ||
| SchemaChange.removeOption( | ||
| CoreOptions.FIELD_ID_ONE_BASED.key()))) | ||
| .isInstanceOf(UnsupportedOperationException.class) | ||
| .hasMessageContaining(CoreOptions.FIELD_ID_ONE_BASED.key()); | ||
| // re-stating the current value is a no-op, not a change, and stays allowed | ||
| TableSchema unchanged = | ||
| manager.commitChanges( | ||
| SchemaChange.setOption(CoreOptions.FIELD_ID_ONE_BASED.key(), "false")); | ||
| assertThat(topLevelIds(unchanged)).containsExactly(0, 1, 4); | ||
| } | ||
|
|
||
| private static List<Integer> topLevelIds(TableSchema schema) { | ||
| return schema.fields().stream().map(DataField::id).collect(Collectors.toList()); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[P1] Preserve IDs when the input schema is already resolved
This unconditionally shifts every schema carrying
field-id.one-based=true, but some create paths pass a persistedTableSchemaback into table creation. In particular, SparkCopySchemaOperator.newSchemaFromTableSchemacopies both the already-shifted fields and this option, socopy_filesturns source IDs[1, 2, 5]into target IDs[2, 3, 6]. The copied Parquet files still contain the original IDs, leaving the target Iceberg metadata inconsistent with the physical files. Please make this transformation idempotent or provide an explicit path that preserves already-assigned IDs, and cover one-basedcopy_fileswith a regression test.