core/src/test/java/org/apache/iceberg/TestDeleteFileIndex.java

/*
 * 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.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap;
import org.apache.iceberg.relocated.com.google.common.collect.Iterables;
import org.apache.iceberg.relocated.com.google.common.collect.Lists;
import org.apache.iceberg.relocated.com.google.common.collect.Sets;
import org.apache.iceberg.util.Pair;
import org.apache.iceberg.util.StructLikeWrapper;
import org.junit.Assert;
import org.junit.Test;

public class TestDeleteFileIndex extends TableTestBase {
  public TestDeleteFileIndex() {
    super(2 /* table format version */);
  }

  static final DeleteFile FILE_A_POS_1 = FileMetadata.deleteFileBuilder(SPEC)
      .ofPositionDeletes()
      .withPath("/path/to/data-a-pos-deletes.parquet")
      .withFileSizeInBytes(10)
      .withPartition(FILE_A.partition())
      .withRecordCount(1)
      .build();
  static final DeleteFile FILE_A_POS_2 = FILE_A_POS_1.copy();

  static final DeleteFile FILE_A_EQ_1 = FileMetadata.deleteFileBuilder(SPEC)
      .ofEqualityDeletes()
      .withPath("/path/to/data-a-eq-deletes.parquet")
      .withFileSizeInBytes(10)
      .withPartition(FILE_A.partition())
      .withRecordCount(1)
      .build();
  static final DeleteFile FILE_A_EQ_2 = FILE_A_EQ_1.copy();
  static final DeleteFile[] DELETE_FILES = new DeleteFile[] { FILE_A_POS_1, FILE_A_EQ_1, FILE_A_POS_2, FILE_A_EQ_2 };

  static final DataFile UNPARTITIONED_FILE = DataFiles.builder(PartitionSpec.unpartitioned())
      .withPath("/path/to/data-unpartitioned.parquet")
      .withFileSizeInBytes(10)
      .withRecordCount(1)
      .build();

  static final DeleteFile UNPARTITIONED_POS_DELETES = FileMetadata.deleteFileBuilder(PartitionSpec.unpartitioned())
      .ofPositionDeletes()
      .withPath("/path/to/data-unpartitioned-pos-deletes.parquet")
      .withFileSizeInBytes(10)
      .withRecordCount(1)
      .build();

  static final DeleteFile UNPARTITIONED_EQ_DELETES = FileMetadata.deleteFileBuilder(PartitionSpec.unpartitioned())
      .ofEqualityDeletes()
      .withPath("/path/to/data-unpartitioned-eq-deletes.parquet")
      .withFileSizeInBytes(10)
      .withRecordCount(1)
      .build();

  @Test
  public void testUnpartitionedDeletes() {
    DeleteFileIndex index = new DeleteFileIndex(
        ImmutableMap.of(
            PartitionSpec.unpartitioned().specId(), PartitionSpec.unpartitioned(),
            1, SPEC),
        new long[] { 3, 5, 5, 6 }, DELETE_FILES, ImmutableMap.of());

    Assert.assertArrayEquals("All deletes should apply to seq 0",
        DELETE_FILES, index.forDataFile(0, UNPARTITIONED_FILE));
    Assert.assertArrayEquals("All deletes should apply to seq 3",
        DELETE_FILES, index.forDataFile(3, UNPARTITIONED_FILE));
    Assert.assertArrayEquals("Last 3 deletes should apply to seq 4",
        Arrays.copyOfRange(DELETE_FILES, 1, 4), index.forDataFile(4, UNPARTITIONED_FILE));
    Assert.assertArrayEquals("Last 3 deletes should apply to seq 5",
        Arrays.copyOfRange(DELETE_FILES, 1, 4), index.forDataFile(5, UNPARTITIONED_FILE));
    Assert.assertArrayEquals("Last delete should apply to seq 6",
        Arrays.copyOfRange(DELETE_FILES, 3, 4), index.forDataFile(6, UNPARTITIONED_FILE));
    Assert.assertArrayEquals("No deletes should apply to seq 7",
        new DataFile[0], index.forDataFile(7, UNPARTITIONED_FILE));
    Assert.assertArrayEquals("No deletes should apply to seq 10",
        new DataFile[0], index.forDataFile(10, UNPARTITIONED_FILE));

    // copy file A with a different spec ID
    DataFile partitionedFileA = FILE_A.copy();
    ((BaseFile<?>) partitionedFileA).setSpecId(1);
    Assert.assertArrayEquals("All global deletes should apply to a partitioned file",
        DELETE_FILES, index.forDataFile(0, partitionedFileA));
  }

  @Test
  public void testPartitionedDeleteIndex() {
    DeleteFileIndex index = new DeleteFileIndex(
        ImmutableMap.of(
            SPEC.specId(), SPEC,
            1, PartitionSpec.unpartitioned()),
        null, null, ImmutableMap.of(
            Pair.of(SPEC.specId(), StructLikeWrapper.forType(SPEC.partitionType()).set(FILE_A.partition())),
            Pair.of(new long[] { 3, 5, 5, 6 }, DELETE_FILES),
            Pair.of(SPEC.specId(), StructLikeWrapper.forType(SPEC.partitionType()).set(FILE_C.partition())),
            Pair.of(new long[0], new DeleteFile[0])));

    Assert.assertArrayEquals("All deletes should apply to seq 0",
        DELETE_FILES, index.forDataFile(0, FILE_A));
    Assert.assertArrayEquals("All deletes should apply to seq 3",
        DELETE_FILES, index.forDataFile(3, FILE_A));
    Assert.assertArrayEquals("Last 3 deletes should apply to seq 4",
        Arrays.copyOfRange(DELETE_FILES, 1, 4), index.forDataFile(4, FILE_A));
    Assert.assertArrayEquals("Last 3 deletes should apply to seq 5",
        Arrays.copyOfRange(DELETE_FILES, 1, 4), index.forDataFile(5, FILE_A));
    Assert.assertArrayEquals("Last delete should apply to seq 6",
        Arrays.copyOfRange(DELETE_FILES, 3, 4), index.forDataFile(6, FILE_A));
    Assert.assertArrayEquals("No deletes should apply to seq 7",
        new DataFile[0], index.forDataFile(7, FILE_A));
    Assert.assertArrayEquals("No deletes should apply to seq 10",
        new DataFile[0], index.forDataFile(10, FILE_A));

    Assert.assertEquals("No deletes should apply to FILE_B, partition not in index",
        0, index.forDataFile(0, FILE_B).length);

    Assert.assertEquals("No deletes should apply to FILE_C, no indexed delete files",
        0, index.forDataFile(0, FILE_C).length);

    DataFile unpartitionedFileA = FILE_A.copy();
    ((BaseFile<?>) unpartitionedFileA).setSpecId(1);
    Assert.assertEquals("No deletes should apply to FILE_A with a different specId",
        0, index.forDataFile(0, unpartitionedFileA).length);
  }

  @Test
  public void testUnpartitionedTableScan() throws IOException {
    File location = temp.newFolder();
    Assert.assertTrue(location.delete());

    Table unpartitioned = TestTables.create(location, "unpartitioned", SCHEMA, PartitionSpec.unpartitioned(), 2);

    unpartitioned.newAppend()
        .appendFile(UNPARTITIONED_FILE)
        .commit();

    // add a delete file
    unpartitioned.newRowDelta()
        .addDeletes(UNPARTITIONED_POS_DELETES)
        .commit();

    List<FileScanTask> tasks = Lists.newArrayList(unpartitioned.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        UNPARTITIONED_FILE.path(), task.file().path());
    Assert.assertEquals("Should have one associated delete file",
        1, task.deletes().size());
    Assert.assertEquals("Should have expected delete file",
        UNPARTITIONED_POS_DELETES.path(), task.deletes().get(0).path());

    // add a second delete file
    unpartitioned.newRowDelta()
        .addDeletes(UNPARTITIONED_EQ_DELETES)
        .commit();

    tasks = Lists.newArrayList(unpartitioned.newScan().planFiles().iterator());
    task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        UNPARTITIONED_FILE.path(), task.file().path());
    Assert.assertEquals("Should have two associated delete files",
        2, task.deletes().size());
    Assert.assertEquals("Should have expected delete files",
        Sets.newHashSet(UNPARTITIONED_POS_DELETES.path(), UNPARTITIONED_EQ_DELETES.path()),
        Sets.newHashSet(Iterables.transform(task.deletes(), ContentFile::path)));
  }

  @Test
  public void testPartitionedTableWithPartitionPosDeletes() {
    table.newAppend()
        .appendFile(FILE_A)
        .commit();

    table.newRowDelta()
        .addDeletes(FILE_A_POS_1)
        .commit();

    List<FileScanTask> tasks = Lists.newArrayList(table.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        FILE_A.path(), task.file().path());
    Assert.assertEquals("Should have one associated delete file",
        1, task.deletes().size());
    Assert.assertEquals("Should have only pos delete file",
        FILE_A_POS_1.path(), task.deletes().get(0).path());
  }

  @Test
  public void testPartitionedTableWithPartitionEqDeletes() {
    table.newAppend()
        .appendFile(FILE_A)
        .commit();

    table.newRowDelta()
        .addDeletes(FILE_A_EQ_1)
        .commit();

    List<FileScanTask> tasks = Lists.newArrayList(table.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        FILE_A.path(), task.file().path());
    Assert.assertEquals("Should have one associated delete file",
        1, task.deletes().size());
    Assert.assertEquals("Should have only pos delete file",
        FILE_A_EQ_1.path(), task.deletes().get(0).path());
  }

  @Test
  public void testPartitionedTableWithUnrelatedPartitionDeletes() {
    table.newAppend()
        .appendFile(FILE_B)
        .commit();

    table.newRowDelta()
        .addDeletes(FILE_A_POS_1)
        .addDeletes(FILE_A_EQ_1)
        .commit();

    List<FileScanTask> tasks = Lists.newArrayList(table.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        FILE_B.path(), task.file().path());
    Assert.assertEquals("Should have one associated delete file",
        0, task.deletes().size());
  }

  @Test
  public void testPartitionedTableWithOlderPartitionDeletes() {
    table.newRowDelta()
        .addDeletes(FILE_A_POS_1)
        .addDeletes(FILE_A_EQ_1)
        .commit();

    table.newAppend()
        .appendFile(FILE_A)
        .commit();

    List<FileScanTask> tasks = Lists.newArrayList(table.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        FILE_A.path(), task.file().path());
    Assert.assertEquals("Should have no delete files to apply",
        0, task.deletes().size());
  }

  @Test
  public void testPartitionedTableScanWithGlobalDeletes() {
    table.newAppend()
        .appendFile(FILE_A)
        .commit();

    TableMetadata base = table.ops().current();
    table.ops().commit(base, base.updatePartitionSpec(PartitionSpec.unpartitioned()));

    // add unpartitioned equality and position deletes, but only equality deletes are global
    table.newRowDelta()
        .addDeletes(UNPARTITIONED_POS_DELETES)
        .addDeletes(UNPARTITIONED_EQ_DELETES)
        .commit();

    List<FileScanTask> tasks = Lists.newArrayList(table.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        FILE_A.path(), task.file().path());
    Assert.assertEquals("Should have one associated delete file",
        1, task.deletes().size());
    Assert.assertEquals("Should have expected delete file",
        UNPARTITIONED_EQ_DELETES.path(), task.deletes().get(0).path());
  }

  @Test
  public void testPartitionedTableScanWithGlobalAndPartitionDeletes() {
    table.newAppend()
        .appendFile(FILE_A)
        .commit();

    table.newRowDelta()
        .addDeletes(FILE_A_EQ_1)
        .commit();

    TableMetadata base = table.ops().current();
    table.ops().commit(base, base.updatePartitionSpec(PartitionSpec.unpartitioned()));

    // add unpartitioned equality and position deletes, but only equality deletes are global
    table.newRowDelta()
        .addDeletes(UNPARTITIONED_POS_DELETES)
        .addDeletes(UNPARTITIONED_EQ_DELETES)
        .commit();

    List<FileScanTask> tasks = Lists.newArrayList(table.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        FILE_A.path(), task.file().path());
    Assert.assertEquals("Should have two associated delete files",
        2, task.deletes().size());
    Assert.assertEquals("Should have expected delete files",
        Sets.newHashSet(UNPARTITIONED_EQ_DELETES.path(), FILE_A_EQ_1.path()),
        Sets.newHashSet(Iterables.transform(task.deletes(), ContentFile::path)));
  }

  @Test
  public void testPartitionedTableSequenceNumbers() {
    table.newRowDelta()
        .addRows(FILE_A)
        .addDeletes(FILE_A_EQ_1)
        .addDeletes(FILE_A_POS_1)
        .commit();

    List<FileScanTask> tasks = Lists.newArrayList(table.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        FILE_A.path(), task.file().path());
    Assert.assertEquals("Should have one associated delete file",
        1, task.deletes().size());
    Assert.assertEquals("Should have only pos delete file",
        FILE_A_POS_1.path(), task.deletes().get(0).path());
  }

  @Test
  public void testUnpartitionedTableSequenceNumbers() throws IOException {
    File location = temp.newFolder();
    Assert.assertTrue(location.delete());

    Table unpartitioned = TestTables.create(location, "unpartitioned", SCHEMA, PartitionSpec.unpartitioned(), 2);

    // add data, pos deletes, and eq deletes in the same sequence number
    // the position deletes will be applied to the data file, but the equality deletes will not
    unpartitioned.newRowDelta()
        .addRows(UNPARTITIONED_FILE)
        .addDeletes(UNPARTITIONED_POS_DELETES)
        .addDeletes(UNPARTITIONED_EQ_DELETES)
        .commit();

    Assert.assertEquals("Table should contain 2 delete files",
        2, (long) unpartitioned.currentSnapshot().deleteManifests().get(0).addedFilesCount());

    List<FileScanTask> tasks = Lists.newArrayList(unpartitioned.newScan().planFiles().iterator());
    Assert.assertEquals("Should have one task", 1, tasks.size());

    FileScanTask task = tasks.get(0);
    Assert.assertEquals("Should have the correct data file path",
        UNPARTITIONED_FILE.path(), task.file().path());
    Assert.assertEquals("Should have one associated delete file",
        1, task.deletes().size());
    Assert.assertEquals("Should have only pos delete file",
        UNPARTITIONED_POS_DELETES.path(), task.deletes().get(0).path());
  }
}