@finos/legend-extension-dsl-data-quality
Version:
Legend extension for Data Quality
87 lines • 5 kB
TypeScript
/**
* Copyright (c) 2020-present, Goldman Sachs
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { type AbstractPureGraphManager, type ExecutionResult, type PureModel, type RawExecutionPlan, type RootGraphFetchTree, type V1_ParameterValue, type V1_PureModelContext, type V1_RawLambda, PureClientVersion, V1_PureGraphManager } from '@finos/legend-graph';
import { SerializationFactory } from '@finos/legend-shared';
import { DSL_DataQuality_PureGraphManagerExtension } from '../DSL_DataQuality_PureGraphManagerExtension.js';
import type { DataQualityRelationValidation, DQExecuteInputOptions, DQReconciliationInputOptions, DQValidationSuggestionInputOptions } from '../../../../graph/metamodel/pure/packageableElements/data-quality/DataQualityValidationConfiguration.js';
export declare class V1_DQExecuteInput {
clientVersion: string | undefined;
model: V1_PureModelContext;
lambdaParameterValues: V1_ParameterValue[];
packagePath: string;
defectsLimit: number | undefined;
queryLimit: number | undefined;
allValidationsChecked: boolean | undefined;
validationName: string | undefined;
runQuery: boolean | undefined;
static readonly serialization: SerializationFactory<V1_DQExecuteInput>;
}
export declare class V1_DQRuleSuggestionInput {
clientVersion: string | undefined;
model: V1_PureModelContext;
lambdaParameterValues: V1_ParameterValue[];
packagePath: string;
static readonly serialization: SerializationFactory<V1_DQRuleSuggestionInput>;
}
export declare class V1_DQReconciliationInput {
clientVersion: string | undefined;
model: V1_PureModelContext;
source: V1_RawLambda;
target: V1_RawLambda;
keys: string[];
colsForHash: string[];
defectLimit: number | undefined;
queryLimit: number | undefined;
aggregatedHash: boolean | undefined;
sourceHashCol: string | undefined;
targetHashCol: string | undefined;
includeColumnValues: boolean | undefined;
runSourceQuery: boolean | undefined;
runTargetQuery: boolean | undefined;
sourceLambdaParameterValues: V1_ParameterValue[];
targetLambdaParameterValues: V1_ParameterValue[];
static readonly serialization: SerializationFactory<V1_DQReconciliationInput>;
}
export declare class V1_DSL_Data_Quality_PureGraphManagerExtension extends DSL_DataQuality_PureGraphManagerExtension {
graphManager: V1_PureGraphManager;
static readonly DEV_PROTOCOL_VERSION = PureClientVersion.VX_X_X;
constructor(graphManager: AbstractPureGraphManager);
getSupportedProtocolVersion(): string;
private buildPureModelSDLCPointer;
private executeValidation;
private runValidationAndReturnString;
private export;
createExecutionInput(graph: PureModel, packagePath: string, dqExecuteInput: V1_DQExecuteInput, options: DQExecuteInputOptions): V1_DQExecuteInput;
generatePlan: (graph: PureModel, packagePath: string, options: DQExecuteInputOptions) => Promise<RawExecutionPlan>;
execute: (graph: PureModel, packagePath: string, options: DQExecuteInputOptions) => Promise<ExecutionResult>;
exportData: (graph: PureModel, packagePath: string, options: DQExecuteInputOptions) => Promise<Response>;
debugExecutionPlanGeneration: (graph: PureModel, packagePath: string, options: DQExecuteInputOptions) => Promise<{
plan: RawExecutionPlan;
debug: string;
}>;
fetchStructuralValidations: (graph: PureModel, packagePath: string, options: DQExecuteInputOptions) => Promise<RootGraphFetchTree>;
private executeDataProfiling;
runDataProfiling: (graph: PureModel, packagePath: string, options: DQExecuteInputOptions) => Promise<ExecutionResult>;
exportDataProfiling: (graph: PureModel, packagePath: string, options: DQExecuteInputOptions) => Promise<Response>;
fetchValidationSuggestions: (graph: PureModel, packagePath: string, options: DQValidationSuggestionInputOptions) => Promise<DataQualityRelationValidation>;
private rawLambdaToV1;
private createReconciliationInput;
runReconciliation: (graph: PureModel, options: DQReconciliationInputOptions) => Promise<ExecutionResult>;
runReconciliationSourceQuery: (graph: PureModel, options: DQReconciliationInputOptions) => Promise<ExecutionResult>;
runReconciliationTargetQuery: (graph: PureModel, options: DQReconciliationInputOptions) => Promise<ExecutionResult>;
private runReconciliationWithInput;
}
//# sourceMappingURL=V1_DSL_Data_Quality_PureGraphManagerExtension.d.ts.map