Class RecordCloneEngine

Index

Constructors

Accessors

Methods

Clone Describe GetLineage Plan

Constructors

constructor

new RecordCloneEngine(provider?: IMetadataProvider): RecordCloneEngine
Parameters
- Optionalprovider: IMetadataProvider
Returns RecordCloneEngine
- Defined in RecordCloning/engine/src/RecordCloneEngine.ts:26

Accessors

`Protected`Provider

get Provider(): IMetadataProvider
Returns IMetadataProvider
- Defined in RecordCloning/engine/src/RecordCloneEngine.ts:33

Methods

Clone

Clone(request: RecordCloneRequest, user: UserInfo): Promise<RecordCloneResult>
Plans and executes a clone. With Options.DryRun it stops after planning and returns the plan, writing nothing.
Parameters
- request: RecordCloneRequest
- user: UserInfo
Returns Promise<RecordCloneResult>
- Defined in RecordCloning/engine/src/RecordCloneEngine.ts:41

Describe

Describe(
    entityName: string,
    user: UserInfo,
    key?: RecordCloneKey,
): Promise<RecordCloneDescribeOutput>
Inspects clone capabilities and policies for an entity or record.
Parameters
- entityName: string
- user: UserInfo
- Optionalkey: RecordCloneKey
Returns Promise<RecordCloneDescribeOutput>
- Defined in RecordCloning/engine/src/RecordCloneEngine.ts:67

GetLineage

GetLineage(
    entityName: string,
    key: RecordCloneKey,
    user: UserInfo,
    direction?: "up" | "down" | "both",
): Promise<RecordCloneGetLineageOutput>
Traverses record links to find clone ancestors and descendants.
Parameters
- entityName: string
- key: RecordCloneKey
- user: UserInfo
- Optionaldirection: "up" | "down" | "both"
Returns Promise<RecordCloneGetLineageOutput>
- Defined in RecordCloning/engine/src/RecordCloneEngine.ts:74

Plan

Plan(request: RecordCloneRequest, user: UserInfo): Promise<ClonePlan>
Computes a clone execution plan without executing changes.
Parameters
- request: RecordCloneRequest
- user: UserInfo
Returns Promise<ClonePlan>
- Defined in RecordCloning/engine/src/RecordCloneEngine.ts:60