open-lineage-client
Version:
TypeScript/JavaScript client for creating and sending OpenLineage standard events.
48 lines (47 loc) • 1.64 kB
TypeScript
import { BaseFacet } from './BaseFacet.js';
/**
* Represents the facets of an input dataset.
*/
export declare class InputDatasetFacets {
dataQualityMetrics: DataQualityMetrics | null;
constructor(dataQualityMetrics?: DataQualityMetrics | null);
}
/**
* Represents data quality metrics for an input dataset.
*/
export declare class DataQualityMetrics extends BaseFacet {
columnMetrics: Record<string, ColumnMetrics>;
rowCount: number | null;
bytes: number | null;
fileCount: number | null;
constructor(producer: string, schemaURL: string, columnMetrics?: Record<string, ColumnMetrics>, rowCount?: number | null, bytes?: number | null, fileCount?: number | null);
/**
* Adds column metrics to the dataset.
* @param key - The key for the column metrics.
* @param columnMetrics - The column metrics to add.
*/
addColumnMetrics(key: string, columnMetrics: ColumnMetrics): void;
/**
* Returns the schema URL for the data quality metrics.
*/
getSchema(): string;
}
/**
* Represents metrics for a specific column.
*/
export declare class ColumnMetrics {
nullCount: number;
distinctCount: number;
sum: number;
count: number;
min: number;
max: number;
quantiles: Record<string, number>;
constructor(nullCount: number, distinctCount: number, sum: number, count: number, min: number, max: number, quantiles: Record<string, number>);
/**
* Adds a quantile to the column metrics.
* @param key - The key for the quantile.
* @param value - The value of the quantile.
*/
addQuantile(key: string, value: number): void;
}