danielcweeks commented on a change in pull request #2688: URL: https://github.com/apache/iceberg/pull/2688#discussion_r654834181
########## File path: aws/src/main/java/org/apache/iceberg/aws/dynamodb/DynamoDbCatalog.java ########## @@ -0,0 +1,613 @@ +/* + * 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.aws.dynamodb; + +import java.io.Closeable; +import java.io.IOException; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.UUID; +import java.util.stream.Collectors; +import org.apache.hadoop.conf.Configurable; +import org.apache.hadoop.conf.Configuration; +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.aws.AwsClientFactories; +import org.apache.iceberg.aws.AwsProperties; +import org.apache.iceberg.aws.s3.S3FileIO; +import org.apache.iceberg.catalog.Namespace; +import org.apache.iceberg.catalog.SupportsNamespaces; +import org.apache.iceberg.catalog.TableIdentifier; +import org.apache.iceberg.exceptions.AlreadyExistsException; +import org.apache.iceberg.exceptions.NamespaceNotEmptyException; +import org.apache.iceberg.exceptions.NoSuchNamespaceException; +import org.apache.iceberg.exceptions.NoSuchTableException; +import org.apache.iceberg.exceptions.ValidationException; +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.Joiner; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.util.Tasks; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import software.amazon.awssdk.services.dynamodb.DynamoDbClient; +import software.amazon.awssdk.services.dynamodb.model.AttributeDefinition; +import software.amazon.awssdk.services.dynamodb.model.AttributeValue; +import software.amazon.awssdk.services.dynamodb.model.BillingMode; +import software.amazon.awssdk.services.dynamodb.model.ConditionalCheckFailedException; +import software.amazon.awssdk.services.dynamodb.model.CreateTableRequest; +import software.amazon.awssdk.services.dynamodb.model.Delete; +import software.amazon.awssdk.services.dynamodb.model.DeleteItemRequest; +import software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest; +import software.amazon.awssdk.services.dynamodb.model.DescribeTableResponse; +import software.amazon.awssdk.services.dynamodb.model.GetItemRequest; +import software.amazon.awssdk.services.dynamodb.model.GetItemResponse; +import software.amazon.awssdk.services.dynamodb.model.GlobalSecondaryIndex; +import software.amazon.awssdk.services.dynamodb.model.KeySchemaElement; +import software.amazon.awssdk.services.dynamodb.model.KeyType; +import software.amazon.awssdk.services.dynamodb.model.Projection; +import software.amazon.awssdk.services.dynamodb.model.ProjectionType; +import software.amazon.awssdk.services.dynamodb.model.Put; +import software.amazon.awssdk.services.dynamodb.model.PutItemRequest; +import software.amazon.awssdk.services.dynamodb.model.QueryRequest; +import software.amazon.awssdk.services.dynamodb.model.QueryResponse; +import software.amazon.awssdk.services.dynamodb.model.ResourceNotFoundException; +import software.amazon.awssdk.services.dynamodb.model.ScalarAttributeType; +import software.amazon.awssdk.services.dynamodb.model.TableStatus; +import software.amazon.awssdk.services.dynamodb.model.TransactWriteItem; +import software.amazon.awssdk.services.dynamodb.model.TransactWriteItemsRequest; +import software.amazon.awssdk.services.dynamodb.model.UpdateItemRequest; + +/** + * DynamoDB implementation of Iceberg catalog + */ +public class DynamoDbCatalog extends BaseMetastoreCatalog implements Closeable, SupportsNamespaces, Configurable { + + private static final Logger LOG = LoggerFactory.getLogger(DynamoDbCatalog.class); + private static final int CATALOG_TABLE_CREATION_WAIT_ATTEMPTS_MAX = 5; + static final Joiner COMMA = Joiner.on(','); + + private static final String GSI_NAMESPACE_IDENTIFIER = "namespace-identifier"; + private static final String COL_IDENTIFIER = "identifier"; + private static final String COL_IDENTIFIER_NAMESPACE = "NAMESPACE"; + private static final String COL_NAMESPACE = "namespace"; + private static final String PROPERTY_COL_PREFIX = "p."; + private static final String PROPERTY_DEFAULT_LOCATION = "default_location"; + private static final String COL_CREATED_AT = "created_at"; + private static final String COL_UPDATED_AT = "updated_at"; + + // field used for optimistic locking + static final String COL_VERSION = "v"; + + private DynamoDbClient dynamo; + private Configuration hadoopConf; + private String catalogName; + private String warehousePath; + private AwsProperties awsProperties; + private FileIO fileIO; + + public DynamoDbCatalog() { + } + + @Override + public void initialize(String name, Map<String, String> properties) { + initialize( + name, + properties.get(CatalogProperties.WAREHOUSE_LOCATION), + new AwsProperties(properties), + AwsClientFactories.from(properties).dynamo(), + initializeFileIO(properties)); + } + + @VisibleForTesting + void initialize(String name, String path, AwsProperties properties, DynamoDbClient client, FileIO io) { + this.catalogName = name; + this.awsProperties = properties; + this.warehousePath = cleanWarehousePath(path); + this.dynamo = client; + this.fileIO = io; + ensureCatalogTableExistsOrCreate(); + } + + @Override + public String name() { + return catalogName; + } + + @Override + protected TableOperations newTableOps(TableIdentifier tableIdentifier) { + validateTableIdentifier(tableIdentifier); + return new DynamoDbTableOperations(dynamo, awsProperties, catalogName, fileIO, tableIdentifier); + } + + @Override + protected String defaultWarehouseLocation(TableIdentifier tableIdentifier) { + validateTableIdentifier(tableIdentifier); + GetItemResponse response = dynamo.getItem(GetItemRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .consistentRead(true) + .key(namespacePrimaryKey(tableIdentifier.namespace())) + .build()); + + if (!response.hasItem()) { + throw new NoSuchNamespaceException("Cannot find default warehouse location: namespace %s does not exist", + tableIdentifier.namespace()); + } + + String defaultLocationCol = toPropertyCol(PROPERTY_DEFAULT_LOCATION); + if (response.item().containsKey(defaultLocationCol)) { + return String.format("%s/%s", response.item().get(defaultLocationCol), tableIdentifier.name()); + } else { + return String.format("%s/%s.db/%s", warehousePath, tableIdentifier.namespace(), tableIdentifier.name()); + } + } + + @Override + public void createNamespace(Namespace namespace, Map<String, String> metadata) { + validateNamespace(namespace); + Map<String, AttributeValue> values = namespacePrimaryKey(namespace); + setNewCatalogEntryMetadata(values); + metadata.forEach((key, value) -> values.put(toPropertyCol(key), AttributeValue.builder().s(value).build())); + + try { + dynamo.putItem(PutItemRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .conditionExpression("attribute_not_exists(" + DynamoDbCatalog.COL_VERSION + ")") + .item(values) + .build()); + } catch (ConditionalCheckFailedException e) { + throw new AlreadyExistsException("Cannot create namespace %s: already exists", namespace); + } + } + + @Override + public List<Namespace> listNamespaces(Namespace namespace) throws NoSuchNamespaceException { + validateNamespace(namespace); + List<Namespace> namespaces = Lists.newArrayList(); + Map<String, AttributeValue> lastEvaluatedKey = null; + String condition = COL_IDENTIFIER + " = :identifier"; + Map<String, AttributeValue> conditionValues = Maps.newHashMap(); + conditionValues.put(":identifier", AttributeValue.builder().s(COL_IDENTIFIER_NAMESPACE).build()); + if (!namespace.isEmpty()) { + condition += " AND " + "begins_with(" + COL_NAMESPACE + ",:ns)"; + conditionValues.put(":ns", AttributeValue.builder().s(namespace.toString()).build()); + } + + do { + QueryResponse response = dynamo.query(QueryRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .consistentRead(true) + .keyConditionExpression(condition) + .expressionAttributeValues(conditionValues) + .exclusiveStartKey(lastEvaluatedKey) + .build()); + + if (response.hasItems()) { + for (Map<String, AttributeValue> item : response.items()) { + String ns = item.get(COL_NAMESPACE).s(); + namespaces.add(Namespace.of(ns.split("\\."))); + } + } + + lastEvaluatedKey = response.lastEvaluatedKey(); + } while (!lastEvaluatedKey.isEmpty()); + + return namespaces; + } + + @Override + public Map<String, String> loadNamespaceMetadata(Namespace namespace) throws NoSuchNamespaceException { + validateNamespace(namespace); + GetItemResponse response = dynamo.getItem(GetItemRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .consistentRead(true) + .key(namespacePrimaryKey(namespace)) + .build()); + + if (!response.hasItem()) { + throw new NoSuchNamespaceException("Cannot find namespace %s", namespace); + } + + return response.item().entrySet().stream() + .filter(e -> isProperty(e.getKey())) + .collect(Collectors.toMap(e -> toPropertyKey(e.getKey()), e -> e.getValue().s())); + } + + @Override + public boolean dropNamespace(Namespace namespace) throws NamespaceNotEmptyException { + validateNamespace(namespace); + if (!listTables(namespace).isEmpty()) { + throw new NamespaceNotEmptyException("Cannot delete non-empty namespace %s", namespace); + } + + try { + dynamo.deleteItem(DeleteItemRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .key(namespacePrimaryKey(namespace)) + .conditionExpression("attribute_exists(" + namespace + ")") + .build()); + return true; + } catch (ConditionalCheckFailedException e) { + return false; + } + } + + @Override + public boolean setProperties(Namespace namespace, Map<String, String> properties) throws NoSuchNamespaceException { + List<String> updateParts = Lists.newArrayList(); + Map<String, String> attributeNames = Maps.newHashMap(); + Map<String, AttributeValue> attributeValues = Maps.newHashMap(); + int idx = 0; + for (Map.Entry<String, String> property : properties.entrySet()) { + String attributeValue = ":v" + idx; + String attributeKey = "#k" + idx; + idx++; + updateParts.add(attributeKey + " = " + attributeValue); + attributeNames.put(attributeKey, toPropertyCol(property.getKey())); + attributeValues.put(attributeValue, AttributeValue.builder().s(property.getValue()).build()); + } + + updateCatalogEntryMetadata(updateParts, attributeValues); + String updateExpression = "SET " + COMMA.join(updateParts); + return updateProperties(namespace, updateExpression, attributeValues, attributeNames); + } + + @Override + public boolean removeProperties(Namespace namespace, Set<String> properties) throws NoSuchNamespaceException { + List<String> removeParts = Lists.newArrayList(properties.iterator()); + Map<String, String> attributeNames = Maps.newHashMap(); + Map<String, AttributeValue> attributeValues = Maps.newHashMap(); + int idx = 0; + for (String property : properties) { + String attributeKey = "#k" + idx; + idx++; + removeParts.add(attributeKey); + attributeNames.put(attributeKey, toPropertyCol(property)); + } + + List<String> updateParts = Lists.newArrayList(); + updateCatalogEntryMetadata(updateParts, attributeValues); + String updateExpression = "REMOVE " + COMMA.join(removeParts) + " SET " + COMMA.join(updateParts); + return updateProperties(namespace, updateExpression, attributeValues, attributeNames); + } + + @Override + public List<TableIdentifier> listTables(Namespace namespace) { + List<TableIdentifier> identifiers = Lists.newArrayList(); + Map<String, AttributeValue> lastEvaluatedKey; + String condition = COL_NAMESPACE + " = :ns"; + Map<String, AttributeValue> conditionValues = ImmutableMap.of( + ":ns", AttributeValue.builder().s(namespace.toString()).build()); + do { + QueryResponse response = dynamo.query(QueryRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .indexName(GSI_NAMESPACE_IDENTIFIER) + .keyConditionExpression(condition) + .expressionAttributeValues(conditionValues) + .build()); + + if (response.hasItems()) { + for (Map<String, AttributeValue> item : response.items()) { + String identifier = item.get(COL_IDENTIFIER).s(); + if (!COL_IDENTIFIER_NAMESPACE.equals(identifier)) { + identifiers.add(TableIdentifier.of(identifier.split("\\."))); + } + } + } + + lastEvaluatedKey = response.lastEvaluatedKey(); + } while (!lastEvaluatedKey.isEmpty()); + return identifiers; + } + + @Override + public boolean dropTable(TableIdentifier identifier, boolean purge) { + Map<String, AttributeValue> key = tablePrimaryKey(identifier); + try { + GetItemResponse response = dynamo.getItem(GetItemRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .consistentRead(true) + .key(key) + .build()); + + if (!response.hasItem()) { + throw new NoSuchTableException("Cannot find table %s to drop", identifier); + } + + TableOperations ops = newTableOps(identifier); + TableMetadata lastMetadata = ops.current(); + dynamo.deleteItem(DeleteItemRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .key(tablePrimaryKey(identifier)) + .conditionExpression(COL_VERSION + " = :v") + .expressionAttributeValues(ImmutableMap.of(":v", response.item().get(COL_VERSION))) + .build()); + LOG.info("Successfully dropped table {} from DynamoDb catalog", identifier); + + if (purge && lastMetadata != null) { + CatalogUtil.dropTableData(ops.io(), lastMetadata); + LOG.info("Table {} data purged", identifier); + } + + LOG.info("Dropped table: {}", identifier); + return true; + } catch (ConditionalCheckFailedException e) { + LOG.error("Cannot complete drop table operation for {}: commit conflict", identifier, e); + return false; + } catch (Exception e) { + LOG.error("Cannot complete drop table operation for {}: unexpected exception", identifier, e); + throw e; + } + } + + @Override + public void renameTable(TableIdentifier from, TableIdentifier to) { + Map<String, AttributeValue> fromKey = tablePrimaryKey(from); + Map<String, AttributeValue> toKey = tablePrimaryKey(to); + + GetItemResponse fromResponse = dynamo.getItem(GetItemRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .consistentRead(true) + .key(fromKey) + .build()); + + if (!fromResponse.hasItem()) { + throw new NoSuchTableException("Cannot rename table %s to %s: %s does not exist", from, to, from); + } + + GetItemResponse toResponse = dynamo.getItem(GetItemRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .consistentRead(true) + .key(toKey) + .build()); + + if (toResponse.hasItem()) { + throw new AlreadyExistsException("Cannot rename table %s to %s: %s already exists", from, to, to); + } + + fromResponse.item().entrySet().stream() + .filter(e -> isProperty(e.getKey())) + .forEach(e -> toKey.put(e.getKey(), e.getValue())); + + setNewCatalogEntryMetadata(toKey); + + dynamo.transactWriteItems(TransactWriteItemsRequest.builder() + .transactItems( + TransactWriteItem.builder() + .delete(Delete.builder() + .tableName(awsProperties.dynamoDbTableName()) + .key(fromKey) + .conditionExpression(COL_VERSION + " = :v") + .expressionAttributeValues(ImmutableMap.of(":v", fromResponse.item().get(COL_VERSION))) + .build()) + .build(), + TransactWriteItem.builder() + .put(Put.builder() + .tableName(awsProperties.dynamoDbTableName()) + .item(toKey) + .conditionExpression("attribute_not_exists(" + COL_VERSION + ")") + .build()) + .build()) + .build()); + + LOG.info("Successfully renamed table from {} to {}", from, to); + } + + @Override + public void setConf(Configuration conf) { + hadoopConf = conf; + } + + @Override + public Configuration getConf() { + return hadoopConf; + } + + @Override + public void close() throws IOException { + dynamo.close(); + } + + /** + * The property used to set a default location for tables in a namespace. + * Call {@link #setProperties(Namespace, Map)} to set a path value using this property for a namespace, + * then all tables in the namespace will have default table root path under that given path. + * @return default location property key + */ + public static String defaultLocationProperty() { + return PROPERTY_DEFAULT_LOCATION; + } + + static String toPropertyCol(String propertyKey) { + return PROPERTY_COL_PREFIX + propertyKey; + } + + static boolean isProperty(String dynamoCol) { + return dynamoCol.startsWith(PROPERTY_COL_PREFIX); + } + + static String toPropertyKey(String propertyCol) { + return propertyCol.substring(PROPERTY_COL_PREFIX.length()); + } + + static Map<String, AttributeValue> namespacePrimaryKey(Namespace namespace) { + Map<String, AttributeValue> key = Maps.newHashMap(); + key.put(COL_IDENTIFIER, AttributeValue.builder().s(COL_IDENTIFIER_NAMESPACE).build()); + key.put(COL_NAMESPACE, AttributeValue.builder().s(namespace.toString()).build()); + return key; + } + + static Map<String, AttributeValue> tablePrimaryKey(TableIdentifier identifier) { + Map<String, AttributeValue> key = Maps.newHashMap(); + key.put(COL_IDENTIFIER, AttributeValue.builder().s(identifier.toString()).build()); + key.put(COL_NAMESPACE, AttributeValue.builder().s(identifier.namespace().toString()).build()); + return key; + } + + static void setNewCatalogEntryMetadata(Map<String, AttributeValue> values) { + String current = Long.toString(System.currentTimeMillis()); + values.put(COL_CREATED_AT, AttributeValue.builder().n(current).build()); + values.put(COL_UPDATED_AT, AttributeValue.builder().n(current).build()); + values.put(COL_VERSION, AttributeValue.builder().s(UUID.randomUUID().toString()).build()); + } + + static void updateCatalogEntryMetadata(List<String> updateParts, Map<String, AttributeValue> attributeValues) { + updateParts.add(COL_UPDATED_AT + " = :uat"); + attributeValues.put(":uat", AttributeValue.builder().n(Long.toString(System.currentTimeMillis())).build()); + updateParts.add(COL_VERSION + " = :uv"); + attributeValues.put(":uv", AttributeValue.builder().s(UUID.randomUUID().toString()).build()); + } + + private FileIO initializeFileIO(Map<String, String> properties) { + String fileIOImpl = properties.get(CatalogProperties.FILE_IO_IMPL); + if (fileIOImpl == null) { + FileIO io = new S3FileIO(); + io.initialize(properties); + return io; + } else { + return CatalogUtil.loadFileIO(fileIOImpl, properties, hadoopConf); + } + } + + private String cleanWarehousePath(String path) { + Preconditions.checkArgument(path != null && path.length() > 0, + "Cannot initialize DynamoDbCatalog because warehousePath must not be null"); + int len = path.length(); + if (path.charAt(len - 1) == '/') { + return path.substring(0, len - 1); + } else { + return path; + } + } + + private void validateNamespace(Namespace namespace) { + for (String level : namespace.levels()) { + ValidationException.check(level != null && !level.isEmpty(), + "Namespace level must not be empty: %s", namespace); + ValidationException.check(!level.contains("."), + "Namespace level must not contain dot, but found %s in %s", level, namespace); + } + } + + private void validateTableIdentifier(TableIdentifier identifier) { + validateNamespace(identifier.namespace()); + ValidationException.check(identifier.hasNamespace(), + "Table namespace must not be empty: %s", identifier); + String tableName = identifier.name(); + ValidationException.check(!tableName.contains("."), + "Table name must not contain dot: %s", tableName); + } + + private boolean dynamoDbTableExists(String tableName) { + try { + dynamo.describeTable(DescribeTableRequest.builder() + .tableName(tableName) + .build()); + return true; + } catch (ResourceNotFoundException e) { + return false; + } + } + + private void ensureCatalogTableExistsOrCreate() { + + if (dynamoDbTableExists(awsProperties.dynamoDbTableName())) { + return; + } + + LOG.info("DynamoDb catalog table {} not found, trying to create", awsProperties.dynamoDbTableName()); + dynamo.createTable(CreateTableRequest.builder() + .tableName(awsProperties.dynamoDbTableName()) + .keySchema( + KeySchemaElement.builder().attributeName(COL_IDENTIFIER).keyType(KeyType.HASH).build(), + KeySchemaElement.builder().attributeName(COL_NAMESPACE).keyType(KeyType.RANGE).build()) + .attributeDefinitions( + AttributeDefinition.builder().attributeName(COL_IDENTIFIER).attributeType(ScalarAttributeType.S).build(), + AttributeDefinition.builder().attributeName(COL_NAMESPACE).attributeType(ScalarAttributeType.S).build()) + .globalSecondaryIndexes(GlobalSecondaryIndex.builder() + .indexName(GSI_NAMESPACE_IDENTIFIER) + .keySchema( + KeySchemaElement.builder().attributeName(COL_NAMESPACE).keyType(KeyType.HASH).build(), + KeySchemaElement.builder().attributeName(COL_IDENTIFIER).keyType(KeyType.RANGE).build()) + .projection(Projection.builder().projectionType(ProjectionType.KEYS_ONLY).build()) + .build()) + .billingMode(BillingMode.PAY_PER_REQUEST) + .build()); + + Tasks.foreach(awsProperties.dynamoDbTableName()) Review comment: I assume what we're doing here is waiting for dynamodb to complete provisioning of the table (not sure how long that typically takes). It might be good to add a comment to explain why this check is necessary for future reference. -- 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. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
