singhpk234 commented on code in PR #1287: URL: https://github.com/apache/polaris/pull/1287#discussion_r2042520088
########## extension/persistence/relational-jdbc/src/main/java/org/apache/polaris/extension/persistence/relational/jdbc/JdbcBasePersistenceImpl.java: ########## @@ -0,0 +1,619 @@ +/* + * 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 jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +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; + + public JdbcBasePersistenceImpl( + DatasourceOperations databaseOperations, + PrincipalSecretsGenerator secretsGenerator, + PolarisStorageIntegrationProvider storageIntegrationProvider) { + this.datasourceOperations = databaseOperations; + this.secretsGenerator = secretsGenerator; + this.storageIntegrationProvider = storageIntegrationProvider; + } + + @Override + public long generateNewId(@Nonnull PolarisCallContext callCtx) { + return IdGenerator.idGenerator.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) { + query = JdbcCrudQueryGenerator.generateInsertQuery(modelEntity, ModelEntity.class); + } else { + Map<String, Object> params = new HashMap<>(); + params.put("id", originalEntity.getId()); + params.put("catalog_id", originalEntity.getCatalogId()); + params.put("entity_version", originalEntity.getEntityVersion()); + query = JdbcCrudQueryGenerator.generateUpdateQuery(modelEntity, params, ModelEntity.class); + } + int rowsUpdated = datasourceOperations.executeUpdate(query); + if (rowsUpdated == -1 && originalEntity == null) { + // constraint validation. + throw new EntityAlreadyExistsException(entity); + } else if (rowsUpdated == 0 && originalEntity != null) { + // concurrently row got updated, as version mismatched. + throw new RetryOnConcurrencyException("CAS failed"); + } + } + + @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) { + query = JdbcCrudQueryGenerator.generateInsertQuery(modelEntity, ModelEntity.class); + } else { + // CAS + Map<String, Object> params = new HashMap<>(); + params.put("id", originalEntities.get(i).getId()); + params.put("catalog_id", originalEntities.get(i).getCatalogId()); + params.put("entity_version", originalEntities.get(i).getEntityVersion()); + query = + JdbcCrudQueryGenerator.generateUpdateQuery( + modelEntity, params, ModelEntity.class); + } + int rowsUpdated = datasourceOperations.executeUpdate(query); + boolean isUpdate = (originalEntities != null && originalEntities.get(i) != null); + if (rowsUpdated == -1 && !isUpdate) { + // constrain validation exception. + throw new EntityAlreadyExistsException(entity); + } else if (rowsUpdated == 0 && isUpdate) { + throw new RetryOnConcurrencyException("CAS failed"); + } + } + return true; + }); + } catch (Exception e) { + LOGGER.error("Error executing transaction {}", e.getMessage()); + throw e; + } + } + + @Override + public void writeToGrantRecords( + @Nonnull PolarisCallContext callCtx, @Nonnull PolarisGrantRecord grantRec) { + ModelGrantRecord modelGrantRecord = ModelGrantRecord.fromGrantRecord(grantRec); + String query = + JdbcCrudQueryGenerator.generateInsertQuery(modelGrantRecord, ModelGrantRecord.class); + datasourceOperations.executeUpdate(query); + } + + @Override + public void deleteEntity(@Nonnull PolarisCallContext callCtx, @Nonnull PolarisBaseEntity entity) { + ModelEntity modelEntity = ModelEntity.fromEntity(entity); + Map<String, Object> params = new HashMap<>(); + params.put("id", modelEntity.getId()); + params.put("catalog_id", modelEntity.getCatalogId()); + datasourceOperations.executeUpdate( + JdbcCrudQueryGenerator.generateDeleteQuery(params, ModelEntity.class)); + } + + @Override + public void deleteFromGrantRecords( + @Nonnull PolarisCallContext callCtx, @Nonnull PolarisGrantRecord grantRec) { + ModelGrantRecord modelGrantRecord = ModelGrantRecord.fromGrantRecord(grantRec); + String query = + JdbcCrudQueryGenerator.generateDeleteQuery(modelGrantRecord, ModelGrantRecord.class); + datasourceOperations.executeUpdate(query); + } + + @Override + public void deleteAllEntityGrantRecords( + @Nonnull PolarisCallContext callCtx, + PolarisEntityCore entity, + @Nonnull List<PolarisGrantRecord> grantsOnGrantee, + @Nonnull List<PolarisGrantRecord> grantsOnSecurable) { + // generate where clause + StringBuilder granteeCondition = new StringBuilder("(grantee_id, grantee_catalog_id) IN ("); + granteeCondition.append("(" + entity.getId() + ", " + entity.getCatalogId() + ")"); + granteeCondition.append(","); + // extra , removed + granteeCondition.deleteCharAt(granteeCondition.length() - 1); + granteeCondition.append(")"); + + StringBuilder securableCondition = + new StringBuilder("(securable_catalog_id, securable_id) IN ("); + + String in = "(" + entity.getCatalogId() + ", " + entity.getId() + ")"; + securableCondition.append(in); + securableCondition.append(","); + + // extra , removed + securableCondition.deleteCharAt(securableCondition.length() - 1); + securableCondition.append(")"); + + String whereClause = " WHERE " + granteeCondition + " OR " + securableCondition; + datasourceOperations.executeUpdate( + JdbcCrudQueryGenerator.generateDeleteQuery(ModelGrantRecord.class, whereClause)); + } + + @Override + public void deleteAll(@Nonnull PolarisCallContext callCtx) { + datasourceOperations.executeUpdate(JdbcCrudQueryGenerator.generateDeleteAll(ModelEntity.class)); + datasourceOperations.executeUpdate( + JdbcCrudQueryGenerator.generateDeleteAll(ModelGrantRecord.class)); + datasourceOperations.executeUpdate(JdbcCrudQueryGenerator.generateDeleteAll(ModelEntity.class)); + } + + @Override + public PolarisBaseEntity lookupEntity( + @Nonnull PolarisCallContext callCtx, long catalogId, long entityId, int typeCode) { + Map<String, Object> params = new HashMap<>(); + params.put("catalog_id", catalogId); + params.put("id", entityId); + params.put("type_code", typeCode); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, params, null, null, "last_update_timestamp"); + return getPolarisBaseEntity(query); + } + + @Override + public PolarisBaseEntity lookupEntityByName( + @Nonnull PolarisCallContext callCtx, + long catalogId, + long parentId, + int typeCode, + String name) { + Map<String, Object> params = new HashMap<>(); + params.put("catalog_id", catalogId); + params.put("parent_id", parentId); + params.put("type_code", typeCode); + + if (name != null) { + params.put("name", name); + } + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, params, 1, null, "last_update_timestamp"); + return getPolarisBaseEntity(query); + } + + @Nullable + private PolarisBaseEntity getPolarisBaseEntity(String query) { + List<ModelEntity> results = datasourceOperations.executeSelect(query, ModelEntity.class); + return results == null || results.isEmpty() ? null : ModelEntity.toEntity(results.get(0)); + } + + @Nonnull + @Override + public List<PolarisBaseEntity> lookupEntities( + @Nonnull PolarisCallContext callCtx, List<PolarisEntityId> entityIds) { + if (entityIds == null || entityIds.isEmpty()) return new ArrayList<>(); + StringBuilder condition = new StringBuilder("(catalog_id, id) IN ("); + for (int i = 0; i < entityIds.size(); i++) { + String in = "(" + entityIds.get(i).getCatalogId() + ", " + entityIds.get(i).getId() + ")"; + condition.append(in); + condition.append(","); + } + // extra , removed + condition.deleteCharAt(condition.length() - 1); + condition.append(")"); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, + entityIds.isEmpty() ? "" : String.valueOf(condition), + null, + null, + null); + List<ModelEntity> results = datasourceOperations.executeSelect(query, ModelEntity.class); + return results == null + ? Collections.emptyList() + : results.stream().map(ModelEntity::toEntity).collect(Collectors.toList()); + } + + @Nonnull + @Override + public List<PolarisChangeTrackingVersions> lookupEntityVersions( + @Nonnull PolarisCallContext callCtx, List<PolarisEntityId> entityIds) { + Map<PolarisEntityId, ModelEntity> idToEntityMap = + lookupEntities(callCtx, entityIds).stream() + .collect( + Collectors.toMap( + entry -> new PolarisEntityId(entry.getCatalogId(), entry.getId()), + ModelEntity::fromEntity)); + return entityIds.stream() + .map( + entityId -> { + ModelEntity entity = idToEntityMap.getOrDefault(entityId, null); + return entity == null + ? null + : new PolarisChangeTrackingVersions( + entity.getEntityVersion(), entity.getGrantRecordsVersion()); + }) + .collect(Collectors.toList()); + } + + @Nonnull + @Override + public List<EntityNameLookupRecord> listEntities( + @Nonnull PolarisCallContext callCtx, + long catalogId, + long parentId, + @Nonnull PolarisEntityType entityType) { + return listEntities( + callCtx, + catalogId, + parentId, + entityType, + Integer.MAX_VALUE, + e -> true, + EntityNameLookupRecord::new); + } + + @Nonnull + @Override + public List<EntityNameLookupRecord> listEntities( + @Nonnull PolarisCallContext callCtx, + long catalogId, + long parentId, + @Nonnull PolarisEntityType entityType, + @Nonnull Predicate<PolarisBaseEntity> entityFilter) { + return listEntities( + callCtx, + catalogId, + parentId, + entityType, + Integer.MAX_VALUE, + entityFilter, + EntityNameLookupRecord::new); + } + + @Nonnull + @Override + public <T> List<T> listEntities( + @Nonnull PolarisCallContext callCtx, + long catalogId, + long parentId, + PolarisEntityType entityType, + int limit, + @Nonnull Predicate<PolarisBaseEntity> entityFilter, + @Nonnull Function<PolarisBaseEntity, T> transformer) { + Map<String, Object> params = new HashMap<>(); + params.put("catalog_id", catalogId); + params.put("parent_id", parentId); + params.put("type_code", entityType.getCode()); + + // Limit can't be pushed down, due to client side filtering + // absence of transaction. + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, params, null, null, "last_update_timestamp"); + List<ModelEntity> results = datasourceOperations.executeSelect(query, ModelEntity.class); + return results == null + ? Collections.emptyList() + : results.stream() + .map(ModelEntity::toEntity) + .filter(entityFilter) + .map(transformer) + .limit(limit) + .collect(Collectors.toList()); + } + + @Override + public int lookupEntityGrantRecordsVersion( + @Nonnull PolarisCallContext callCtx, long catalogId, long entityId) { + + Map<String, Object> params = new HashMap<>(); + params.put("catalog_id", catalogId); + params.put("id", entityId); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, params, null, null, "last_update_timestamp"); + PolarisBaseEntity b = getPolarisBaseEntity(query); + return b == null ? 0 : b.getGrantRecordsVersion(); + } + + @Override + public PolarisGrantRecord lookupGrantRecord( + @Nonnull PolarisCallContext callCtx, + long securableCatalogId, + long securableId, + long granteeCatalogId, + long granteeId, + int privilegeCode) { + Map<String, Object> params = new HashMap<>(); + params.put("securable_catalog_id", securableCatalogId); + params.put("securable_id", securableId); + params.put("grantee_catalog_id", granteeCatalogId); + params.put("grantee_id", granteeId); + params.put("privilege_code", privilegeCode); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelGrantRecord.class, params, null, null, null); + List<ModelGrantRecord> results = + datasourceOperations.executeSelect(query, ModelGrantRecord.class); + return results == null ? null : ModelGrantRecord.toGrantRecord(results.get(0)); + } + + @Nonnull + @Override + public List<PolarisGrantRecord> loadAllGrantRecordsOnSecurable( + @Nonnull PolarisCallContext callCtx, long securableCatalogId, long securableId) { + Map<String, Object> params = new HashMap<>(); + params.put("securable_catalog_id", securableCatalogId); + params.put("securable_id", securableId); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelGrantRecord.class, params, null, null, null); + List<ModelGrantRecord> results = + datasourceOperations.executeSelect(query, ModelGrantRecord.class); + return results == null + ? Collections.emptyList() + : results.stream().map(ModelGrantRecord::toGrantRecord).collect(Collectors.toList()); + } + + @Nonnull + @Override + public List<PolarisGrantRecord> loadAllGrantRecordsOnGrantee( + @Nonnull PolarisCallContext callCtx, long granteeCatalogId, long granteeId) { + Map<String, Object> params = new HashMap<>(); + params.put("grantee_catalog_id", granteeCatalogId); + params.put("grantee_id", granteeId); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelGrantRecord.class, params, null, null, null); + List<ModelGrantRecord> results = + datasourceOperations.executeSelect(query, ModelGrantRecord.class); + return results == null + ? Collections.emptyList() + : results.stream().map(ModelGrantRecord::toGrantRecord).collect(Collectors.toList()); + } + + @Override + public boolean hasChildren( + @Nonnull PolarisCallContext callContext, + PolarisEntityType optionalEntityType, + long catalogId, + long parentId) { + Map<String, Object> params = new HashMap<>(); + params.put("catalog_id", catalogId); + params.put("parent_id", parentId); + if (optionalEntityType != null) { + params.put("type_code", optionalEntityType.getCode()); + } + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, params, null, null, "last_update_timestamp"); + List<ModelEntity> results = datasourceOperations.executeSelect(query, ModelEntity.class); + + return results != null && !results.isEmpty(); + } + + @Nullable + @Override + public PolarisPrincipalSecrets loadPrincipalSecrets( + @Nonnull PolarisCallContext callCtx, @Nonnull String clientId) { + Map<String, Object> params = new HashMap<>(); + params.put("principal_client_id", clientId); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelPrincipalAuthenticationData.class, params, null, null, null); + List<ModelPrincipalAuthenticationData> results = + datasourceOperations.executeSelect(query, ModelPrincipalAuthenticationData.class); + return results == null || results.isEmpty() + ? null + : results.stream() + .map(ModelPrincipalAuthenticationData::toPrincipalSecrets) + .toList() + .getFirst(); + } + + @Nonnull + @Override + public PolarisPrincipalSecrets generateNewPrincipalSecrets( + @Nonnull PolarisCallContext callCtx, @Nonnull String principalName, long principalId) { + // ensure principal client id is unique + PolarisPrincipalSecrets principalSecrets; + ModelPrincipalAuthenticationData lookupPrincipalSecrets; + do { + // generate new random client id and secrets + principalSecrets = secretsGenerator.produceSecrets(principalName, principalId); Review Comment: This is mostly taken from Eclipselink logic, not sure why we did it in the first place. https://github.com/apache/polaris/blob/main/extension/persistence/eclipselink/src/main/java/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java#L557 ########## extension/persistence/relational-jdbc/src/main/java/org/apache/polaris/extension/persistence/relational/jdbc/JdbcMetaStoreManagerFactory.java: ########## @@ -0,0 +1,276 @@ +/* + * 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 jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Supplier; +import javax.sql.DataSource; +import org.apache.polaris.core.PolarisCallContext; +import org.apache.polaris.core.PolarisDefaultDiagServiceImpl; +import org.apache.polaris.core.PolarisDiagnostics; +import org.apache.polaris.core.context.CallContext; +import org.apache.polaris.core.context.RealmContext; +import org.apache.polaris.core.entity.*; +import org.apache.polaris.core.persistence.*; +import org.apache.polaris.core.persistence.bootstrap.RootCredentialsSet; +import org.apache.polaris.core.persistence.cache.EntityCache; +import org.apache.polaris.core.persistence.dao.entity.BaseResult; +import org.apache.polaris.core.persistence.dao.entity.EntityResult; +import org.apache.polaris.core.persistence.dao.entity.PrincipalSecretsResult; +import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider; +import org.apache.polaris.core.storage.cache.StorageCredentialCache; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * The implementation of Configuration interface for configuring the {@link PolarisMetaStoreManager} + * using a JDBC backed by SQL metastore. + */ +public class JdbcMetaStoreManagerFactory implements MetaStoreManagerFactory { + + private static final Logger LOGGER = LoggerFactory.getLogger(JdbcMetaStoreManagerFactory.class); + final Map<String, PolarisMetaStoreManager> metaStoreManagerMap = new HashMap<>(); + final Map<String, StorageCredentialCache> storageCredentialCacheMap = new HashMap<>(); + final Map<String, EntityCache> entityCacheMap = new HashMap<>(); + final Map<String, Supplier<BasePersistence>> sessionSupplierMap = new HashMap<>(); + protected final PolarisDiagnostics diagServices = new PolarisDefaultDiagServiceImpl(); + + DataSource ds; + private final PolarisDiagnostics diagnostics; + PolarisStorageIntegrationProvider storageIntegrationProvider; + + protected JdbcMetaStoreManagerFactory(@Nonnull PolarisDiagnostics diagnostics) { + this.diagnostics = diagnostics; + } + + /** + * Subclasses can override this to inject different implementations of PolarisMetaStoreManager + * into the existing realm-based setup flow. + */ + protected PolarisMetaStoreManager createNewMetaStoreManager() { + return new AtomicOperationMetaStoreManager(); + } + + private void initializeForRealm( + RealmContext realmContext, RootCredentialsSet rootCredentialsSet) { + DatasourceOperations databaseOperations = new DatasourceOperations(ds); + // TODO: see if we need to take script from Quarkus or can we just + // use the script committed repo. + databaseOperations.executeScript("scripts/postgres/schema-v1-postgres.sql"); + sessionSupplierMap.put( + realmContext.getRealmIdentifier(), + () -> + new JdbcBasePersistenceImpl( + databaseOperations, + secretsGenerator(realmContext, rootCredentialsSet), + storageIntegrationProvider)); Review Comment: yes, i think the pass missing here is the following : 1. 1 datasource per realm and then use CDI magic to get the corresponding Datasource via using custom datasource name. quarkus.datasource.<real-identifier>.jdbc.url then while creating the JDBC persistence impl find the DS by real id and then wire in. 2. 1 schema per realm presently if you see we have every table inside one schema i.e `POLARIS_SCHEMA`, i could wire in the schema as the realm to seperate the tables from each other. I am open of to both, as 1 I can't do cleanly without taking quarkus magic to find the Datasource by name, and 2nd is kind of a deviation as in prev Eclipse link impl 1 realm was 1 DB. please let me know your thoughts considering above. cc @flyrain ########## extension/persistence/relational-jdbc/src/main/java/org/apache/polaris/extension/persistence/relational/jdbc/JdbcBasePersistenceImpl.java: ########## @@ -0,0 +1,619 @@ +/* + * 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 jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +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; + + public JdbcBasePersistenceImpl( + DatasourceOperations databaseOperations, + PrincipalSecretsGenerator secretsGenerator, + PolarisStorageIntegrationProvider storageIntegrationProvider) { + this.datasourceOperations = databaseOperations; + this.secretsGenerator = secretsGenerator; + this.storageIntegrationProvider = storageIntegrationProvider; + } + + @Override + public long generateNewId(@Nonnull PolarisCallContext callCtx) { + return IdGenerator.idGenerator.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) { + query = JdbcCrudQueryGenerator.generateInsertQuery(modelEntity, ModelEntity.class); + } else { + Map<String, Object> params = new HashMap<>(); + params.put("id", originalEntity.getId()); + params.put("catalog_id", originalEntity.getCatalogId()); + params.put("entity_version", originalEntity.getEntityVersion()); + query = JdbcCrudQueryGenerator.generateUpdateQuery(modelEntity, params, ModelEntity.class); + } + int rowsUpdated = datasourceOperations.executeUpdate(query); + if (rowsUpdated == -1 && originalEntity == null) { + // constraint validation. + throw new EntityAlreadyExistsException(entity); + } else if (rowsUpdated == 0 && originalEntity != null) { + // concurrently row got updated, as version mismatched. + throw new RetryOnConcurrencyException("CAS failed"); + } + } + + @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) { + query = JdbcCrudQueryGenerator.generateInsertQuery(modelEntity, ModelEntity.class); + } else { + // CAS + Map<String, Object> params = new HashMap<>(); + params.put("id", originalEntities.get(i).getId()); + params.put("catalog_id", originalEntities.get(i).getCatalogId()); + params.put("entity_version", originalEntities.get(i).getEntityVersion()); + query = + JdbcCrudQueryGenerator.generateUpdateQuery( + modelEntity, params, ModelEntity.class); + } + int rowsUpdated = datasourceOperations.executeUpdate(query); + boolean isUpdate = (originalEntities != null && originalEntities.get(i) != null); + if (rowsUpdated == -1 && !isUpdate) { + // constrain validation exception. + throw new EntityAlreadyExistsException(entity); + } else if (rowsUpdated == 0 && isUpdate) { + throw new RetryOnConcurrencyException("CAS failed"); + } + } + return true; + }); + } catch (Exception e) { + LOGGER.error("Error executing transaction {}", e.getMessage()); + throw e; + } + } + + @Override + public void writeToGrantRecords( + @Nonnull PolarisCallContext callCtx, @Nonnull PolarisGrantRecord grantRec) { + ModelGrantRecord modelGrantRecord = ModelGrantRecord.fromGrantRecord(grantRec); + String query = + JdbcCrudQueryGenerator.generateInsertQuery(modelGrantRecord, ModelGrantRecord.class); + datasourceOperations.executeUpdate(query); + } + + @Override + public void deleteEntity(@Nonnull PolarisCallContext callCtx, @Nonnull PolarisBaseEntity entity) { + ModelEntity modelEntity = ModelEntity.fromEntity(entity); + Map<String, Object> params = new HashMap<>(); + params.put("id", modelEntity.getId()); + params.put("catalog_id", modelEntity.getCatalogId()); + datasourceOperations.executeUpdate( + JdbcCrudQueryGenerator.generateDeleteQuery(params, ModelEntity.class)); + } + + @Override + public void deleteFromGrantRecords( + @Nonnull PolarisCallContext callCtx, @Nonnull PolarisGrantRecord grantRec) { + ModelGrantRecord modelGrantRecord = ModelGrantRecord.fromGrantRecord(grantRec); + String query = + JdbcCrudQueryGenerator.generateDeleteQuery(modelGrantRecord, ModelGrantRecord.class); + datasourceOperations.executeUpdate(query); + } + + @Override + public void deleteAllEntityGrantRecords( + @Nonnull PolarisCallContext callCtx, + PolarisEntityCore entity, + @Nonnull List<PolarisGrantRecord> grantsOnGrantee, + @Nonnull List<PolarisGrantRecord> grantsOnSecurable) { + // generate where clause + StringBuilder granteeCondition = new StringBuilder("(grantee_id, grantee_catalog_id) IN ("); + granteeCondition.append("(" + entity.getId() + ", " + entity.getCatalogId() + ")"); + granteeCondition.append(","); + // extra , removed + granteeCondition.deleteCharAt(granteeCondition.length() - 1); + granteeCondition.append(")"); + + StringBuilder securableCondition = + new StringBuilder("(securable_catalog_id, securable_id) IN ("); + + String in = "(" + entity.getCatalogId() + ", " + entity.getId() + ")"; + securableCondition.append(in); + securableCondition.append(","); + + // extra , removed + securableCondition.deleteCharAt(securableCondition.length() - 1); + securableCondition.append(")"); + + String whereClause = " WHERE " + granteeCondition + " OR " + securableCondition; + datasourceOperations.executeUpdate( + JdbcCrudQueryGenerator.generateDeleteQuery(ModelGrantRecord.class, whereClause)); + } + + @Override + public void deleteAll(@Nonnull PolarisCallContext callCtx) { + datasourceOperations.executeUpdate(JdbcCrudQueryGenerator.generateDeleteAll(ModelEntity.class)); + datasourceOperations.executeUpdate( + JdbcCrudQueryGenerator.generateDeleteAll(ModelGrantRecord.class)); + datasourceOperations.executeUpdate(JdbcCrudQueryGenerator.generateDeleteAll(ModelEntity.class)); + } + + @Override + public PolarisBaseEntity lookupEntity( + @Nonnull PolarisCallContext callCtx, long catalogId, long entityId, int typeCode) { + Map<String, Object> params = new HashMap<>(); + params.put("catalog_id", catalogId); + params.put("id", entityId); + params.put("type_code", typeCode); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, params, null, null, "last_update_timestamp"); + return getPolarisBaseEntity(query); + } + + @Override + public PolarisBaseEntity lookupEntityByName( + @Nonnull PolarisCallContext callCtx, + long catalogId, + long parentId, + int typeCode, + String name) { + Map<String, Object> params = new HashMap<>(); + params.put("catalog_id", catalogId); + params.put("parent_id", parentId); + params.put("type_code", typeCode); + + if (name != null) { + params.put("name", name); + } + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, params, 1, null, "last_update_timestamp"); + return getPolarisBaseEntity(query); + } + + @Nullable + private PolarisBaseEntity getPolarisBaseEntity(String query) { + List<ModelEntity> results = datasourceOperations.executeSelect(query, ModelEntity.class); + return results == null || results.isEmpty() ? null : ModelEntity.toEntity(results.get(0)); + } + + @Nonnull + @Override + public List<PolarisBaseEntity> lookupEntities( + @Nonnull PolarisCallContext callCtx, List<PolarisEntityId> entityIds) { + if (entityIds == null || entityIds.isEmpty()) return new ArrayList<>(); + StringBuilder condition = new StringBuilder("(catalog_id, id) IN ("); + for (int i = 0; i < entityIds.size(); i++) { + String in = "(" + entityIds.get(i).getCatalogId() + ", " + entityIds.get(i).getId() + ")"; + condition.append(in); + condition.append(","); + } + // extra , removed + condition.deleteCharAt(condition.length() - 1); + condition.append(")"); + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, + entityIds.isEmpty() ? "" : String.valueOf(condition), + null, + null, + null); + List<ModelEntity> results = datasourceOperations.executeSelect(query, ModelEntity.class); + return results == null + ? Collections.emptyList() + : results.stream().map(ModelEntity::toEntity).collect(Collectors.toList()); + } + + @Nonnull + @Override + public List<PolarisChangeTrackingVersions> lookupEntityVersions( + @Nonnull PolarisCallContext callCtx, List<PolarisEntityId> entityIds) { + Map<PolarisEntityId, ModelEntity> idToEntityMap = + lookupEntities(callCtx, entityIds).stream() + .collect( + Collectors.toMap( + entry -> new PolarisEntityId(entry.getCatalogId(), entry.getId()), + ModelEntity::fromEntity)); + return entityIds.stream() + .map( + entityId -> { + ModelEntity entity = idToEntityMap.getOrDefault(entityId, null); + return entity == null + ? null + : new PolarisChangeTrackingVersions( + entity.getEntityVersion(), entity.getGrantRecordsVersion()); + }) + .collect(Collectors.toList()); + } + + @Nonnull + @Override + public List<EntityNameLookupRecord> listEntities( + @Nonnull PolarisCallContext callCtx, + long catalogId, + long parentId, + @Nonnull PolarisEntityType entityType) { + return listEntities( + callCtx, + catalogId, + parentId, + entityType, + Integer.MAX_VALUE, + e -> true, + EntityNameLookupRecord::new); + } + + @Nonnull + @Override + public List<EntityNameLookupRecord> listEntities( + @Nonnull PolarisCallContext callCtx, + long catalogId, + long parentId, + @Nonnull PolarisEntityType entityType, + @Nonnull Predicate<PolarisBaseEntity> entityFilter) { + return listEntities( + callCtx, + catalogId, + parentId, + entityType, + Integer.MAX_VALUE, + entityFilter, + EntityNameLookupRecord::new); + } + + @Nonnull + @Override + public <T> List<T> listEntities( + @Nonnull PolarisCallContext callCtx, + long catalogId, + long parentId, + PolarisEntityType entityType, + int limit, + @Nonnull Predicate<PolarisBaseEntity> entityFilter, + @Nonnull Function<PolarisBaseEntity, T> transformer) { + Map<String, Object> params = new HashMap<>(); + params.put("catalog_id", catalogId); + params.put("parent_id", parentId); + params.put("type_code", entityType.getCode()); + + // Limit can't be pushed down, due to client side filtering + // absence of transaction. + String query = + JdbcCrudQueryGenerator.generateSelectQuery( + ModelEntity.class, params, null, null, "last_update_timestamp"); + List<ModelEntity> results = datasourceOperations.executeSelect(query, ModelEntity.class); + return results == null + ? Collections.emptyList() + : results.stream() + .map(ModelEntity::toEntity) + .filter(entityFilter) + .map(transformer) + .limit(limit) Review Comment: we can't push limit to the database anymore because this will no longer to be atomic which is a requirement for AtomicMetaStoreManager otherwise will have to implement a pagination within a transaction, -- 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
