[AMORO-1960] Refactor data expiration to TableMaintainer

ams/server/src/main/java/com/netease/arctic/server/optimizing/maintainer/MixedTableMaintainer.java

@@ -18,10 +18,13 @@
 
 package com.netease.arctic.server.optimizing.maintainer;
 
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.Maps;
 import com.netease.arctic.IcebergFileEntry;
 import com.netease.arctic.data.FileNameRules;
 import com.netease.arctic.hive.utils.TableTypeUtil;
 import com.netease.arctic.scan.TableEntriesScan;
+import com.netease.arctic.server.table.DataExpirationConfig;
 import com.netease.arctic.server.table.TableRuntime;
 import com.netease.arctic.server.utils.HiveLocationUtil;
 import com.netease.arctic.server.utils.IcebergTableUtil;
@@ -36,24 +39,35 @@
 import com.netease.arctic.utils.TablePropertyUtil;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.collections.MapUtils;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.iceberg.ContentFile;
 import org.apache.iceberg.DataFile;
 import org.apache.iceberg.DeleteFiles;
 import org.apache.iceberg.FileContent;
 import org.apache.iceberg.Snapshot;
+import org.apache.iceberg.StructLike;
+import org.apache.iceberg.expressions.Expression;
+import org.apache.iceberg.expressions.Literal;
 import org.apache.iceberg.io.CloseableIterable;
 import org.apache.iceberg.relocated.com.google.common.collect.Sets;
 import org.apache.iceberg.relocated.com.google.common.primitives.Longs;
+import org.apache.iceberg.types.Types;
 import org.apache.iceberg.util.StructLikeMap;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.io.UncheckedIOException;
+import java.time.Instant;
+import java.time.ZoneId;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
+import java.util.Queue;
 import java.util.Set;
+import java.util.concurrent.LinkedTransferQueue;
 import java.util.stream.Collectors;
 
 /** Table maintainer for mixed-iceberg and mixed-hive tables. */
@@ -120,18 +134,141 @@
     baseMaintainer.expireSnapshots(tableRuntime);
   }
 
-  @Override
-  public void autoCreateTags(TableRuntime tableRuntime) {
-    throw new UnsupportedOperationException("Mixed table doesn't support auto create tags");
-  }
-
   protected void expireSnapshots(long mustOlderThan) {
     if (changeMaintainer != null) {
       changeMaintainer.expireSnapshots(mustOlderThan);
     }
     baseMaintainer.expireSnapshots(mustOlderThan);
   }
 
+  @Override
+  public void expireData(TableRuntime tableRuntime) {
+    try {
+      DataExpirationConfig expirationConfig =
+          tableRuntime.getTableConfiguration().getExpiringDataConfig();
+      Types.NestedField field =
+          arcticTable.schema().findField(expirationConfig.getExpirationField());
+      if (!expirationConfig.isValid(field, arcticTable.name())) {
+        return;
+      }
+      ZoneId defaultZone = IcebergTableMaintainer.getDefaultZoneId(field);
+      Instant startInstant;
+      if (expirationConfig.getSince() == DataExpirationConfig.Since.CURRENT_TIMESTAMP) {
+        startInstant = Instant.now().atZone(defaultZone).toInstant();
+      } else {
+        long latestBaseTs =
+            IcebergTableMaintainer.fetchLatestNonOptimizedSnapshotTime(baseMaintainer.getTable());
+        long latestChangeTs =
+            changeMaintainer == null
+                ? Long.MAX_VALUE
+                : IcebergTableMaintainer.fetchLatestNonOptimizedSnapshotTime(
+                    changeMaintainer.getTable());
+        long latestNonOptimizedTs = Longs.min(latestChangeTs, latestBaseTs);
+
+        startInstant = Instant.ofEpochMilli(latestNonOptimizedTs).atZone(defaultZone).toInstant();
+      }
+      expireDataFrom(expirationConfig, startInstant);
+    } catch (Throwable t) {
+      LOG.error("Unexpected purge error for table {} ", tableRuntime.getTableIdentifier(), t);
+    }
+  }
+
+  @VisibleForTesting
+  public void expireDataFrom(DataExpirationConfig expirationConfig, Instant instant) {
+    long expireTimestamp = instant.minusMillis(expirationConfig.getRetentionTime()).toEpochMilli();
+    Types.NestedField field = arcticTable.schema().findField(expirationConfig.getExpirationField());
+    LOG.info(
+        "Expiring data older than {} in mixed table {} ",
+        Instant.ofEpochMilli(expireTimestamp)
+            .atZone(IcebergTableMaintainer.getDefaultZoneId(field))
+            .toLocalDateTime(),
+        arcticTable.name());
+
+    Expression dataFilter =
+        IcebergTableMaintainer.getDataExpression(
+            arcticTable.schema(), expirationConfig, expireTimestamp);
+
+    Pair<IcebergTableMaintainer.ExpireFiles, IcebergTableMaintainer.ExpireFiles> mixedExpiredFiles =
+        mixedExpiredFileScan(expirationConfig, dataFilter, expireTimestamp);
+
+    expireMixedFiles(mixedExpiredFiles.getLeft(), mixedExpiredFiles.getRight(), expireTimestamp);
+  }
+
+  private Pair<IcebergTableMaintainer.ExpireFiles, IcebergTableMaintainer.ExpireFiles>
+      mixedExpiredFileScan(
+          DataExpirationConfig expirationConfig, Expression dataFilter, long expireTimestamp) {
+    return arcticTable.isKeyedTable()
+        ? keyedExpiredFileScan(expirationConfig, dataFilter, expireTimestamp)
+        : Pair.of(
+            new IcebergTableMaintainer.ExpireFiles(),
+            getBaseMaintainer().expiredFileScan(expirationConfig, dataFilter, expireTimestamp));
+  }
+
+  private Pair<IcebergTableMaintainer.ExpireFiles, IcebergTableMaintainer.ExpireFiles>
+      keyedExpiredFileScan(
+          DataExpirationConfig expirationConfig, Expression dataFilter, long expireTimestamp) {
+    Map<StructLike, IcebergTableMaintainer.DataFileFreshness> partitionFreshness =
+        Maps.newConcurrentMap();
+
+    KeyedTable keyedTable = arcticTable.asKeyedTable();
+    ChangeTable changeTable = keyedTable.changeTable();
+    BaseTable baseTable = keyedTable.baseTable();
+
+    CloseableIterable<MixedFileEntry> changeEntries =
+        CloseableIterable.transform(
+            changeMaintainer.fileScan(changeTable, dataFilter, expirationConfig),
+            e -> new MixedFileEntry(e.getFile(), e.getTsBound(), true));
+    CloseableIterable<MixedFileEntry> baseEntries =
+        CloseableIterable.transform(
+            baseMaintainer.fileScan(baseTable, dataFilter, expirationConfig),
+            e -> new MixedFileEntry(e.getFile(), e.getTsBound(), false));
+    IcebergTableMaintainer.ExpireFiles changeExpiredFiles =
+        new IcebergTableMaintainer.ExpireFiles();
+    IcebergTableMaintainer.ExpireFiles baseExpiredFiles = new IcebergTableMaintainer.ExpireFiles();
+
+    try (CloseableIterable<MixedFileEntry> entries =
+        CloseableIterable.withNoopClose(
+            com.google.common.collect.Iterables.concat(changeEntries, baseEntries))) {
+      Queue<MixedFileEntry> fileEntries = new LinkedTransferQueue<>();
+      entries.forEach(
+          e -> {
+            if (IcebergTableMaintainer.mayExpired(e, partitionFreshness, expireTimestamp)) {
+              fileEntries.add(e);
+            }
+          });
+      fileEntries
+          .parallelStream()
+          .filter(
+              e -> IcebergTableMaintainer.willNotRetain(e, expirationConfig, partitionFreshness))
+          .forEach(
+              e -> {
+                if (e.isChange()) {
+                  changeExpiredFiles.addFile(e);
+                } else {
+                  baseExpiredFiles.addFile(e);
+                }
+              });
+    } catch (IOException e) {
+      throw new RuntimeException(e);
+    }
+
+    return Pair.of(changeExpiredFiles, baseExpiredFiles);
+  }
+
+  private void expireMixedFiles(
+      IcebergTableMaintainer.ExpireFiles changeFiles,
+      IcebergTableMaintainer.ExpireFiles baseFiles,
+      long expireTimestamp) {
+    Optional.ofNullable(changeMaintainer)
+        .ifPresent(c -> c.expireFiles(changeFiles, expireTimestamp));
+    Optional.ofNullable(baseMaintainer).ifPresent(c -> c.expireFiles(baseFiles, expireTimestamp));
+  }
+
+  @Override
+  public void autoCreateTags(TableRuntime tableRuntime) {
+    throw new UnsupportedOperationException("Mixed table doesn't support auto create tags");
+  }
+
   protected void cleanContentFiles(long lastTime) {
     if (changeMaintainer != null) {
       changeMaintainer.cleanContentFiles(lastTime);
@@ -341,4 +478,18 @@
       return Sets.union(changeFiles, hiveFiles);
     }
   }
+
+  public static class MixedFileEntry extends IcebergTableMaintainer.FileEntry {
+
+    private final boolean isChange;
+
+    MixedFileEntry(ContentFile<?> file, Literal<Long> tsBound, boolean isChange) {
+      super(file, tsBound);
+      this.isChange = isChange;
+    }
+
+    public boolean isChange() {
+      return isChange;
+    }
+  }
 }

ams/server/src/main/java/com/netease/arctic/server/optimizing/maintainer/TableMaintainer.java

@@ -42,6 +42,14 @@ public interface TableMaintainer {
    */
   void expireSnapshots(TableRuntime tableRuntime);
 
+  /**
+   * Expire historical data based on the expiration field, and data that exceeds the retention
+   * period will be purged
+   *
+   * @param tableRuntime TableRuntime
+   */
+  void expireData(TableRuntime tableRuntime);
+
   /** Auto create tags for table. */
   void autoCreateTags(TableRuntime tableRuntime);
 

ams/server/src/main/java/com/netease/arctic/server/table/DataExpirationConfig.java

@@ -12,6 +12,8 @@
 import org.apache.commons.lang3.StringUtils;
 import org.apache.iceberg.types.Type;
 import org.apache.iceberg.types.Types;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.Locale;
 import java.util.Map;
@@ -31,6 +33,8 @@
   private String dateTimePattern;
   // data-expire.datetime-number-format
   private String numberDateFormat;
+  // data-expire.since
+  private Since since;
 
   @VisibleForTesting
   public enum ExpireLevel {
@@ -47,9 +51,27 @@
     }
   }
 
+  @VisibleForTesting
+  public enum Since {
+    LATEST_SNAPSHOT,
+    CURRENT_TIMESTAMP;
+
+    public static Since fromString(String since) {
+      Preconditions.checkArgument(null != since, "data-expire.since is invalid: null");
+      try {
+        return Since.valueOf(since.toUpperCase(Locale.ENGLISH));
+      } catch (IllegalArgumentException e) {
+        throw new IllegalArgumentException(
+            String.format("Unable to expire data since: %s", since), e);
+      }
+    }
+  }
+
   public static final Set<Type.TypeID> FIELD_TYPES =
       Sets.newHashSet(Type.TypeID.TIMESTAMP, Type.TypeID.STRING, Type.TypeID.LONG);
 
+  private static final Logger LOG = LoggerFactory.getLogger(DataExpirationConfig.class);
+
   public DataExpirationConfig() {}
 
   public DataExpirationConfig(
@@ -58,13 +80,15 @@
       ExpireLevel expirationLevel,
       long retentionTime,
       String dateTimePattern,
-      String numberDateFormat) {
+      String numberDateFormat,
+      Since since) {
     this.enabled = enabled;
     this.expirationField = expirationField;
     this.expirationLevel = expirationLevel;
     this.retentionTime = retentionTime;
     this.dateTimePattern = dateTimePattern;
     this.numberDateFormat = numberDateFormat;
+    this.since = since;
   }
 
   public DataExpirationConfig(ArcticTable table) {
@@ -109,6 +133,12 @@
             properties,
             TableProperties.DATA_EXPIRATION_DATE_NUMBER_FORMAT,
             TableProperties.DATA_EXPIRATION_DATE_NUMBER_FORMAT_DEFAULT);
+    since =
+        Since.fromString(
+            CompatiblePropertyUtil.propertyAsString(
+                properties,
+                TableProperties.DATA_EXPIRATION_SINCE,
+                TableProperties.DATA_EXPIRATION_SINCE_DEFAULT));
   }
 
   public static DataExpirationConfig parse(Map<String, String> properties) {
@@ -137,7 +167,13 @@
                 CompatiblePropertyUtil.propertyAsString(
                     properties,
                     TableProperties.DATA_EXPIRATION_DATE_NUMBER_FORMAT,
-                    TableProperties.DATA_EXPIRATION_DATE_NUMBER_FORMAT_DEFAULT));
+                    TableProperties.DATA_EXPIRATION_DATE_NUMBER_FORMAT_DEFAULT))
+            .setSince(
+                Since.fromString(
+                    CompatiblePropertyUtil.propertyAsString(
+                        properties,
+                        TableProperties.DATA_EXPIRATION_SINCE,
+                        TableProperties.DATA_EXPIRATION_SINCE_DEFAULT)));
     String retention =
         CompatiblePropertyUtil.propertyAsString(
             properties, TableProperties.DATA_EXPIRATION_RETENTION_TIME, null);
@@ -202,6 +238,15 @@
     return this;
   }
 
+  public Since getSince() {
+    return since;
+  }
+
+  public DataExpirationConfig setSince(Since since) {
+    this.since = since;
+    return this;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -216,7 +261,8 @@
         && Objects.equal(expirationField, config.expirationField)
         && expirationLevel == config.expirationLevel
         && Objects.equal(dateTimePattern, config.dateTimePattern)
-        && Objects.equal(numberDateFormat, config.numberDateFormat);
+        && Objects.equal(numberDateFormat, config.numberDateFormat)
+        && since == config.since;
   }
 
   @Override
@@ -227,6 +273,38 @@
         expirationLevel,
         retentionTime,
         dateTimePattern,
-        numberDateFormat);
+        numberDateFormat,
+        since);
+  }
+
+  public boolean isValid(Types.NestedField field, String name) {
+    return isEnabled()
+        && getRetentionTime() > 0
+        && validateExpirationField(field, name, getExpirationField());
+  }
+
+  private boolean validateExpirationField(
+      Types.NestedField field, String name, String expirationField) {
+    if (StringUtils.isBlank(expirationField) || null == field) {
+      LOG.warn(
+          String.format(
+              "Field(%s) used to determine data expiration is illegal for table(%s)",
+              expirationField, name));
+      return false;
+    }
+    Type.TypeID typeID = field.type().typeId();
+    if (!DataExpirationConfig.FIELD_TYPES.contains(typeID)) {
+      LOG.warn(
+          String.format(
+              "Table(%s) field(%s) type(%s) is not supported for data expiration, please use the "
+                  + "following types: %s",
+              name,
+              expirationField,
+              typeID.name(),
+              StringUtils.join(DataExpirationConfig.FIELD_TYPES, ", ")));
+      return false;
+    }
+
+    return true;
   }
 }