Will-Lo commented on code in PR #3560: URL: https://github.com/apache/gobblin/pull/3560#discussion_r972726137
########## gobblin-data-management/src/test/java/org/apache/gobblin/data/management/copy/iceberg/IcebergDatasetTest.java: ########## @@ -0,0 +1,189 @@ +/* + * 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.gobblin.data.management.copy.iceberg; + +import com.google.api.client.util.Maps; +import com.google.gson.Gson; +import com.google.gson.JsonObject; +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.time.Instant; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import org.apache.commons.lang.StringUtils; +import org.apache.gobblin.data.management.copy.CopyConfiguration; +import org.apache.gobblin.data.management.copy.CopyContext; +import org.apache.gobblin.data.management.copy.CopyEntity; +import org.apache.gobblin.data.management.copy.PreserveAttributes; +import org.apache.hadoop.fs.FileStatus; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.mockito.Mockito; +import org.testng.Assert; +import org.testng.annotations.Test; Review Comment: We follow an import guideline in Gobblin Intellij (sorry we don't document this well, it was news to me too recently but trying to enforce this where it makes sense). https://gobblin.readthedocs.io/en/latest/developer-guide/CodingStyle/ You can install this in intellij and have it autoapply in your files ########## gobblin-data-management/src/main/java/org/apache/gobblin/data/management/copy/iceberg/IcebergDatasetFinder.java: ########## @@ -0,0 +1,97 @@ +/* + * 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.gobblin.data.management.copy.iceberg; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.Properties; +import lombok.AllArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang.StringUtils; +import org.apache.gobblin.dataset.DatasetConstants; +import org.apache.gobblin.dataset.IterableDatasetFinder; +import org.apache.gobblin.util.HadoopUtils; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; + +/** + * Finds {@link IcebergDataset}s. Will look for tables in a database using a {@link IcebergCatalog}, + * and creates a {@link IcebergDataset} for each one. + */ +@Slf4j +@AllArgsConstructor +public class IcebergDatasetFinder implements IterableDatasetFinder<IcebergDataset> { + + public static final String ICEBERG_DATASET_PREFIX = DatasetConstants.PLATFORM_ICEBERG + ".dataset"; + public static final String ICEBERG_HIVE_CATALOG_METASTORE_URI_KEY = ICEBERG_DATASET_PREFIX + ".hive.metastore.uri"; + public static final String ICEBERG_DB_NAME = ICEBERG_DATASET_PREFIX + ".database.name"; + public static final String ICEBERG_TABLE_NAME = ICEBERG_DATASET_PREFIX + ".table.name"; + + private String dbName; + private String tblName; + private final Properties properties; + protected final FileSystem fs; + + /** + * Finds all {@link IcebergDataset}s in the file system using the Iceberg Catalog. + * @return List of {@link IcebergDataset}s in the file system. + * @throws IOException + */ + @Override + public List<IcebergDataset> findDatasets() throws IOException { + List<IcebergDataset> matchingDatasets = new ArrayList<>(); + /* + * Both Iceberg database name and table name are mandatory based on current implementation. + * Later we may explore supporting datasets similar to Hive + */ + if (StringUtils.isNotBlank(properties.getProperty(ICEBERG_DB_NAME)) || StringUtils.isNotBlank(properties.getProperty(ICEBERG_TABLE_NAME))) { + throw new IllegalArgumentException(String.format("Iceberg database name: {%s} or Iceberg table name: {%s} is missing", + ICEBERG_DB_NAME, ICEBERG_TABLE_NAME)); + } + this.dbName = properties.getProperty(ICEBERG_DB_NAME); + this.tblName = properties.getProperty(ICEBERG_TABLE_NAME); + + Configuration configuration = HadoopUtils.getConfFromProperties(properties); + + IcebergCatalog icebergCatalog = IcebergCatalogFactory.create(configuration); + /* Each Iceberg dataset maps to an Iceberg table + * TODO: The user provided database and table names needs to be pre-checked and verified against the existence of a valid Iceberg table + */ + matchingDatasets.add(createIcebergDataset(dbName, tblName, icebergCatalog, properties, fs)); + log.info("Found {} matching datasets: {}", matchingDatasets.size(), matchingDatasets); Review Comment: I like this log :) Can we add the db/table name to it as well? ########## gobblin-data-management/src/main/java/org/apache/gobblin/data/management/copy/iceberg/IcebergDataset.java: ########## @@ -0,0 +1,215 @@ +/* + * 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.gobblin.data.management.copy.iceberg; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Optional; +import com.google.common.collect.Iterators; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import java.io.IOException; +import java.net.URI; +import java.util.Collection; +import java.util.Comparator; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import lombok.Data; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; +import org.apache.gobblin.data.management.copy.CopyConfiguration; +import org.apache.gobblin.data.management.copy.CopyEntity; +import org.apache.gobblin.data.management.copy.CopyableDataset; +import org.apache.gobblin.data.management.copy.CopyableFile; +import org.apache.gobblin.data.management.copy.prioritization.PrioritizedCopyableDataset; +import org.apache.gobblin.data.management.partition.FileSet; +import org.apache.gobblin.dataset.DatasetConstants; +import org.apache.gobblin.dataset.DatasetDescriptor; +import org.apache.gobblin.util.request_allocation.PushDownRequestor; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileStatus; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.jetbrains.annotations.NotNull; + +/** + * Iceberg dataset implementing {@link CopyableDataset}. + */ +@Slf4j +@Getter +public class IcebergDataset implements PrioritizedCopyableDataset { + private final String dbName; + private final String inputTableName; + private IcebergTable icebergTable; + protected Properties properties; + protected FileSystem fs; + + private Optional<String> sourceMetastoreURI; + private Optional<String> targetMetastoreURI; + + /** Target metastore URI */ + public static final String TARGET_METASTORE_URI_KEY = + IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.metastore.uri"; + /** Target database name */ + public static final String TARGET_DATABASE_KEY = IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.database"; + + public IcebergDataset(String db, String table, IcebergTable icebergTbl, Properties properties, FileSystem fs) { + this.dbName = db; + this.inputTableName = table; + this.icebergTable = icebergTbl; + this.properties = properties; + this.fs = fs; + this.sourceMetastoreURI = + Optional.fromNullable(this.properties.getProperty(IcebergDatasetFinder.ICEBERG_HIVE_CATALOG_METASTORE_URI_KEY)); + this.targetMetastoreURI = + Optional.fromNullable(this.properties.getProperty(TARGET_METASTORE_URI_KEY)); + } + + public IcebergDataset(String db, String table) { + this.dbName = db; + this.inputTableName = table; + } + + /** + * Represents a source {@link FileStatus} and a {@link Path} destination. + */ + @Data + private static class SourceAndDestination { + private final FileStatus source; + private final Path destination; + } + + @Override + public String datasetURN() { + // TODO: verify! + return this.dbName + "." + this.inputTableName; + } + + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration) { + return getCopyEntities(configuration); + } + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration, + Comparator<FileSet<CopyEntity>> prioritizer, PushDownRequestor<FileSet<CopyEntity>> requestor) { + // TODO: Implement PushDownRequestor and priority based copy entity iteration + return getCopyEntities(configuration); + } + + /** + * Finds all files read by the table and generates {@link CopyEntity}s for duplicating the table. + */ + Iterator<FileSet<CopyEntity>> getCopyEntities(CopyConfiguration configuration) { + FileSet<CopyEntity> fileSet = new IcebergTableFileSet(this.getInputTableName(), this, configuration); + return Iterators.singletonIterator(fileSet); } + + /** + * Finds all files read by the table file set and generates {@link CopyEntity}s for duplicating the table. + */ + @VisibleForTesting + Collection<CopyEntity> generateCopyEntities(CopyConfiguration configuration) throws IOException { + String fileSet = this.getInputTableName(); + List<CopyEntity> copyEntities = Lists.newArrayList(); + log.info("Fetching all the files to be copied"); + Map<Path, FileStatus> mapOfPathsToCopy = getFilePaths(); + + log.info("Fetching copyable file builders from their respective file sets and adding to collection of copy entities"); + for (CopyableFile.Builder builder : getCopyableFilesFromPaths(mapOfPathsToCopy, configuration)) { + CopyableFile fileEntity = + builder.fileSet(fileSet).datasetOutputPath(this.fs.getUri().getPath()).build(); + fileEntity.setSourceData(getSourceDataset()); + fileEntity.setDestinationData(getDestinationDataset()); + copyEntities.add(fileEntity); + } + return copyEntities; + } + + /** + * Get builders for a {@link CopyableFile} for each file referred to by a {@link org.apache.hadoop.hive.metastore.api.StorageDescriptor}. + */ + protected List<CopyableFile.Builder> getCopyableFilesFromPaths(Map<Path, FileStatus> paths, CopyConfiguration configuration) throws IOException { + + List<CopyableFile.Builder> builders = Lists.newArrayList(); + List<SourceAndDestination> dataFiles = Lists.newArrayList(); + Configuration hadoopConfiguration = new Configuration(); Review Comment: We could name this as defaultHadoopConfiguration just so that the expectation when reading this var is that this is the default configuration on the environment the job is running in, with no modifications from user parameters. ########## gobblin-data-management/src/main/java/org/apache/gobblin/data/management/copy/iceberg/IcebergDataset.java: ########## @@ -0,0 +1,215 @@ +/* + * 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.gobblin.data.management.copy.iceberg; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Optional; +import com.google.common.collect.Iterators; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import java.io.IOException; +import java.net.URI; +import java.util.Collection; +import java.util.Comparator; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import lombok.Data; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; +import org.apache.gobblin.data.management.copy.CopyConfiguration; +import org.apache.gobblin.data.management.copy.CopyEntity; +import org.apache.gobblin.data.management.copy.CopyableDataset; +import org.apache.gobblin.data.management.copy.CopyableFile; +import org.apache.gobblin.data.management.copy.prioritization.PrioritizedCopyableDataset; +import org.apache.gobblin.data.management.partition.FileSet; +import org.apache.gobblin.dataset.DatasetConstants; +import org.apache.gobblin.dataset.DatasetDescriptor; +import org.apache.gobblin.util.request_allocation.PushDownRequestor; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileStatus; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.jetbrains.annotations.NotNull; + +/** + * Iceberg dataset implementing {@link CopyableDataset}. + */ +@Slf4j +@Getter +public class IcebergDataset implements PrioritizedCopyableDataset { + private final String dbName; + private final String inputTableName; + private IcebergTable icebergTable; + protected Properties properties; + protected FileSystem fs; + + private Optional<String> sourceMetastoreURI; + private Optional<String> targetMetastoreURI; + + /** Target metastore URI */ + public static final String TARGET_METASTORE_URI_KEY = + IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.metastore.uri"; + /** Target database name */ + public static final String TARGET_DATABASE_KEY = IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.database"; + + public IcebergDataset(String db, String table, IcebergTable icebergTbl, Properties properties, FileSystem fs) { + this.dbName = db; + this.inputTableName = table; + this.icebergTable = icebergTbl; + this.properties = properties; + this.fs = fs; + this.sourceMetastoreURI = + Optional.fromNullable(this.properties.getProperty(IcebergDatasetFinder.ICEBERG_HIVE_CATALOG_METASTORE_URI_KEY)); + this.targetMetastoreURI = + Optional.fromNullable(this.properties.getProperty(TARGET_METASTORE_URI_KEY)); + } + + public IcebergDataset(String db, String table) { + this.dbName = db; + this.inputTableName = table; + } + + /** + * Represents a source {@link FileStatus} and a {@link Path} destination. + */ + @Data + private static class SourceAndDestination { + private final FileStatus source; + private final Path destination; + } + + @Override + public String datasetURN() { + // TODO: verify! + return this.dbName + "." + this.inputTableName; + } + + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration) { + return getCopyEntities(configuration); + } + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration, + Comparator<FileSet<CopyEntity>> prioritizer, PushDownRequestor<FileSet<CopyEntity>> requestor) { + // TODO: Implement PushDownRequestor and priority based copy entity iteration + return getCopyEntities(configuration); + } + + /** + * Finds all files read by the table and generates {@link CopyEntity}s for duplicating the table. + */ + Iterator<FileSet<CopyEntity>> getCopyEntities(CopyConfiguration configuration) { + FileSet<CopyEntity> fileSet = new IcebergTableFileSet(this.getInputTableName(), this, configuration); + return Iterators.singletonIterator(fileSet); } + + /** + * Finds all files read by the table file set and generates {@link CopyEntity}s for duplicating the table. + */ + @VisibleForTesting + Collection<CopyEntity> generateCopyEntities(CopyConfiguration configuration) throws IOException { + String fileSet = this.getInputTableName(); + List<CopyEntity> copyEntities = Lists.newArrayList(); + log.info("Fetching all the files to be copied"); + Map<Path, FileStatus> mapOfPathsToCopy = getFilePaths(); + + log.info("Fetching copyable file builders from their respective file sets and adding to collection of copy entities"); + for (CopyableFile.Builder builder : getCopyableFilesFromPaths(mapOfPathsToCopy, configuration)) { + CopyableFile fileEntity = + builder.fileSet(fileSet).datasetOutputPath(this.fs.getUri().getPath()).build(); + fileEntity.setSourceData(getSourceDataset()); + fileEntity.setDestinationData(getDestinationDataset()); + copyEntities.add(fileEntity); + } + return copyEntities; + } + + /** + * Get builders for a {@link CopyableFile} for each file referred to by a {@link org.apache.hadoop.hive.metastore.api.StorageDescriptor}. + */ + protected List<CopyableFile.Builder> getCopyableFilesFromPaths(Map<Path, FileStatus> paths, CopyConfiguration configuration) throws IOException { + + List<CopyableFile.Builder> builders = Lists.newArrayList(); + List<SourceAndDestination> dataFiles = Lists.newArrayList(); + Configuration hadoopConfiguration = new Configuration(); + FileSystem actualSourceFs; + + for(Map.Entry<Path, FileStatus> entry : paths.entrySet()) { + dataFiles.add(new SourceAndDestination(entry.getValue(), this.fs.makeQualified(entry.getKey()))); + } + + for(SourceAndDestination sourceAndDestination : dataFiles) { + actualSourceFs = sourceAndDestination.getSource().getPath().getFileSystem(hadoopConfiguration); + + // TODO Add ancestor owner and permissions in future releases + builders.add(CopyableFile.fromOriginAndDestination(actualSourceFs, sourceAndDestination.getSource(), + sourceAndDestination.getDestination(), configuration)); + } + return builders; + } + /** + * Finds all files read by the Iceberg table including metadata json file, manifest files, nested manifest file paths and actual data files. + * Returns a map of path, file status for each file that needs to be copied + */ + protected Map<Path, FileStatus> getFilePaths() throws IOException { + Map<Path, FileStatus> result = Maps.newHashMap(); + IcebergTable icebergTable = this.getIcebergTable(); + IcebergSnapshotInfo icebergSnapshotInfo = icebergTable.getCurrentSnapshotInfo(); + + log.info("Fetching all file paths for the current snapshot of the Iceberg table"); + List<String> pathsToCopy = icebergSnapshotInfo.getAllPaths(); + + for(String pathString : pathsToCopy) { + Path path = new Path(pathString); + result.put(path, this.fs.getFileStatus(path)); Review Comment: is there ever a possibility that we run into a FNFE here? I'm thinking if a file gets deleted during the copy by another job, is that possible? ########## gobblin-data-management/src/main/java/org/apache/gobblin/data/management/copy/iceberg/IcebergDataset.java: ########## @@ -0,0 +1,215 @@ +/* + * 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.gobblin.data.management.copy.iceberg; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Optional; +import com.google.common.collect.Iterators; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import java.io.IOException; +import java.net.URI; +import java.util.Collection; +import java.util.Comparator; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import lombok.Data; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; +import org.apache.gobblin.data.management.copy.CopyConfiguration; +import org.apache.gobblin.data.management.copy.CopyEntity; +import org.apache.gobblin.data.management.copy.CopyableDataset; +import org.apache.gobblin.data.management.copy.CopyableFile; +import org.apache.gobblin.data.management.copy.prioritization.PrioritizedCopyableDataset; +import org.apache.gobblin.data.management.partition.FileSet; +import org.apache.gobblin.dataset.DatasetConstants; +import org.apache.gobblin.dataset.DatasetDescriptor; +import org.apache.gobblin.util.request_allocation.PushDownRequestor; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileStatus; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.jetbrains.annotations.NotNull; + +/** + * Iceberg dataset implementing {@link CopyableDataset}. + */ +@Slf4j +@Getter +public class IcebergDataset implements PrioritizedCopyableDataset { + private final String dbName; + private final String inputTableName; + private IcebergTable icebergTable; + protected Properties properties; + protected FileSystem fs; + + private Optional<String> sourceMetastoreURI; + private Optional<String> targetMetastoreURI; + + /** Target metastore URI */ + public static final String TARGET_METASTORE_URI_KEY = + IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.metastore.uri"; + /** Target database name */ + public static final String TARGET_DATABASE_KEY = IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.database"; + + public IcebergDataset(String db, String table, IcebergTable icebergTbl, Properties properties, FileSystem fs) { + this.dbName = db; + this.inputTableName = table; + this.icebergTable = icebergTbl; + this.properties = properties; + this.fs = fs; + this.sourceMetastoreURI = + Optional.fromNullable(this.properties.getProperty(IcebergDatasetFinder.ICEBERG_HIVE_CATALOG_METASTORE_URI_KEY)); + this.targetMetastoreURI = + Optional.fromNullable(this.properties.getProperty(TARGET_METASTORE_URI_KEY)); + } + + public IcebergDataset(String db, String table) { + this.dbName = db; + this.inputTableName = table; + } + + /** + * Represents a source {@link FileStatus} and a {@link Path} destination. + */ + @Data + private static class SourceAndDestination { + private final FileStatus source; + private final Path destination; + } + + @Override + public String datasetURN() { + // TODO: verify! + return this.dbName + "." + this.inputTableName; + } + + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration) { + return getCopyEntities(configuration); + } + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration, + Comparator<FileSet<CopyEntity>> prioritizer, PushDownRequestor<FileSet<CopyEntity>> requestor) { + // TODO: Implement PushDownRequestor and priority based copy entity iteration + return getCopyEntities(configuration); + } + + /** + * Finds all files read by the table and generates {@link CopyEntity}s for duplicating the table. + */ + Iterator<FileSet<CopyEntity>> getCopyEntities(CopyConfiguration configuration) { + FileSet<CopyEntity> fileSet = new IcebergTableFileSet(this.getInputTableName(), this, configuration); + return Iterators.singletonIterator(fileSet); } + + /** + * Finds all files read by the table file set and generates {@link CopyEntity}s for duplicating the table. + */ + @VisibleForTesting + Collection<CopyEntity> generateCopyEntities(CopyConfiguration configuration) throws IOException { + String fileSet = this.getInputTableName(); + List<CopyEntity> copyEntities = Lists.newArrayList(); + log.info("Fetching all the files to be copied"); Review Comment: This log seems somewhat redundant ########## gobblin-data-management/src/main/java/org/apache/gobblin/data/management/copy/iceberg/IcebergDataset.java: ########## @@ -0,0 +1,215 @@ +/* + * 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.gobblin.data.management.copy.iceberg; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Optional; +import com.google.common.collect.Iterators; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import java.io.IOException; +import java.net.URI; +import java.util.Collection; +import java.util.Comparator; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import lombok.Data; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; +import org.apache.gobblin.data.management.copy.CopyConfiguration; +import org.apache.gobblin.data.management.copy.CopyEntity; +import org.apache.gobblin.data.management.copy.CopyableDataset; +import org.apache.gobblin.data.management.copy.CopyableFile; +import org.apache.gobblin.data.management.copy.prioritization.PrioritizedCopyableDataset; +import org.apache.gobblin.data.management.partition.FileSet; +import org.apache.gobblin.dataset.DatasetConstants; +import org.apache.gobblin.dataset.DatasetDescriptor; +import org.apache.gobblin.util.request_allocation.PushDownRequestor; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileStatus; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.jetbrains.annotations.NotNull; + +/** + * Iceberg dataset implementing {@link CopyableDataset}. + */ +@Slf4j +@Getter +public class IcebergDataset implements PrioritizedCopyableDataset { + private final String dbName; + private final String inputTableName; + private IcebergTable icebergTable; + protected Properties properties; + protected FileSystem fs; + + private Optional<String> sourceMetastoreURI; + private Optional<String> targetMetastoreURI; + + /** Target metastore URI */ + public static final String TARGET_METASTORE_URI_KEY = + IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.metastore.uri"; + /** Target database name */ + public static final String TARGET_DATABASE_KEY = IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.database"; + + public IcebergDataset(String db, String table, IcebergTable icebergTbl, Properties properties, FileSystem fs) { + this.dbName = db; + this.inputTableName = table; + this.icebergTable = icebergTbl; + this.properties = properties; + this.fs = fs; + this.sourceMetastoreURI = + Optional.fromNullable(this.properties.getProperty(IcebergDatasetFinder.ICEBERG_HIVE_CATALOG_METASTORE_URI_KEY)); + this.targetMetastoreURI = + Optional.fromNullable(this.properties.getProperty(TARGET_METASTORE_URI_KEY)); + } + + public IcebergDataset(String db, String table) { + this.dbName = db; + this.inputTableName = table; + } + + /** + * Represents a source {@link FileStatus} and a {@link Path} destination. + */ + @Data + private static class SourceAndDestination { + private final FileStatus source; + private final Path destination; + } + + @Override + public String datasetURN() { + // TODO: verify! + return this.dbName + "." + this.inputTableName; + } + + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration) { + return getCopyEntities(configuration); + } + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration, + Comparator<FileSet<CopyEntity>> prioritizer, PushDownRequestor<FileSet<CopyEntity>> requestor) { + // TODO: Implement PushDownRequestor and priority based copy entity iteration + return getCopyEntities(configuration); + } + + /** + * Finds all files read by the table and generates {@link CopyEntity}s for duplicating the table. + */ + Iterator<FileSet<CopyEntity>> getCopyEntities(CopyConfiguration configuration) { + FileSet<CopyEntity> fileSet = new IcebergTableFileSet(this.getInputTableName(), this, configuration); + return Iterators.singletonIterator(fileSet); } + + /** + * Finds all files read by the table file set and generates {@link CopyEntity}s for duplicating the table. + */ + @VisibleForTesting + Collection<CopyEntity> generateCopyEntities(CopyConfiguration configuration) throws IOException { + String fileSet = this.getInputTableName(); + List<CopyEntity> copyEntities = Lists.newArrayList(); + log.info("Fetching all the files to be copied"); + Map<Path, FileStatus> mapOfPathsToCopy = getFilePaths(); + + log.info("Fetching copyable file builders from their respective file sets and adding to collection of copy entities"); + for (CopyableFile.Builder builder : getCopyableFilesFromPaths(mapOfPathsToCopy, configuration)) { + CopyableFile fileEntity = + builder.fileSet(fileSet).datasetOutputPath(this.fs.getUri().getPath()).build(); + fileEntity.setSourceData(getSourceDataset()); + fileEntity.setDestinationData(getDestinationDataset()); + copyEntities.add(fileEntity); + } + return copyEntities; + } + + /** + * Get builders for a {@link CopyableFile} for each file referred to by a {@link org.apache.hadoop.hive.metastore.api.StorageDescriptor}. + */ + protected List<CopyableFile.Builder> getCopyableFilesFromPaths(Map<Path, FileStatus> paths, CopyConfiguration configuration) throws IOException { + + List<CopyableFile.Builder> builders = Lists.newArrayList(); + List<SourceAndDestination> dataFiles = Lists.newArrayList(); + Configuration hadoopConfiguration = new Configuration(); + FileSystem actualSourceFs; + + for(Map.Entry<Path, FileStatus> entry : paths.entrySet()) { + dataFiles.add(new SourceAndDestination(entry.getValue(), this.fs.makeQualified(entry.getKey()))); + } + + for(SourceAndDestination sourceAndDestination : dataFiles) { + actualSourceFs = sourceAndDestination.getSource().getPath().getFileSystem(hadoopConfiguration); + + // TODO Add ancestor owner and permissions in future releases + builders.add(CopyableFile.fromOriginAndDestination(actualSourceFs, sourceAndDestination.getSource(), + sourceAndDestination.getDestination(), configuration)); + } + return builders; + } + /** + * Finds all files read by the Iceberg table including metadata json file, manifest files, nested manifest file paths and actual data files. + * Returns a map of path, file status for each file that needs to be copied + */ + protected Map<Path, FileStatus> getFilePaths() throws IOException { + Map<Path, FileStatus> result = Maps.newHashMap(); + IcebergTable icebergTable = this.getIcebergTable(); + IcebergSnapshotInfo icebergSnapshotInfo = icebergTable.getCurrentSnapshotInfo(); + + log.info("Fetching all file paths for the current snapshot of the Iceberg table"); Review Comment: This log can contain more context. i.e., can we include the table uri? ########## gobblin-data-management/src/main/java/org/apache/gobblin/data/management/copy/iceberg/IcebergDataset.java: ########## @@ -0,0 +1,215 @@ +/* + * 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.gobblin.data.management.copy.iceberg; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Optional; +import com.google.common.collect.Iterators; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; +import java.io.IOException; +import java.net.URI; +import java.util.Collection; +import java.util.Comparator; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import lombok.Data; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; +import org.apache.gobblin.data.management.copy.CopyConfiguration; +import org.apache.gobblin.data.management.copy.CopyEntity; +import org.apache.gobblin.data.management.copy.CopyableDataset; +import org.apache.gobblin.data.management.copy.CopyableFile; +import org.apache.gobblin.data.management.copy.prioritization.PrioritizedCopyableDataset; +import org.apache.gobblin.data.management.partition.FileSet; +import org.apache.gobblin.dataset.DatasetConstants; +import org.apache.gobblin.dataset.DatasetDescriptor; +import org.apache.gobblin.util.request_allocation.PushDownRequestor; +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.FileStatus; +import org.apache.hadoop.fs.FileSystem; +import org.apache.hadoop.fs.Path; +import org.jetbrains.annotations.NotNull; + +/** + * Iceberg dataset implementing {@link CopyableDataset}. + */ +@Slf4j +@Getter +public class IcebergDataset implements PrioritizedCopyableDataset { + private final String dbName; + private final String inputTableName; + private IcebergTable icebergTable; + protected Properties properties; + protected FileSystem fs; + + private Optional<String> sourceMetastoreURI; + private Optional<String> targetMetastoreURI; + + /** Target metastore URI */ + public static final String TARGET_METASTORE_URI_KEY = + IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.metastore.uri"; + /** Target database name */ + public static final String TARGET_DATABASE_KEY = IcebergDatasetFinder.ICEBERG_DATASET_PREFIX + ".copy.target.database"; + + public IcebergDataset(String db, String table, IcebergTable icebergTbl, Properties properties, FileSystem fs) { + this.dbName = db; + this.inputTableName = table; + this.icebergTable = icebergTbl; + this.properties = properties; + this.fs = fs; + this.sourceMetastoreURI = + Optional.fromNullable(this.properties.getProperty(IcebergDatasetFinder.ICEBERG_HIVE_CATALOG_METASTORE_URI_KEY)); + this.targetMetastoreURI = + Optional.fromNullable(this.properties.getProperty(TARGET_METASTORE_URI_KEY)); + } + + public IcebergDataset(String db, String table) { + this.dbName = db; + this.inputTableName = table; + } + + /** + * Represents a source {@link FileStatus} and a {@link Path} destination. + */ + @Data + private static class SourceAndDestination { + private final FileStatus source; + private final Path destination; + } + + @Override + public String datasetURN() { + // TODO: verify! + return this.dbName + "." + this.inputTableName; + } + + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration) { + return getCopyEntities(configuration); + } + /** + * Finds all files read by the table and generates CopyableFiles. + * For the specific semantics see {@link #getCopyEntities}. + */ + @Override + public Iterator<FileSet<CopyEntity>> getFileSetIterator(FileSystem targetFs, CopyConfiguration configuration, + Comparator<FileSet<CopyEntity>> prioritizer, PushDownRequestor<FileSet<CopyEntity>> requestor) { + // TODO: Implement PushDownRequestor and priority based copy entity iteration + return getCopyEntities(configuration); + } + + /** + * Finds all files read by the table and generates {@link CopyEntity}s for duplicating the table. + */ + Iterator<FileSet<CopyEntity>> getCopyEntities(CopyConfiguration configuration) { + FileSet<CopyEntity> fileSet = new IcebergTableFileSet(this.getInputTableName(), this, configuration); + return Iterators.singletonIterator(fileSet); } + + /** + * Finds all files read by the table file set and generates {@link CopyEntity}s for duplicating the table. + */ + @VisibleForTesting + Collection<CopyEntity> generateCopyEntities(CopyConfiguration configuration) throws IOException { + String fileSet = this.getInputTableName(); + List<CopyEntity> copyEntities = Lists.newArrayList(); + log.info("Fetching all the files to be copied"); + Map<Path, FileStatus> mapOfPathsToCopy = getFilePaths(); + + log.info("Fetching copyable file builders from their respective file sets and adding to collection of copy entities"); Review Comment: I think we can also add more context for this line. I think it's a good practice to imagine that we're trying to debug pipelines so we want to know what tables/files that we're potentially copying and where the error starts, instead of focusing too hard on checkpointing the steps. -- 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: dev-unsubscr...@gobblin.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
