mirror of
https://github.com/datahub-project/datahub.git
synced 2025-11-03 20:27:50 +00:00
1283dd3ff4
Use the automated tool in https://linkedin.github.io/rest.li/pdl_migration Also update all relevant docs
60 lines
2.3 KiB
Markdown
60 lines
2.3 KiB
Markdown
# What is a metadata delta?
|
||
|
||
Rest.li supports [partial update](https://linkedin.github.io/rest.li/user_guide/restli_server#partial_update) natively without needing explicitly defined models.
|
||
However, the granularity of update is always limited to each field in a PDL model.
|
||
There are cases where the update need to happen at an even finer grain, e.g. adding or removing items from an array.
|
||
|
||
To this end, we’re proposing the following entity-specific metadata delta model that allows atomic partial updates at any desired granularity.
|
||
Note that:
|
||
1. Just like metadata [aspects](aspect.md), we’re not imposing any limit on the partial update model, as long as it’s a valid PDL record.
|
||
This is because the rest.li endpoint will have the logic that performs the corresponding partial update based on the information in the model.
|
||
That said, it’s common to have fields that denote the list of items to be added or removed (e.g. `membersToAdd` & `membersToRemove` from below)
|
||
2. Similar to metadata [snapshots](snapshot.md), entity that supports metadata delta will add an entity-specific metadata delta
|
||
(e.g. `GroupDelta` from below) that unions all supported partial update models.
|
||
3. The entity-specific metadata delta is then added to the global `Delta` typeref, which is added as part of [Metadata Change Event](mxe.md#metadata-change-event-mce) and used during [Metadata Ingestion](../architecture/metadata-ingestion.md).
|
||
|
||
```
|
||
namespace com.linkedin.group
|
||
|
||
import com.linkedin.common.CorpuserUrn
|
||
|
||
/**
|
||
* A metadata delta for a specific group entity
|
||
*/
|
||
record MembershipPartialUpdate {
|
||
|
||
/** List of members to be added to the group */
|
||
membersToAdd: array[CorpuserUrn]
|
||
|
||
/** List of members to be removed from the group */
|
||
membersToRemove: array[CorpuserUrn]
|
||
}
|
||
```
|
||
|
||
```
|
||
namespace com.linkedin.metadata.delta
|
||
|
||
import com.linkedin.common.CorpGroupUrn
|
||
import com.linkedin.group.MembershipPartialUpdate
|
||
|
||
/**
|
||
* A metadata delta for a specific group entity
|
||
*/
|
||
record GroupDelta {
|
||
|
||
/** URN for the entity the metadata delta is associated with */
|
||
urn: CorpGroupUrn
|
||
|
||
/** The specific type of metadata delta to apply */
|
||
delta: union[MembershipPartialUpdate]
|
||
}
|
||
```
|
||
|
||
```
|
||
namespace com.linkedin.metadata.delta
|
||
|
||
/**
|
||
* A union of all supported metadata delta types.
|
||
*/
|
||
typeref Delta = union[GroupDelta]
|
||
``` |