rdblue commented on code in PR #11039: URL: https://github.com/apache/iceberg/pull/11039#discussion_r1943609820
########## bigquery/src/main/java/org/apache/iceberg/gcp/bigquery/metastore/BigQueryMetastoreCatalog.java: ########## @@ -0,0 +1,328 @@ +/* + * 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.gcp.bigquery.metastore; + +import com.google.api.services.bigquery.model.Dataset; +import com.google.api.services.bigquery.model.DatasetList.Datasets; +import com.google.api.services.bigquery.model.DatasetReference; +import com.google.api.services.bigquery.model.ExternalCatalogDatasetOptions; +import com.google.api.services.bigquery.model.TableReference; +import java.io.IOException; +import java.security.GeneralSecurityException; +import java.util.List; +import java.util.Map; +import java.util.Set; +import org.apache.iceberg.BaseMetastoreCatalog; +import org.apache.iceberg.CatalogProperties; +import org.apache.iceberg.CatalogUtil; +import org.apache.iceberg.TableMetadata; +import org.apache.iceberg.TableOperations; +import org.apache.iceberg.catalog.Namespace; +import org.apache.iceberg.catalog.SupportsNamespaces; +import org.apache.iceberg.catalog.TableIdentifier; +import org.apache.iceberg.exceptions.NoSuchTableException; +import org.apache.iceberg.exceptions.ServiceFailureException; +import org.apache.iceberg.exceptions.ValidationException; +import org.apache.iceberg.gcp.GCPProperties; +import org.apache.iceberg.gcp.bigquery.BigQueryClient; +import org.apache.iceberg.gcp.bigquery.BigQueryClientImpl; +import org.apache.iceberg.hadoop.Configurable; +import org.apache.iceberg.io.FileIO; +import org.apache.iceberg.relocated.com.google.common.annotations.VisibleForTesting; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.base.Strings; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.util.LocationUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** Iceberg Bigquery Metastore (BQMS) Catalog implementation. */ +public final class BigQueryMetastoreCatalog extends BaseMetastoreCatalog + implements SupportsNamespaces, Configurable<Object> { + + /** + * A user-provided property to filter tables that are inoperable by the BigQuery Metastore - + * Iceberg integration. + */ + public static final String PROPERTIES_KEY_FILTER_UNSUPPORTED_TABLES = "filter_unsupported_tables"; + + private static final Logger LOG = LoggerFactory.getLogger(BigQueryMetastoreCatalog.class); + + private static final String DEFAULT_GCP_LOCATION = "us"; + + private String catalogPluginName; + private Map<String, String> catalogProperties; + private FileIO fileIO; + private Object conf; + private String projectId; + private String location; + private String defaultWarehouseLocation; + private BigQueryClient client; + private boolean filterUnsupportedTables; + + // Must have a no-arg constructor to be dynamically loaded + // initialize(String name, Map<String, String> properties) will be called to complete + // initialization + public BigQueryMetastoreCatalog() {} + + @Override + public void initialize(String inputName, Map<String, String> properties) { + if (!properties.containsKey(GCPProperties.PROJECT_ID)) { + throw new ValidationException("GCP project must be specified"); + } + + this.projectId = properties.get(GCPProperties.PROJECT_ID); + this.location = properties.getOrDefault(GCPProperties.BIGQUERY_LOCATION, DEFAULT_GCP_LOCATION); + BigQueryClient bigQueryClient; + try { + bigQueryClient = new BigQueryClientImpl(); + } catch (IOException e) { + throw new ServiceFailureException(e, "Creating BigQuery client failed"); + } catch (GeneralSecurityException e) { + throw new ValidationException(e, "Creating BigQuery client failed due to a security issue"); + } + + initialize(inputName, properties, projectId, location, bigQueryClient); + } + + @VisibleForTesting + void initialize( + String inputName, + Map<String, String> properties, + String gcpProjectId, + String gcpLocation, + BigQueryClient bigQueryClient) { + this.catalogPluginName = inputName; + this.catalogProperties = ImmutableMap.copyOf(properties); + this.projectId = gcpProjectId; + this.location = gcpLocation; + this.client = + Preconditions.checkNotNull(bigQueryClient, "Failed to initialize BigQuery Client"); + + LOG.info("Using BigQuery Metastore Iceberg Catalog: {}", inputName); + + if (properties.containsKey(CatalogProperties.WAREHOUSE_LOCATION)) { + // Iceberg always removes trailing slash to avoid paths like "<folder>//data" in file systems + // like s3. + this.defaultWarehouseLocation = + LocationUtil.stripTrailingSlash(properties.get(CatalogProperties.WAREHOUSE_LOCATION)); + } + + String fileIoImpl = + properties.getOrDefault( + CatalogProperties.FILE_IO_IMPL, "org.apache.iceberg.hadoop.HadoopFileIO"); + this.fileIO = CatalogUtil.loadFileIO(fileIoImpl, properties, conf); + + this.filterUnsupportedTables = + Boolean.parseBoolean( + properties.getOrDefault(PROPERTIES_KEY_FILTER_UNSUPPORTED_TABLES, "false")); + } + + @Override + protected TableOperations newTableOps(TableIdentifier identifier) { + return new BigQueryTableOperations( + client, + fileIO, + projectId, + // Sometimes extensions have the namespace contain the table name too, so we are forced to + // allow invalid namespace and just take the first part here like other catalog + // implementations do. + identifier.namespace().level(0), + identifier.name()); + } + + @Override + protected String defaultWarehouseLocation(TableIdentifier identifier) { + String locationUri = null; + DatasetReference datasetReference = toDatasetReference(identifier.namespace()); + Dataset dataset = client.getDataset(datasetReference); + if (dataset != null && dataset.getExternalCatalogDatasetOptions() != null) { + locationUri = dataset.getExternalCatalogDatasetOptions().getDefaultStorageLocationUri(); + } + + return String.format( + "%s/%s", + Strings.isNullOrEmpty(locationUri) + ? getDefaultStorageLocationUri(datasetReference.getDatasetId()) + : locationUri, + identifier.name()); + } + + @Override + public List<TableIdentifier> listTables(Namespace namespace) { + validateNamespace(namespace); + + return client.listTables(toDatasetReference(namespace), filterUnsupportedTables).stream() + .map( + table -> TableIdentifier.of(namespace.level(0), table.getTableReference().getTableId())) + .collect(ImmutableList.toImmutableList()); + } + + @Override + public boolean dropTable(TableIdentifier identifier, boolean purge) { + try { + TableOperations ops = newTableOps(identifier); + TableMetadata lastMetadata = ops.current(); + + client.deleteTable(toBqTableReference(identifier)); + + if (purge && lastMetadata != null) { + CatalogUtil.dropTableData(ops.io(), lastMetadata); + } + + } catch (NoSuchTableException e) { // Not catching a NoSuchIcebergTableException on purpose + return false; // The documentation says just return false in this case + } + + return true; + } + + @Override + public void renameTable(TableIdentifier from, TableIdentifier to) { + if (!from.namespace().equals(to.namespace())) { + throw new ValidationException("New table name must be in the same namespace"); + } + + // TODO(b/354981675): Enable once supported by the API. + throw new ServiceFailureException( + "Table rename operation is unsupported. Try the SQL operation directly on BigQuery: \"ALTER TABLE %s RENAME TO %s;\"", + from.name(), to.name()); + } + + @Override + public void createNamespace(Namespace namespace, Map<String, String> metadata) { + Dataset builder = new Dataset(); + DatasetReference datasetReference = toDatasetReference(namespace); + builder.setLocation(this.location); + builder.setDatasetReference(datasetReference); + builder.setExternalCatalogDatasetOptions( + BigQueryMetastoreUtils.createExternalCatalogDatasetOptions( + getDefaultStorageLocationUri(datasetReference.getDatasetId()), metadata)); + + client.createDataset(builder); + } + + /** + * Since this catalog only supports one-level namespaces, it always returns an empty list unless + * passed an empty namespace to list all namespaces within the catalog. + */ + @Override + public List<Namespace> listNamespaces(Namespace namespace) { + if (namespace.levels().length != 0) { + // BQMS does not support namespaces under database or tables, returns empty. + // It is called when dropping a namespace to make sure it's empty (listTables is called as + // well), returns empty to unblock deletion. + return ImmutableList.of(); + } + + return client.listDatasets(projectId).stream() + .map(BigQueryMetastoreCatalog::getNamespace) + .collect(ImmutableList.toImmutableList()); + } + + @Override + public boolean dropNamespace(Namespace namespace) { + client.deleteDataset(toDatasetReference(namespace)); + /* We don't delete the data folder for safety, which aligns with Hive Metastore's default + * behavior. + * We can support database or catalog level config controlling file deletion in the future. + */ + return true; + } + + @Override + public boolean setProperties(Namespace namespace, Map<String, String> properties) { + client.setDatasetParameters(toDatasetReference(namespace), properties); + return true; + } + + @Override + public boolean removeProperties(Namespace namespace, Set<String> properties) { + client.removeDatasetParameters(toDatasetReference(namespace), properties); + return true; + } + + @Override + public Map<String, String> loadNamespaceMetadata(Namespace namespace) { + return getMetadata(client.getDataset(toDatasetReference(namespace))); + } + + @Override + public String name() { + return catalogPluginName; + } + + @Override + protected Map<String, String> properties() { + return catalogProperties == null ? ImmutableMap.of() : catalogProperties; + } + + @Override + public void setConf(Object conf) { + this.conf = conf; + } + + private String getDefaultStorageLocationUri(String dbId) { Review Comment: Iceberg does not use `get` in method names. It is almost always better to replace it with a more specific verb (like fetch, load, generate, etc.) or omit it because it doesn't provide value. Also, this isn't a URI? -- 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: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
