Skip to content

Updating method for create(), update() and delete() to handle soft delete by setting deleted_ts #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kotkar-pallavi merged 4 commits into from
Jul 8, 2025
Merged

Updating method for create(), update() and delete() to handle soft delete by setting deleted_ts #549

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eec50f8
Updating method for create(), update() and delete() to handle soft de…
kotkar-pallavi Jun 19, 2025
746c801
Updating unit test to delete asset with 2 aspects
kotkar-pallavi Jun 20, 2025
798c7af
Improving unit test
kotkar-pallavi Jun 20, 2025
01f8f52
Updating javadoc and inline comments
kotkar-pallavi Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 42 additions & 66 deletions dao-api/src/main/java/com/linkedin/metadata/dao/BaseLocalDAO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,7 @@ <ASPECT_UNION extends RecordTemplate> URN createAspectsWithCallbacks(@Nonnull UR
boolean isTestModeFalseForAll = aspectCreateLambdas.stream().filter(aspectCreateLambda -> aspectCreateLambda.getIngestionParams().isTestMode()).collect(
Collectors.toList()).isEmpty();

int numRows = createNewAspect(urn, aspectCreateLambdas, aspectValues, auditStamp, trackingContext, isTestModeFalseForAll);
int numRows = createNewAssetWithAspects(urn, aspectCreateLambdas, aspectValues, auditStamp, trackingContext, isTestModeFalseForAll);
for (RecordTemplate aspectValue : aspectValues) {
// For each aspect, we need to trigger emit MAE
// In new asset creation, old value is null
Expand Down Expand Up @@ -979,54 +979,6 @@ public <ASPECT extends RecordTemplate> URN create(@Nonnull URN urn,
);
}

/**
* The common method that can be used for both: deletion of aspects and entity.
*
* @param urn the URN for the entity the aspects are attached to
* @param aspectClasses Aspect Classes of the aspects being deleted, must be supported aspect types in
* {@code ASPECT_UNION}
* @param auditStamp the audit stamp of this action
* @param trackingContext the tracking context for the operation
* @param ingestionParams ingestion parameters
* @param deleteAll if true, delete the entire asset, else mark aspects as deleted iteratively in a
* transaction
* @param maxTransactionRetry maximum number of transaction retries before throwing an exception
* @return a collection of the deleted aspects (their value before deletion), each wrapped in an instance of
* {@link ASPECT_UNION}
*/
protected Collection<ASPECT_UNION> deleteCommon(@Nonnull URN urn,
Copy link
Copy Markdown
Contributor Author

@kotkar-pallavi kotkar-pallavi Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deleting this, because reusing the delete() implementation for deleting all aspects (this)
instead of doing Hard Asset deletion (deleting entire row)

@Nonnull Set<Class<? extends RecordTemplate>> aspectClasses,
@Nonnull AuditStamp auditStamp, int maxTransactionRetry,
@Nullable IngestionTrackingContext trackingContext,
@Nullable IngestionParams ingestionParams,
boolean deleteAll) {

// TODO: Handle pre-deletion callbacks if any

// If deleteAll is true, delete entire asset, else mark aspects as deleted iteratively in a transaction
if (deleteAll) {
Map<Class<? extends RecordTemplate>, Optional<? extends RecordTemplate>>
results = permanentDelete(urn, aspectClasses, auditStamp, maxTransactionRetry, trackingContext, ingestionParams.isTestMode());
Collection<RecordTemplate> deletedAspects = new ArrayList<>();
results.forEach((key, value) -> {
// Check if aspect value present to avoid null pointer exception
if (value.isPresent()) {
DeleteResult deleteResult = new DeleteResult(value.get(), key);
deletedAspects.add(unwrapDeleteResult(urn, deleteResult, auditStamp, trackingContext, ChangeType.DELETE_ALL));
}
});

return deletedAspects.stream()
.filter(Objects::nonNull)
.map(x -> ModelUtils.newEntityUnion(_aspectUnionClass, x)).collect(Collectors.toList());
} else {
// TODO: delete aspects implementation can be moved here instead of in addCommon()
// Add common method should be used only for create and update
return Collections.emptyList();
}

//TODO: Handle post-ingestion callbacks if any
}

/**
* Delete asset and all its aspects atomically.
Expand Down Expand Up @@ -1093,9 +1045,37 @@ public Collection<ASPECT_UNION> deleteAll(@Nonnull URN urn,
int maxTransactionRetry,
@Nullable IngestionTrackingContext trackingContext,
@Nullable IngestionParams ingestionParams) {

IngestionParams nonNullIngestionParams = ingestionParams == null
? new IngestionParams().setIngestionMode(IngestionMode.LIVE).setTestMode(false) : ingestionParams;
return deleteCommon(urn, aspectClasses, auditStamp, maxTransactionRetry, trackingContext, nonNullIngestionParams, true);

final Map<Class<?>, RecordTemplate> results = new HashMap<>();
runInTransactionWithRetry(() -> {
Map<Class<?>, RecordTemplate> deletedAspects = new HashMap<>();
aspectClasses.forEach(aspectClass -> {
try {
RecordTemplate deletedAspect = delete(urn, aspectClass, auditStamp, maxTransactionRetry, trackingContext);
results.put(aspectClass, deletedAspect);
} catch (NullPointerException e) {
log.warn("Aspect {} for urn {} does not exist", aspectClass.getName(), urn);
}
Comment on lines +1058 to +1060
Copy link
Copy Markdown
Contributor

@jphui jphui Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this throw on both:

  1. aspect class is not a supported aspect of the asset type?
  2. aspect class is empty in the db?

Copy link
Copy Markdown
Contributor Author

@kotkar-pallavi kotkar-pallavi Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. i think aspect class not supported aspect of the asset type will throw a ModelValidationException from here: SQLSchemaUtils.java#L225

  2. it will handle aspect class empty in db.
    this scenario is possible for delete asset - user does not specify any aspect names, at service level we populate all aspect class names for delete call.

});

permanentDelete(urn, nonNullIngestionParams.isTestMode());
return results;
}, maxTransactionRetry);


Collection<RecordTemplate> deletedAspects = new ArrayList<>();
results.forEach((key, value) -> {
// Check if aspect value present to avoid null pointer exception
DeleteResult deleteResult = new DeleteResult(value, key);
deletedAspects.add(unwrapDeleteResult(urn, deleteResult, auditStamp, trackingContext, ChangeType.DELETE_ALL));
Copy link
Copy Markdown
Contributor

@jphui jphui Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few questions / checks:

  1. seems there's a TODO related to this: https://jarvis.corp.linkedin.com/codesearch/result/?name=KafkaMetadataEventProducerUtil.java&path=metadata-models%2Fmetadata-dao-impl%2Fkafka-producer%2Fsrc%2Fmain%2Fjava%2Fcom%2Flinkedin%2Fmetadata%2Fdao%2Fproducer&reponame=linkedin-multiproduct%2Fmetadata-models#99
  • are there any remaining AI's here that could affect this impl?
  1. I notice the implementation for unwrapDeleteResult() is different for the emission: https://jarvis.corp.linkedin.com/codesearch/result/?name=BaseLocalDAO.java&path=datahub-gma%2Fdao-api%2Fsrc%2Fmain%2Fjava%2Fcom%2Flinkedin%2Fmetadata%2Fdao&reponame=linkedin%2Fdatahub-gma#819
  • is it OK there is no equality check?

Copy link
Copy Markdown
Contributor Author

@kotkar-pallavi kotkar-pallavi Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I think that TODO is more for ChangeType.DELETE_ALL vs DELETE. This was related to previous Delete impl when we were doing a hard delete. I will remove that TODO, it is not relevant anymore.

  2. We are using unwrapDeleteResult to send events to HS to delete entire document. So i think with the ChangeType.DELETE_ALL we do not need to compare old and new value. please let me know if I am missing something.

});

return deletedAspects.stream()
.filter(Objects::nonNull)
.map(x -> ModelUtils.newEntityUnion(_aspectUnionClass, x)).collect(Collectors.toList());
}

/**
Expand Down Expand Up @@ -1353,24 +1333,20 @@ protected abstract <ASPECT extends RecordTemplate> long saveLatest(@Nonnull URN
@Nullable ASPECT newEntry, @Nonnull AuditStamp newAuditStamp, boolean isSoftDeleted,
@Nullable IngestionTrackingContext trackingContext, boolean isTestMode);

protected abstract <ASPECT_UNION extends RecordTemplate> int createNewAspect(@NonNull URN urn,
protected abstract <ASPECT_UNION extends RecordTemplate> int createNewAssetWithAspects(@NonNull URN urn,
@Nonnull List<AspectCreateLambda<? extends RecordTemplate>> aspectCreateLambdas,
@Nonnull List<? extends RecordTemplate> aspectValues, @Nonnull AuditStamp newAuditStamp,
@Nullable IngestionTrackingContext trackingContext, boolean isTestMode);

/**
* Permanently deletes the entity from the table.
* @param urn the URN for the entity the aspect is attached to
* @param aspectClasses Aspect Classes of the aspects being deleted, must be supported aspect types in {@code ASPECT_UNION}
* @param auditStamp the audit stamp of this action
* @param maxTransactionRetry maximum number of transaction retries before throwing an exception
* @param trackingContext the tracking context for the operation
*
* @param urn the URN for the entity the aspect is attached to
* @param isTestMode whether the test mode is enabled or not
* @return a map of the deleted aspects (their value before deletion), each wrapped in an instance of {@link ASPECT_UNION}
* @return a map of the deleted aspects (their value before deletion), each wrapped in an instance of
* {@link ASPECT_UNION}
*/
protected abstract Map<Class<? extends RecordTemplate>, Optional<? extends RecordTemplate>> permanentDelete(@Nonnull URN urn,
@Nonnull Set<Class<? extends RecordTemplate>> aspectClasses, @Nullable AuditStamp auditStamp,
int maxTransactionRetry, @Nullable IngestionTrackingContext trackingContext, boolean isTestMode);
protected abstract int permanentDelete(@Nonnull URN urn, boolean isTestMode);
Copy link
Copy Markdown
Contributor

@jphui jphui Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update documentation here

Copy link
Copy Markdown
Contributor

@jphui jphui Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's the reasoning behind changing the return type from object to int? what does this help achieve?

Copy link
Copy Markdown
Contributor Author

@kotkar-pallavi kotkar-pallavi Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now, in permanent delete we will only be marking the asset as deleted by setting deleted_ts=NOW(). actual aspect level (sofl) deletion happens in BaseLocalDao.deleteAll() and the map of aspect objects will be returned from there.

here int is for retuning how many db rows were updated (techincally will olways be 1 since 1row=1asset record).


/**
* Saves the new value of an aspect to entity tables. This is used when backfilling metadata from the old schema to
Expand Down Expand Up @@ -1585,13 +1561,13 @@ protected abstract <ASPECT extends RecordTemplate> void insert(@Nonnull URN urn,
/**
* Update an aspect for an entity with specific version and {@link AuditStamp} with optimistic locking.
*
* @param urn {@link Urn} for the entity
* @param value the aspect to update
* @param aspectClass the type of aspect to update
* @param urn {@link Urn} for the entity
* @param value the aspect to update
* @param aspectClass the type of aspect to update
* @param newAuditStamp the {@link AuditStamp} for the new aspect
* @param version the version for the aspect
* @param oldTimestamp the timestamp for the old aspect
* @param isTestMode whether the test mode is enabled or not
* @param version the version for the aspect
* @param oldTimestamp the timestamp for the old aspect
* @param isTestMode whether the test mode is enabled or not
*/
protected abstract <ASPECT extends RecordTemplate> void updateWithOptimisticLocking(@Nonnull URN urn,
@Nullable RecordTemplate value, @Nonnull Class<ASPECT> aspectClass, @Nonnull AuditStamp newAuditStamp,
Expand Down
39 changes: 4 additions & 35 deletions dao-api/src/test/java/com/linkedin/metadata/dao/BaseLocalDAOTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
import com.linkedin.metadata.dao.retention.VersionBasedRetention;
import com.linkedin.metadata.dao.tracking.BaseTrackingManager;
import com.linkedin.metadata.dao.urnpath.EmptyPathExtractor;
import com.linkedin.metadata.events.ChangeType;
import com.linkedin.metadata.events.IngestionMode;
import com.linkedin.metadata.events.IngestionTrackingContext;
import com.linkedin.metadata.internal.IngestionParams;
Expand All @@ -35,10 +34,8 @@
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
Expand Down Expand Up @@ -95,21 +92,17 @@ protected <ASPECT extends RecordTemplate> long saveLatest(FooUrn urn, Class<ASPE
}

@Override
protected <ASPECT_UNION extends RecordTemplate> int createNewAspect(@Nonnull FooUrn urn,
protected <ASPECT_UNION extends RecordTemplate> int createNewAssetWithAspects(@Nonnull FooUrn urn,
@Nonnull List<AspectCreateLambda<? extends RecordTemplate>> aspectCreateLambdas,
@Nonnull List<? extends RecordTemplate> aspectValues, @Nonnull AuditStamp newAuditStamp,
@Nullable IngestionTrackingContext trackingContext, boolean isTestMode) {
return aspectValues.size();
}

@Override
protected Map<Class<? extends RecordTemplate>, Optional<? extends RecordTemplate>> permanentDelete(@Nonnull FooUrn urn,
@Nonnull Set<Class<? extends RecordTemplate>> aspectClasses, @Nullable AuditStamp auditStamp,
int maxTransactionRetry, @Nullable IngestionTrackingContext trackingContext, boolean isTestMode) {
Map<Class<? extends RecordTemplate>, Optional<? extends RecordTemplate>> result = new HashMap<>();
result.put(AspectFoo.class, Optional.of(new AspectFoo().setValue("foo")));
result.put(AspectBar.class, Optional.of(new AspectBar().setValue("bar")));
return result;
protected int permanentDelete(@Nonnull FooUrn urn, boolean isTestMode) {
// 1 aspect is deleted: 1 row in table
return 1;
}

@Override
Expand Down Expand Up @@ -741,30 +734,6 @@ public void testCreateAspectWithCallbacks() throws URISyntaxException {
verifyNoMoreInteractions(_mockEventProducer);
}

@Test
public void testDeleteAll() throws URISyntaxException {
// Set-up test data
FooUrn urn = new FooUrn(1);
RecordTemplate foo = new AspectFoo().setValue("foo");
RecordTemplate bar = new AspectBar().setValue("bar");

Set<Class<? extends RecordTemplate>> aspectsClasses = new HashSet<>();
aspectsClasses.add(AspectFoo.class);
aspectsClasses.add(AspectBar.class);

Collection<EntityAspectUnion> results = _dummyLocalDAO.deleteAll(urn, aspectsClasses, _dummyAuditStamp);
assertEquals(results.size(), 2);
results.forEach(result -> {
assertNotNull(result);
assertTrue(result.isAspectBar() || result.isAspectFoo());
});
verify(_mockEventProducer, times(1))
.produceAspectSpecificMetadataAuditEvent(urn, foo, null, AspectFoo.class, _dummyAuditStamp, IngestionMode.LIVE, ChangeType.DELETE_ALL);
verify(_mockEventProducer, times(1))
.produceAspectSpecificMetadataAuditEvent(urn, bar, null, AspectBar.class, _dummyAuditStamp, IngestionMode.LIVE, ChangeType.DELETE_ALL);
verifyNoMoreInteractions(_mockEventProducer);
}

@Test
public void testMAEEmissionForAspectCallbackHelper() throws URISyntaxException {
FooUrn urn = new FooUrn(1);
Expand Down
39 changes: 28 additions & 11 deletions dao-impl/ebean-dao/src/main/java/com/linkedin/metadata/dao/EbeanLocalAccess.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ public void ensureSchemaUpToDate() {
@Transactional
public <ASPECT extends RecordTemplate> int add(@Nonnull URN urn, @Nullable ASPECT newValue, @Nonnull Class<ASPECT> aspectClass,
@Nonnull AuditStamp auditStamp, @Nullable IngestionTrackingContext ingestionTrackingContext, boolean isTestMode) {
return addWithOptimisticLocking(urn, newValue, aspectClass, auditStamp, null, ingestionTrackingContext, isTestMode);
return addWithOptimisticLocking(urn, newValue, aspectClass, auditStamp, null, ingestionTrackingContext,
isTestMode, true);
}

@Override
Expand All @@ -111,7 +112,7 @@ public <ASPECT extends RecordTemplate> int addWithOptimisticLocking(
@Nonnull AuditStamp auditStamp,
@Nullable Timestamp oldTimestamp,
@Nullable IngestionTrackingContext ingestionTrackingContext,
boolean isTestMode) {
boolean isTestMode, boolean softDeleteOverwrite) {

final long timestamp = auditStamp.hasTime() ? auditStamp.getTime() : System.currentTimeMillis();
final String actor = auditStamp.hasActor() ? auditStamp.getActor().toString() : DEFAULT_ACTOR;
Expand All @@ -121,7 +122,7 @@ public <ASPECT extends RecordTemplate> int addWithOptimisticLocking(
final SqlUpdate sqlUpdate;
if (oldTimestamp != null) {
sqlUpdate = _server.createSqlUpdate(
SQLStatementUtils.createAspectUpdateWithOptimisticLockSql(urn, aspectClass, urnExtraction, isTestMode));
SQLStatementUtils.createAspectUpdateWithOptimisticLockSql(urn, aspectClass, urnExtraction, isTestMode, softDeleteOverwrite));
sqlUpdate.setParameter("oldTimestamp", oldTimestamp.toString());
} else {
sqlUpdate = _server.createSqlUpdate(SQLStatementUtils.createAspectUpsertSql(urn, aspectClass, urnExtraction, isTestMode));
Expand Down Expand Up @@ -223,11 +224,25 @@ public <ASPECT_UNION extends RecordTemplate> int create(
}
}
insertIntoSql.append(CLOSING_BRACKET);
insertSqlValues.append(CLOSING_BRACKET_WITH_SEMICOLON);
insertSqlValues.append(CLOSING_BRACKET);

// Construct DELETED_TS_CHECK_FOR_CREATE String
StringBuilder deletedTsCheckForCreate = new StringBuilder();
deletedTsCheckForCreate.append(DELETED_TS_DUPLICATE_KEY_CHECK);
for (int i = 0; i < classNames.size(); i++) {
deletedTsCheckForCreate.append(getAspectColumnName(urn.getEntityType(), classNames.get(i)));
deletedTsCheckForCreate.append(" = :aspect").append(i);
if (i != classNames.size() - 1) {
deletedTsCheckForCreate.append(", ");
}
}
Comment on lines +234 to +238
Copy link
Copy Markdown
Contributor

@jphui jphui Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this for loop tested in unit testing at all? (is it easy to test?)

Copy link
Copy Markdown
Contributor Author

@kotkar-pallavi kotkar-pallavi Jun 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good callout. this code will be used when more than asset with more than 1 aspect is being in created.
Updated test testCreateAfterAssetMarkedDeleted to create asset with 2 aspects and verify both aspect values with get.

sample vale from unit test:

INSERT INTO metadata_entity_foo (urn, a_urn, lastmodifiedon, lastmodifiedby,a_aspectfoo, a_aspectbar) 
VALUES (:urn, :a_urn, :lastmodifiedon, :lastmodifiedby,:aspect0, :aspect1) 
ON DUPLICATE KEY UPDATE a_aspectfoo = :aspect0, a_aspectbar = :aspect1, deleted_ts = 
    IF(deleted_ts IS NULL, CAST('DuplicateKeyException' AS UNSIGNED), NULL);

deletedTsCheckForCreate.append(DELETED_TS_CONDITIONAL_VALUE_SET);

// Build the final insert statement
// For example: INSERT INTO <table_name> (<columns>) VALUES (<values>);
String insertStatement = insertIntoSql.toString() + insertSqlValues.toString();
String insertStatement = insertIntoSql.toString() + insertSqlValues.toString() + deletedTsCheckForCreate.toString();


insertStatement = String.format(insertStatement, getTableName(urn));

sqlUpdate = _server.createSqlUpdate(insertStatement);
Expand All @@ -247,6 +262,7 @@ public <ASPECT_UNION extends RecordTemplate> int create(
sqlUpdate.setParameter("aspect" + i, toJsonString(auditedAspect));
}


// If a non-default UrnPathExtractor is provided, the user MUST specify in their schema generation scripts
// 'ALTER TABLE <table> ADD COLUMN a_urn JSON'.
if (urnExtraction) {
Expand Down Expand Up @@ -303,16 +319,17 @@ public <ASPECT extends RecordTemplate> List<EbeanMetadataAspect> batchGetUnion(
}

/**
* Delete all aspects + urn for the given urn.
* By this time pre-deletion hooks should be processed.
* Old values are not needed for delete, But should be retrieved and used for in post-update hooks if needed.
* @param urn {@link Urn} for the entity
* Delete all aspects + urn for the given urn. By this time pre-deletion hooks should be processed. Old values are not
* needed for delete, But should be retrieved and used for in post-update hooks if needed.
*
* @param urn {@link Urn} for the entity
* @param isTestMode whether the operation is in test mode or not
* @return number of rows deleted.
*/
@Override
public int deleteAll(@Nonnull URN urn, boolean isTestMode) {
final String deleteSqlStatement = SQLStatementUtils.createDeleteAssetSql(urn, isTestMode);
public int softDeleteAsset(@Nonnull URN urn, boolean isTestMode) {
// Update this to mark deleted_TS to NOW based on URN
final String deleteSqlStatement = SQLStatementUtils.createSoftDeleteAssetSql(urn, isTestMode);
return _server.createSqlUpdate(deleteSqlStatement).execute();
}

Expand Down
25 changes: 9 additions & 16 deletions dao-impl/ebean-dao/src/main/java/com/linkedin/metadata/dao/EbeanLocalDAO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,31 +656,24 @@ protected <ASPECT extends RecordTemplate> long saveLatest(@Nonnull URN urn, @Non
* @return the number of rows inserted
*/
@Override
protected <ASPECT_UNION extends RecordTemplate> int createNewAspect(@Nonnull URN urn,
protected <ASPECT_UNION extends RecordTemplate> int createNewAssetWithAspects(@Nonnull URN urn,
@Nonnull List<AspectCreateLambda<? extends RecordTemplate>> aspectCreateLambdas,
@Nonnull List<? extends RecordTemplate> aspectValues, @Nonnull AuditStamp newAuditStamp,
@Nullable IngestionTrackingContext trackingContext, boolean isTestMode) {
return runInTransactionWithRetry(() ->
// do a get to ensure the urn does not already exist
// if exists and deletedTs is null, then throw an exception
// if exists and deletedTs is not null, then update the deletedTs to null and create records
Copy link
Copy Markdown
Contributor

@jphui jphui Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the inline doc! is this just explaining what the next line "create" will do?

Copy link
Copy Markdown
Contributor Author

@kotkar-pallavi kotkar-pallavi Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, describing high level behavior for create.
i added some comments closer to impl in EBeanLocalAccess.create

_localAccess.create(urn, aspectValues, aspectCreateLambdas, newAuditStamp, trackingContext, isTestMode), 1);
}

@Override
protected Map<Class<? extends RecordTemplate>, Optional<? extends RecordTemplate>> permanentDelete(@Nonnull URN urn,
@Nonnull Set<Class<? extends RecordTemplate>> aspectClasses, @Nullable AuditStamp auditStamp,
int maxTransactionRetry, @Nullable IngestionTrackingContext trackingContext, boolean isTestMode) {
protected int permanentDelete(@Nonnull URN urn, boolean isTestMode) {
// If the table does not have the URN, return empty map. Nothing to delete here.
if (!exists(urn)) {
return Collections.emptyMap();
return 0;
}
// If the table has the URN, get the asset record, including all the aspects.
// This will be used to delete to return deleted record info in the API.
Map<Class<? extends RecordTemplate>, Optional<? extends RecordTemplate>> deletedAspects = new HashMap<>();
aspectClasses.forEach(aspectClass -> deletedAspects.put(aspectClass, Optional.ofNullable(getLatest(urn, aspectClass, isTestMode).getAspect())));
// Perform deletion using urn and return the previously retrieved record.
return runInTransactionWithRetry(() -> {
_localAccess.deleteAll(urn, isTestMode);
return deletedAspects;
}, maxTransactionRetry);
return _localAccess.softDeleteAsset(urn, isTestMode);
}

@Override
Expand Down Expand Up @@ -879,7 +872,7 @@ protected <ASPECT extends RecordTemplate> void updateWithOptimisticLocking(@Nonn
// Note: when cold-archive is enabled, this method: updateWithOptimisticLocking will not be called.
_server.execute(oldSchemaSqlUpdate);
return _localAccess.addWithOptimisticLocking(urn, (ASPECT) value, aspectClass, newAuditStamp, oldTimestamp,
trackingContext, isTestMode);
trackingContext, isTestMode, true);
}, 1);
} else {
// In OLD_SCHEMA and DUAL_SCHEMA mode, the aspect table is the SOT and the getLatest (oldTimestamp) is from the aspect table.
Expand All @@ -889,7 +882,7 @@ protected <ASPECT extends RecordTemplate> void updateWithOptimisticLocking(@Nonn
// Additionally, in DUAL_SCHEMA mode: apply a regular update (no optimistic locking) to the entity table
if (_schemaConfig == SchemaConfig.DUAL_SCHEMA) {
_localAccess.addWithOptimisticLocking(urn, (ASPECT) value, aspectClass, newAuditStamp, null,
trackingContext, isTestMode);
trackingContext, isTestMode, false);
}
return _server.execute(oldSchemaSqlUpdate);
}, 1);
Expand Down
Loading