gh-yzou commented on code in PR #1287: URL: https://github.com/apache/polaris/pull/1287#discussion_r2055041215
########## extension/persistence/relational-jdbc/src/main/java/org/apache/polaris/extension/persistence/relational/jdbc/QueryGenerator.java: ########## @@ -0,0 +1,267 @@ +/* + * 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.polaris.extension.persistence.relational.jdbc; + +import com.google.common.annotations.VisibleForTesting; +import jakarta.annotation.Nonnull; +import java.lang.reflect.Field; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import org.apache.polaris.core.entity.PolarisEntityCore; +import org.apache.polaris.core.entity.PolarisEntityId; +import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelEntity; +import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelGrantRecord; +import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelPrincipalAuthenticationData; + +public class QueryGenerator { Review Comment: I in general encourage to add a comments with examples to help the developer to have a general sense of the expected result before start dig into the code. For example, for this genereateSelectQuery, the Map<String, Object> whereClause is used to generate equivalent conditions, which is not obvious when looking at the function. And is the select query generated going to be just a select * from xxx or select columns from xxxx, and why it is not a direct select * etc. What my understanding why we do not using select * is because the schema includes realm_id, which is not part of entity. i think all those information are useful information that we can add at comment to help future maintaince. ########## extension/persistence/relational-jdbc/src/main/java/org/apache/polaris/extension/persistence/relational/jdbc/JdbcBasePersistenceImpl.java: ########## @@ -0,0 +1,752 @@ +/* + * 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.polaris.extension.persistence.relational.jdbc; + +import static org.apache.polaris.extension.persistence.relational.jdbc.QueryGenerator.*; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.function.Function; +import java.util.function.Predicate; +import java.util.stream.Collectors; +import org.apache.polaris.core.PolarisCallContext; +import org.apache.polaris.core.entity.EntityNameLookupRecord; +import org.apache.polaris.core.entity.PolarisBaseEntity; +import org.apache.polaris.core.entity.PolarisChangeTrackingVersions; +import org.apache.polaris.core.entity.PolarisEntityCore; +import org.apache.polaris.core.entity.PolarisEntityId; +import org.apache.polaris.core.entity.PolarisEntityType; +import org.apache.polaris.core.entity.PolarisGrantRecord; +import org.apache.polaris.core.entity.PolarisPrincipalSecrets; +import org.apache.polaris.core.persistence.BaseMetaStoreManager; +import org.apache.polaris.core.persistence.BasePersistence; +import org.apache.polaris.core.persistence.EntityAlreadyExistsException; +import org.apache.polaris.core.persistence.IntegrationPersistence; +import org.apache.polaris.core.persistence.PrincipalSecretsGenerator; +import org.apache.polaris.core.persistence.RetryOnConcurrencyException; +import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo; +import org.apache.polaris.core.storage.PolarisStorageIntegration; +import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider; +import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelEntity; +import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelGrantRecord; +import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelPrincipalAuthenticationData; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class JdbcBasePersistenceImpl implements BasePersistence, IntegrationPersistence { + + private static final Logger LOGGER = LoggerFactory.getLogger(JdbcBasePersistenceImpl.class); + + private final DatasourceOperations datasourceOperations; + private final PrincipalSecretsGenerator secretsGenerator; + private final PolarisStorageIntegrationProvider storageIntegrationProvider; + private final String realmId; + + public JdbcBasePersistenceImpl( + DatasourceOperations databaseOperations, + PrincipalSecretsGenerator secretsGenerator, + PolarisStorageIntegrationProvider storageIntegrationProvider, + String realmId) { + this.datasourceOperations = databaseOperations; + this.secretsGenerator = secretsGenerator; + this.storageIntegrationProvider = storageIntegrationProvider; + this.realmId = realmId; + } + + @Override + public long generateNewId(@Nonnull PolarisCallContext callCtx) { + return IdGenerator.getIdGenerator().nextId(); + } + + @Override + public void writeEntity( + @Nonnull PolarisCallContext callCtx, + @Nonnull PolarisBaseEntity entity, + boolean nameOrParentChanged, + PolarisBaseEntity originalEntity) { + ModelEntity modelEntity = ModelEntity.fromEntity(entity); + String query; + if (originalEntity == null) { + try { + query = generateInsertQuery(modelEntity, realmId); + datasourceOperations.executeUpdate(query); + } catch (SQLException e) { + if ((datasourceOperations.isConstraintViolation(e) + || datasourceOperations.isAlreadyExistsException(e))) { + throw new EntityAlreadyExistsException(entity); + } else { + throw new RuntimeException( + String.format("Failed to write entity due to %s", e.getMessage())); + } + } + } else { + Map<String, Object> params = + Map.of( + "id", + originalEntity.getId(), + "catalog_id", + originalEntity.getCatalogId(), + "entity_version", + originalEntity.getEntityVersion(), + "realm_id", + realmId); + query = generateUpdateQuery(modelEntity, params); + try { + int rowsUpdated = datasourceOperations.executeUpdate(query); + if (rowsUpdated == 0) { + throw new RetryOnConcurrencyException( + "Entity '%s' id '%s' concurrently modified; expected version %s", + entity.getName(), entity.getId(), originalEntity.getEntityVersion()); + } + } catch (SQLException e) { + throw new RuntimeException( + String.format("Failed to write entity due to %s", e.getMessage())); + } + } + } + + @Override + public void writeEntities( + @Nonnull PolarisCallContext callCtx, + @Nonnull List<PolarisBaseEntity> entities, + List<PolarisBaseEntity> originalEntities) { + try { + datasourceOperations.runWithinTransaction( + statement -> { + for (int i = 0; i < entities.size(); i++) { + PolarisBaseEntity entity = entities.get(i); + ModelEntity modelEntity = ModelEntity.fromEntity(entity); + + // first, check if the entity has already been created, in which case we will simply + // return it. + PolarisBaseEntity entityFound = + lookupEntity( + callCtx, entity.getCatalogId(), entity.getId(), entity.getTypeCode()); + if (entityFound != null) { + // probably the client retried, simply return it + // TODO: Check correctness of returning entityFound vs entity here. It may have + // already been updated after the creation. + continue; + } + // lookup by name + EntityNameLookupRecord exists = + lookupEntityIdAndSubTypeByName( + callCtx, + entity.getCatalogId(), + entity.getParentId(), + entity.getTypeCode(), + entity.getName()); + if (exists != null) { + throw new EntityAlreadyExistsException(entity); + } + String query; + if (originalEntities == null || originalEntities.get(i) == null) { + try { + query = generateInsertQuery(modelEntity, realmId); + statement.executeUpdate(query); + } catch (SQLException e) { + if ((datasourceOperations.isConstraintViolation(e) + || datasourceOperations.isAlreadyExistsException(e))) { + throw new EntityAlreadyExistsException(entity); + } else { + throw new RuntimeException( + String.format("Failed to write entity due to %s", e.getMessage())); + } + } + } else { + Map<String, Object> params = + Map.of( + "id", + originalEntities.get(i).getId(), + "catalog_id", + originalEntities.get(i).getCatalogId(), + "entity_version", + originalEntities.get(i).getEntityVersion(), + "realm_id", + realmId); + query = generateUpdateQuery(modelEntity, params); + try { + int rowsUpdated = statement.executeUpdate(query); + if (rowsUpdated == 0) { + throw new RetryOnConcurrencyException( + "Entity '%s' id '%s' concurrently modified; expected version %s", + entity.getName(), + entity.getId(), + originalEntities.get(i).getEntityVersion()); + } + } catch (SQLException e) { + throw new RuntimeException( + String.format("Failed to write entity due to %s", e.getMessage())); Review Comment: I think that is a good idea, but i think might be good to do it in a follow up pr, so that we can have a small nice scoped PR that focus on handling RuntimeException caused by SQL exception -- 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...@polaris.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
