Databricks SDK for JavaScript
    Preparing search index...

    Interface DataProfilingConfig

    Data Profiling Configurations.

    interface DataProfilingConfig {
        analysisConfig?:
            | { $case: "inferenceLog"; inferenceLog: InferenceLogConfig }
            | { $case: "timeSeries"; timeSeries: TimeSeriesConfig }
            | { $case: "snapshot"; snapshot: SnapshotConfig };
        assetsDir?: string;
        baselineTableName?: string;
        customMetrics?: DataProfilingCustomMetric[];
        dashboardId?: string;
        driftMetricsTableName?: string;
        effectiveWarehouseId?: string;
        latestMonitorFailureMessage?: string;
        monitoredTableName?: string;
        monitorVersion?: bigint;
        notificationSettings?: NotificationSettings;
        outputSchemaId?: string;
        profileMetricsTableName?: string;
        schedule?: CronSchedule;
        skipBuiltinDashboard?: boolean;
        slicingExprs?: string[];
        status?: DataProfilingStatus;
        warehouseId?: string;
    }
    Index

    Properties

    analysisConfig? assetsDir? baselineTableName? customMetrics? dashboardId? driftMetricsTableName? effectiveWarehouseId? latestMonitorFailureMessage? monitoredTableName? monitorVersion? notificationSettings? outputSchemaId? profileMetricsTableName? schedule? skipBuiltinDashboard? slicingExprs? status? warehouseId?

    Properties

    analysisConfig?:
        | { $case: "inferenceLog"; inferenceLog: InferenceLogConfig }
        | { $case: "timeSeries"; timeSeries: TimeSeriesConfig }
        | { $case: "snapshot"; snapshot: SnapshotConfig }

    (--[Create:REQ Update:REQ]--) Analysis config which is used to determine analysis logic.

    Type Declaration

    assetsDir?: string

    Field for specifying the absolute path to a custom directory to store data-monitoring assets. Normally prepopulated to a default user location via UI and Python APIs.

    baselineTableName?: string

    Baseline table name. Baseline data is used to compute drift from the data in the monitored table_name. The baseline table and the monitored table shall have the same schema.

    customMetrics?: DataProfilingCustomMetric[]

    Custom metrics.

    dashboardId?: string

    Id of dashboard that visualizes the computed metrics. This can be empty if the monitor is in PENDING state.

    driftMetricsTableName?: string

    Table that stores drift metrics data. Format: catalog.schema.table_name.

    effectiveWarehouseId?: string

    The warehouse for dashboard creation

    latestMonitorFailureMessage?: string

    The latest error message for a monitor failure.

    monitoredTableName?: string

    Unity Catalog table to monitor. Format: catalog.schema.table_name

    monitorVersion?: bigint

    Represents the current monitor configuration version in use. The version will be represented in a numeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted monitor_version numbers.

    notificationSettings?: NotificationSettings

    Field for specifying notification settings.

    outputSchemaId?: string

    ID of the schema where output tables are created.

    profileMetricsTableName?: string

    Table that stores profile metrics data. Format: catalog.schema.table_name.

    schedule?: CronSchedule

    The cron schedule.

    skipBuiltinDashboard?: boolean

    Whether to skip creating a default dashboard summarizing data quality metrics.

    slicingExprs?: string[]

    List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For example slicing_exprs=[“col_1”, “col_2 > 10”] will generate the following slices: two slices for col_2 > 10 (True and False), and one slice per unique value in col1. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.

    status?: DataProfilingStatus

    The data profiling monitor status.

    warehouseId?: string

    Optional argument to specify the warehouse for dashboard creation. If not specified, the first running warehouse will be used.

    Settings

    Member Visibility

    On This Page

    Properties