Class DatapackComparer

Compares datapacks against the data in a target org without deploying them. The comparison reports per datapack root whether the datapack is in sync with the target org and how it mismatches:

Records that can be identified through their matching key configuration are compared field-by-field using the same delta check that is used by DatapackDeploymentOptions.deltaCheck.
Embedded child records without a matching key -- which a deployment would delete and recreate -- are matched against the org records under the same parent by comparing the record data; when no org record matches, the exact record data that is missing is reported.
Fields in the target org that are not part of the datapack are ignored, as are datapack fields that cannot be mapped to a field in the target org.

Index

Constructors

constructor

new DatapackComparer(
    deployer: DatapackDeployer,
    recordComparer: OrgRecordComparer,
    salesforceService: SalesforceService,
    logger: Logger,
): DatapackComparer
Parameters
- deployer: DatapackDeployer
- recordComparer: OrgRecordComparer
- salesforceService: SalesforceService
- logger: Logger
Returns DatapackComparer
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:191

Properties

`Private` `Readonly`deployer

deployer: DatapackDeployer

`Private` `Readonly`logger

logger: Logger

`Private` `Readonly`recordComparer

recordComparer: OrgRecordComparer

`Private` `Readonly`salesforceService

salesforceService: SalesforceService

`Private` `Static` `Readonly`deployActions

deployActions: Record<DatapackRecordSyncState, DatapackRecordDeployAction> = ...

Methods

`Private`buildDatapackResult

buildDatapackResult(
    group: DatapackDeploymentRecordGroup,
    outcomes: Map<string, RecordMatchOutcome>,
    orgStatuses: Map<string, OrgRecordStatus>,
    extraOrgRecords: DatapackComparisonExtraRecord[],
): Promise<DatapackComparisonStatus>
Parameters
- group: DatapackDeploymentRecordGroup
- outcomes: Map<string, RecordMatchOutcome>
- orgStatuses: Map<string, OrgRecordStatus>
- extraOrgRecords: DatapackComparisonExtraRecord[]
Returns Promise<DatapackComparisonStatus>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:550

`Private`buildRecordResult

buildRecordResult(
    record: DatapackDeploymentRecord,
    outcomes: Map<string, RecordMatchOutcome>,
    orgStatuses: Map<string, OrgRecordStatus>,
): Promise<DatapackRecordComparisonResult>
Parameters
- record: DatapackDeploymentRecord
- outcomes: Map<string, RecordMatchOutcome>
- orgStatuses: Map<string, OrgRecordStatus>
Returns Promise<DatapackRecordComparisonResult>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:595

`Private`buildResult

buildResult(
    deployment: DatapackDeployment,
    outcomes: Map<string, RecordMatchOutcome>,
    orgStatuses: Map<string, OrgRecordStatus>,
): Promise<DatapackComparisonResult>
Parameters
- deployment: DatapackDeployment
- outcomes: Map<string, RecordMatchOutcome>
- orgStatuses: Map<string, OrgRecordStatus>
Returns Promise<DatapackComparisonResult>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:495

compare

compare(
    datapacks: VlocityDatapack[],
    options?: DatapackComparerOptions,
    cancelToken?: CancellationToken,
): Promise<DatapackComparisonResult>
Compare the specified datapacks against the data in the target org.
Parameters
- datapacks: VlocityDatapack[]
  Datapacks to compare
- Optionaloptions: DatapackComparerOptions
  Options controlling the datapack to record conversion; deployment only options are ignored
- OptionalcancelToken: CancellationToken
  An optional cancellation token to abort the comparison
Returns Promise<DatapackComparisonResult>
Comparison result with per datapack root details on how the datapack compares to the target org
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:206

compareDeployment

compareDeployment(
    deployment: DatapackDeployment,
    options?: DatapackComparerOptions,
    cancelToken?: CancellationToken,
): Promise<DatapackComparisonResult>
Compare the converted records of an existing deployment against the target org. This is used by delta deployments to reuse the bulk comparison as their input without converting the datapacks a second time.
Parameters
- deployment: DatapackDeployment
  Deployment containing the converted records to compare
- Optionaloptions: DatapackComparerOptions
  Options controlling bulk extraction and progress reporting
- OptionalcancelToken: CancellationToken
  An optional cancellation token to abort the comparison
Returns Promise<DatapackComparisonResult>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:222

`Private`compareMatchedRecords

compareMatchedRecords(
    records: DatapackDeploymentRecord[],
    store: OrgDataStore | undefined,
    options?: DatapackComparerOptions,
    cancelToken?: CancellationToken,
): Promise<Map<string, OrgRecordStatus>>
Delta compare the records matched through their matching key against the org data in chunks so progress can be reported while the comparison is running. Records of extracted types are compared against the extracted org data without additional org queries.
Parameters
- records: DatapackDeploymentRecord[]
- store: OrgDataStore | undefined
- Optionaloptions: DatapackComparerOptions
- OptionalcancelToken: CancellationToken
Returns Promise<Map<string, OrgRecordStatus>>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:308

`Private`extractOrgData

extractOrgData(
    deployment: DatapackDeployment,
    options?: DatapackComparerOptions,
    cancelToken?: CancellationToken,
): Promise<OrgDataStore | undefined>
Bulk extract the org records for the SObject types in the deployment into an OrgDataStore so record lookups and comparisons resolve locally instead of through filtered org queries. Types exceeding the extract limits fall back to filtered org queries.
Parameters
- deployment: DatapackDeployment
- Optionaloptions: DatapackComparerOptions
- OptionalcancelToken: CancellationToken
Returns Promise<OrgDataStore | undefined>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:253

`Private`getExtractFields

getExtractFields(
sobjectType: string,
records: DatapackDeploymentRecord[],
): Promise<Set<string>>
Get the org fields to extract for a SObject type: the union of the record values, matching key fields and parent reference fields of the records, resolved case-insensitively against the org schema.
Parameters
- sobjectType: string
- records: DatapackDeploymentRecord[]
Returns Promise<Set<string>>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:281

`Private`hasMatchingKey

hasMatchingKey(record: DatapackDeploymentRecord): boolean
Records with a usable matching key are identified in the target org through their matching key configuration; records without (DatapackDeploymentRecord.skipLookup, no upsert fields, or upsert fields without values -- e.g. a matching key on an auto-number field which is never part of the record values) are matched by comparing the record data instead.
Parameters
- record: DatapackDeploymentRecord
Returns boolean
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:418

`Private`matchRecordsToOrgData

matchRecordsToOrgData(
    deployment: DatapackDeployment,
    records: DatapackDeploymentRecord[],
    outcomes: Map<string, RecordMatchOutcome>,
    cancelToken?: CancellationToken,
): Promise<void>
Match datapack records without matching key against org data; records that match are assigned the matched org record so records deeper in the datapack tree can resolve their parent references.
Parameters
- deployment: DatapackDeployment
- records: DatapackDeploymentRecord[]
- outcomes: Map<string, RecordMatchOutcome>
- OptionalcancelToken: CancellationToken
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:479

`Private`resolveExistingIdsLocally

resolveExistingIdsLocally(
records: DatapackDeploymentRecord[],
store: OrgDataStore,
): void
Resolve the existing org record IDs for records of extracted types against the OrgDataStore mirroring the matching key semantics of DatapackDeployment.resolveExistingIds: records are located by their matching key fields restricted by their resolved parent references; records that match are updated, records without a match are inserted.
Parameters
- records: DatapackDeploymentRecord[]
- store: OrgDataStore
Returns void
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:428

`Private`resolveOrgRecords

resolveOrgRecords(
    deployment: DatapackDeployment,
    outcomes: Map<string, RecordMatchOutcome>,
    store?: OrgDataStore,
    options?: DatapackComparerOptions,
    cancelToken?: CancellationToken,
): Promise<void>
Resolve the org records for all records in the deployment in dependency order: parents are resolved before their children so child records can be located through their parent references. Records with a matching key are resolved through an org lookup; embedded records without matching key are matched against org data through the deployments DatapackDeployment.recordMatcher.
Parameters
- deployment: DatapackDeployment
- outcomes: Map<string, RecordMatchOutcome>
- Optionalstore: OrgDataStore
- Optionaloptions: DatapackComparerOptions
- OptionalcancelToken: CancellationToken
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/datapackComparer.ts:345

Class DatapackComparer

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DatapackComparer

Properties

Private Readonlydeployer

Private Readonlylogger

Private ReadonlyrecordComparer

Private ReadonlysalesforceService

Private Static ReadonlydeployActions

Methods

PrivatebuildDatapackResult

Parameters

Returns Promise<DatapackComparisonStatus>

PrivatebuildRecordResult

Parameters

Returns Promise<DatapackRecordComparisonResult>

PrivatebuildResult

Parameters

Returns Promise<DatapackComparisonResult>

compare

Parameters

Returns Promise<DatapackComparisonResult>

compareDeployment

Parameters

Returns Promise<DatapackComparisonResult>

PrivatecompareMatchedRecords

Parameters

Returns Promise<Map<string, OrgRecordStatus>>

PrivateextractOrgData

Parameters

Returns Promise<OrgDataStore | undefined>

PrivategetExtractFields

Parameters

Returns Promise<Set<string>>

PrivatehasMatchingKey

Parameters

Returns boolean

PrivatematchRecordsToOrgData

Parameters

Returns Promise<void>

PrivateresolveExistingIdsLocally

Parameters

Returns void

PrivateresolveOrgRecords

Parameters

Returns Promise<void>

Settings

On This Page

`Private` `Readonly`deployer

`Private` `Readonly`logger

`Private` `Readonly`recordComparer

`Private` `Readonly`salesforceService

`Private` `Static` `Readonly`deployActions

`Private`buildDatapackResult

`Private`buildRecordResult

`Private`buildResult

`Private`compareMatchedRecords

`Private`extractOrgData

`Private`getExtractFields

`Private`hasMatchingKey

`Private`matchRecordsToOrgData

`Private`resolveExistingIdsLocally

`Private`resolveOrgRecords