This is an automated email from the ASF dual-hosted git repository.
dimas pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 19703194 [NoSQL] Make TransactionalPersistence an interface (#1097)
19703194 is described below
commit 19703194c33d124db53335c328eaec5203618311
Author: Robert Stupp <[email protected]>
AuthorDate: Mon Mar 3 12:03:43 2025 -0600
[NoSQL] Make TransactionalPersistence an interface (#1097)
This change makes `TransactionalPersistence` an interface and introduces
`AbstractTransactionalPersistence` having the code that was in
`TransactionalPersistence`.
---
.../PolarisEclipseLinkMetaStoreSessionImpl.java | 4 +-
....java => AbstractTransactionalPersistence.java} | 66 +-------
.../PolarisTreeMapMetaStoreSessionImpl.java | 2 +-
.../transactional/TransactionalPersistence.java | 177 +--------------------
4 files changed, 11 insertions(+), 238 deletions(-)
diff --git
a/extension/persistence/eclipselink/src/main/java/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java
b/extension/persistence/eclipselink/src/main/java/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java
index 4954de2c..08d27b34 100644
---
a/extension/persistence/eclipselink/src/main/java/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java
+++
b/extension/persistence/eclipselink/src/main/java/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java
@@ -52,7 +52,7 @@ import
org.apache.polaris.core.exceptions.AlreadyExistsException;
import org.apache.polaris.core.persistence.BaseMetaStoreManager;
import org.apache.polaris.core.persistence.PrincipalSecretsGenerator;
import org.apache.polaris.core.persistence.RetryOnConcurrencyException;
-import
org.apache.polaris.core.persistence.transactional.TransactionalPersistence;
+import
org.apache.polaris.core.persistence.transactional.AbstractTransactionalPersistence;
import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo;
import org.apache.polaris.core.storage.PolarisStorageIntegration;
import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider;
@@ -68,7 +68,7 @@ import org.slf4j.LoggerFactory;
* EclipseLink implementation of a Polaris metadata store supporting
persisting and retrieving all
* Polaris metadata from/to the configured database systems.
*/
-public class PolarisEclipseLinkMetaStoreSessionImpl extends
TransactionalPersistence {
+public class PolarisEclipseLinkMetaStoreSessionImpl extends
AbstractTransactionalPersistence {
private static final Logger LOGGER =
LoggerFactory.getLogger(PolarisEclipseLinkMetaStoreSessionImpl.class);
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/TransactionalPersistence.java
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/AbstractTransactionalPersistence.java
similarity index 69%
copy from
polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/TransactionalPersistence.java
copy to
polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/AbstractTransactionalPersistence.java
index 856fc792..4393e234 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/TransactionalPersistence.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/AbstractTransactionalPersistence.java
@@ -21,69 +21,18 @@ package org.apache.polaris.core.persistence.transactional;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import java.util.List;
-import java.util.function.Supplier;
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.PolarisEntitiesActiveKey;
import org.apache.polaris.core.entity.PolarisEntityCore;
-import org.apache.polaris.core.persistence.BasePersistence;
-import org.apache.polaris.core.persistence.IntegrationPersistence;
/**
* Extends BasePersistence to express a more "transaction-oriented" control
flow for backing stores
* which can support a runInTransaction semantic, while providing default
implementations of some of
* the BasePersistence methods in terms of lower-level methods that subclasses
must implement.
*/
-public abstract class TransactionalPersistence implements BasePersistence,
IntegrationPersistence {
-
- /**
- * Run the specified transaction code (a Supplier lambda type) in a database
read/write
- * transaction. If the code of the transaction does not throw any exception
and returns normally,
- * the transaction will be committed, else the transaction will be
automatically rolled-back on
- * error. The result of the supplier lambda is returned if success, else the
error will be
- * re-thrown.
- *
- * @param callCtx call context
- * @param transactionCode code of the transaction being executed, a supplier
lambda
- */
- public abstract <T> T runInTransaction(
- @Nonnull PolarisCallContext callCtx, @Nonnull Supplier<T>
transactionCode);
-
- /**
- * Run the specified transaction code (a runnable lambda type) in a database
read/write
- * transaction. If the code of the transaction does not throw any exception
and returns normally,
- * the transaction will be committed, else the transaction will be
automatically rolled-back on
- * error.
- *
- * @param callCtx call context
- * @param transactionCode code of the transaction being executed, a runnable
lambda
- */
- public abstract void runActionInTransaction(
- @Nonnull PolarisCallContext callCtx, @Nonnull Runnable transactionCode);
-
- /**
- * Run the specified transaction code (a Supplier lambda type) in a database
read transaction. If
- * the code of the transaction does not throw any exception and returns
normally, the transaction
- * will be committed, else the transaction will be automatically rolled-back
on error. The result
- * of the supplier lambda is returned if success, else the error will be
re-thrown.
- *
- * @param callCtx call context
- * @param transactionCode code of the transaction being executed, a supplier
lambda
- */
- public abstract <T> T runInReadTransaction(
- @Nonnull PolarisCallContext callCtx, @Nonnull Supplier<T>
transactionCode);
-
- /**
- * Run the specified transaction code (a runnable lambda type) in a database
read transaction. If
- * the code of the transaction does not throw any exception and returns
normally, the transaction
- * will be committed, else the transaction will be automatically rolled-back
on error.
- *
- * @param callCtx call context
- * @param transactionCode code of the transaction being executed, a runnable
lambda
- */
- public abstract void runActionInReadTransaction(
- @Nonnull PolarisCallContext callCtx, @Nonnull Runnable transactionCode);
+public abstract class AbstractTransactionalPersistence implements
TransactionalPersistence {
/** {@inheritDoc} */
@Override
@@ -153,16 +102,6 @@ public abstract class TransactionalPersistence implements
BasePersistence, Integ
protected abstract EntityNameLookupRecord lookupEntityActive(
@Nonnull PolarisCallContext callCtx, @Nonnull PolarisEntitiesActiveKey
entityActiveKey);
- /**
- * Lookup the specified set of entities by entityActiveKeys Return the
result, a parallel list of
- * active records. A record in that list will be null if its associated
lookup failed
- *
- * @return the list of entityActiveKeys for the specified lookup operation
- */
- @Nonnull
- public abstract List<EntityNameLookupRecord> lookupEntityActiveBatch(
- @Nonnull PolarisCallContext callCtx, List<PolarisEntitiesActiveKey>
entityActiveKeys);
-
/** {@inheritDoc} */
@Override
public void writeEntity(
@@ -253,7 +192,4 @@ public abstract class TransactionalPersistence implements
BasePersistence, Integ
*/
protected abstract void deleteFromEntitiesChangeTracking(
@Nonnull PolarisCallContext callCtx, @Nonnull PolarisEntityCore entity);
-
- /** Rollback the current transaction */
- public abstract void rollback();
}
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/PolarisTreeMapMetaStoreSessionImpl.java
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/PolarisTreeMapMetaStoreSessionImpl.java
index 312f3576..dbd2ce83 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/PolarisTreeMapMetaStoreSessionImpl.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/PolarisTreeMapMetaStoreSessionImpl.java
@@ -42,7 +42,7 @@ import
org.apache.polaris.core.storage.PolarisStorageConfigurationInfo;
import org.apache.polaris.core.storage.PolarisStorageIntegration;
import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider;
-public class PolarisTreeMapMetaStoreSessionImpl extends
TransactionalPersistence {
+public class PolarisTreeMapMetaStoreSessionImpl extends
AbstractTransactionalPersistence {
// the TreeMap store to use
private final PolarisTreeMapStore store;
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/TransactionalPersistence.java
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/TransactionalPersistence.java
index 856fc792..b594a7f1 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/TransactionalPersistence.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/TransactionalPersistence.java
@@ -19,14 +19,11 @@
package org.apache.polaris.core.persistence.transactional;
import jakarta.annotation.Nonnull;
-import jakarta.annotation.Nullable;
import java.util.List;
import java.util.function.Supplier;
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.PolarisEntitiesActiveKey;
-import org.apache.polaris.core.entity.PolarisEntityCore;
import org.apache.polaris.core.persistence.BasePersistence;
import org.apache.polaris.core.persistence.IntegrationPersistence;
@@ -35,7 +32,7 @@ import
org.apache.polaris.core.persistence.IntegrationPersistence;
* which can support a runInTransaction semantic, while providing default
implementations of some of
* the BasePersistence methods in terms of lower-level methods that subclasses
must implement.
*/
-public abstract class TransactionalPersistence implements BasePersistence,
IntegrationPersistence {
+public interface TransactionalPersistence extends BasePersistence,
IntegrationPersistence {
/**
* Run the specified transaction code (a Supplier lambda type) in a database
read/write
@@ -47,8 +44,7 @@ public abstract class TransactionalPersistence implements
BasePersistence, Integ
* @param callCtx call context
* @param transactionCode code of the transaction being executed, a supplier
lambda
*/
- public abstract <T> T runInTransaction(
- @Nonnull PolarisCallContext callCtx, @Nonnull Supplier<T>
transactionCode);
+ <T> T runInTransaction(@Nonnull PolarisCallContext callCtx, @Nonnull
Supplier<T> transactionCode);
/**
* Run the specified transaction code (a runnable lambda type) in a database
read/write
@@ -59,7 +55,7 @@ public abstract class TransactionalPersistence implements
BasePersistence, Integ
* @param callCtx call context
* @param transactionCode code of the transaction being executed, a runnable
lambda
*/
- public abstract void runActionInTransaction(
+ void runActionInTransaction(
@Nonnull PolarisCallContext callCtx, @Nonnull Runnable transactionCode);
/**
@@ -71,7 +67,7 @@ public abstract class TransactionalPersistence implements
BasePersistence, Integ
* @param callCtx call context
* @param transactionCode code of the transaction being executed, a supplier
lambda
*/
- public abstract <T> T runInReadTransaction(
+ <T> T runInReadTransaction(
@Nonnull PolarisCallContext callCtx, @Nonnull Supplier<T>
transactionCode);
/**
@@ -82,77 +78,9 @@ public abstract class TransactionalPersistence implements
BasePersistence, Integ
* @param callCtx call context
* @param transactionCode code of the transaction being executed, a runnable
lambda
*/
- public abstract void runActionInReadTransaction(
+ void runActionInReadTransaction(
@Nonnull PolarisCallContext callCtx, @Nonnull Runnable transactionCode);
- /** {@inheritDoc} */
- @Override
- public void writeEntities(
- @Nonnull PolarisCallContext callCtx,
- @Nonnull List<PolarisBaseEntity> entities,
- @Nullable List<PolarisBaseEntity> originalEntities) {
- throw new UnsupportedOperationException("Not yet implemented");
- }
-
- /** {@inheritDoc} */
- @Override
- public PolarisBaseEntity lookupEntityByName(
- @Nonnull PolarisCallContext callCtx,
- long catalogId,
- long parentId,
- int typeCode,
- @Nonnull String name) {
- // TODO: Consistently pull down the runInTransaction logic without running
into conflicting
- // nested transactions into here so that instead of having the caller be
responsible for
- // initiating the runInReadTransaction, we make this method call
inherently safe to do
- // the two-phase lookup.
- PolarisEntitiesActiveKey entityActiveKey =
- new PolarisEntitiesActiveKey(catalogId, parentId, typeCode, name);
-
- // ensure that the entity exists
- EntityNameLookupRecord entityActiveRecord = lookupEntityActive(callCtx,
entityActiveKey);
-
- // if not found, return null
- if (entityActiveRecord == null) {
- return null;
- }
-
- // lookup the entity, should be there
- PolarisBaseEntity entity =
- lookupEntity(callCtx, entityActiveRecord.getCatalogId(),
entityActiveRecord.getId());
- callCtx
- .getDiagServices()
- .checkNotNull(
- entity, "unexpected_not_found_entity", "entityActiveRecord={}",
entityActiveRecord);
-
- // return it now
- return entity;
- }
-
- /** {@inheritDoc} */
- @Override
- public EntityNameLookupRecord lookupEntityIdAndSubTypeByName(
- @Nonnull PolarisCallContext callCtx,
- long catalogId,
- long parentId,
- int typeCode,
- @Nonnull String name) {
- PolarisEntitiesActiveKey entityActiveKey =
- new PolarisEntitiesActiveKey(catalogId, parentId, typeCode, name);
- return lookupEntityActive(callCtx, entityActiveKey);
- }
-
- /**
- * Lookup an entity by entityActiveKey
- *
- * @param callCtx call context
- * @param entityActiveKey key by name
- * @return null if the specified entity does not exist or has been dropped.
- */
- @Nullable
- protected abstract EntityNameLookupRecord lookupEntityActive(
- @Nonnull PolarisCallContext callCtx, @Nonnull PolarisEntitiesActiveKey
entityActiveKey);
-
/**
* Lookup the specified set of entities by entityActiveKeys Return the
result, a parallel list of
* active records. A record in that list will be null if its associated
lookup failed
@@ -160,100 +88,9 @@ public abstract class TransactionalPersistence implements
BasePersistence, Integ
* @return the list of entityActiveKeys for the specified lookup operation
*/
@Nonnull
- public abstract List<EntityNameLookupRecord> lookupEntityActiveBatch(
+ List<EntityNameLookupRecord> lookupEntityActiveBatch(
@Nonnull PolarisCallContext callCtx, List<PolarisEntitiesActiveKey>
entityActiveKeys);
- /** {@inheritDoc} */
- @Override
- public void writeEntity(
- @Nonnull PolarisCallContext callCtx,
- @Nonnull PolarisBaseEntity entity,
- boolean nameOrParentChanged,
- @Nullable PolarisBaseEntity originalEntity) {
- // TODO: Pull down relevant compare-and-swap semantics from
PolarisMetaStoreManagerImpl
- // into this layer.
- writeToEntities(callCtx, entity);
- writeToEntitiesChangeTracking(callCtx, entity);
-
- if (nameOrParentChanged) {
- if (originalEntity != null) {
- // In our case, rename isn't automatically handled when the main
"entities" slice
- // is updated; instead we must explicitly remove from the old
entitiesActive
- // key as well.
- deleteFromEntitiesActive(callCtx, originalEntity);
- }
- writeToEntitiesActive(callCtx, entity);
- }
- }
-
- /**
- * Write the base entity to the entities table. If there is a conflict
(existing record with the
- * same id), all attributes of the new record will replace the existing one.
- *
- * @param callCtx call context
- * @param entity entity record to write, potentially replacing an existing
entity record with the
- * same key
- */
- protected abstract void writeToEntities(
- @Nonnull PolarisCallContext callCtx, @Nonnull PolarisBaseEntity entity);
-
- /**
- * Write the base entity to the entities_active table. If there is a
conflict (existing record
- * with the same PK), all attributes of the new record will replace the
existing one.
- *
- * @param callCtx call context
- * @param entity entity record to write, potentially replacing an existing
entity record with the
- * same key
- */
- protected abstract void writeToEntitiesActive(
- @Nonnull PolarisCallContext callCtx, @Nonnull PolarisBaseEntity entity);
-
- /**
- * Write the base entity to the entities change tracking table. If there is
a conflict (existing
- * record with the same id), all attributes of the new record will replace
the existing one.
- *
- * @param callCtx call context
- * @param entity entity record to write, potentially replacing an existing
entity record with the
- * same key
- */
- protected abstract void writeToEntitiesChangeTracking(
- @Nonnull PolarisCallContext callCtx, @Nonnull PolarisBaseEntity entity);
-
- /** {@inheritDoc} */
- @Override
- public void deleteEntity(@Nonnull PolarisCallContext callCtx, @Nonnull
PolarisBaseEntity entity) {
- deleteFromEntitiesActive(callCtx, entity);
- deleteFromEntities(callCtx, entity);
- deleteFromEntitiesChangeTracking(callCtx, entity);
- }
-
- /**
- * Delete the base entity from the entities table.
- *
- * @param callCtx call context
- * @param entity entity record to delete
- */
- protected abstract void deleteFromEntities(
- @Nonnull PolarisCallContext callCtx, @Nonnull PolarisEntityCore entity);
-
- /**
- * Delete the base entity from the entities_active table.
- *
- * @param callCtx call context
- * @param entity entity record to delete
- */
- protected abstract void deleteFromEntitiesActive(
- @Nonnull PolarisCallContext callCtx, @Nonnull PolarisEntityCore entity);
-
- /**
- * Delete the base entity from the entities change tracking table
- *
- * @param callCtx call context
- * @param entity entity record to delete
- */
- protected abstract void deleteFromEntitiesChangeTracking(
- @Nonnull PolarisCallContext callCtx, @Nonnull PolarisEntityCore entity);
-
/** Rollback the current transaction */
- public abstract void rollback();
+ void rollback();
}
