w.data_quality: DataQuality.v1

class databricks.sdk.service.dataquality.DataQualityAPI

Manage the data quality of Unity Catalog objects (currently support schema and table)

cancel_refresh(object_type: str, object_id: str, refresh_id: int) → CancelRefreshResponse

Cancels a data quality monitor refresh. Currently only supported for the table object_type. The call must be made in the same workspace as where the monitor was created.

The caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the table’s parent catalog.

2. USE_CATALOG on the table’s parent catalog, and MANAGE and USE_SCHEMA on the table’s parent schema.

3. USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and MANAGE on the table.

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

• refresh_id – int Unique id of the refresh operation.

Returns:

CancelRefreshResponse

create_monitor(monitor: Monitor) → Monitor

Create a data quality monitor on a Unity Catalog object. The caller must provide either anomaly_detection_config for a schema monitor or data_profiling_config for a table monitor.

For the table object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and SELECT on the table

2. USE_CATALOG on the table’s parent catalog, MANAGE and USE_SCHEMA on the table’s parent schema, and SELECT on the table.

3. USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and MANAGE and SELECT on the table.

Workspace assets, such as the dashboard, will be created in the workspace where this call was made.

For the schema object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the schema’s parent catalog.

2. USE_CATALOG on the schema’s parent catalog, and MANAGE and USE_SCHEMA on the schema.

Parameters:

monitor – Monitor The monitor to create.

Returns:

Monitor

create_refresh(object_type: str, object_id: str, refresh: Refresh) → Refresh

Creates a refresh. Currently only supported for the table object_type. The call must be made in the same workspace as where the monitor was created.

The caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the table’s parent catalog.

2. USE_CATALOG on the table’s parent catalog, and MANAGE and USE_SCHEMA on the table’s parent schema.

3. USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and MANAGE on the table.

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

• refresh – Refresh The refresh to create

Returns:

Refresh

delete_monitor(object_type: str, object_id: str)

Delete a data quality monitor on Unity Catalog object.

For the table object_type, the caller must have either of the following sets of permissions: MANAGE and USE_CATALOG on the table’s parent catalog. USE_CATALOG on the table’s parent catalog, and MANAGE and USE_SCHEMA on the table’s parent schema. USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and MANAGE on the table.

Note that the metric tables and dashboard will not be deleted as part of this call; those assets must be manually cleaned up (if desired).

For the schema object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the schema’s parent catalog.

2. USE_CATALOG on the schema’s parent catalog, and MANAGE and USE_SCHEMA on the schema.

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

delete_refresh(object_type: str, object_id: str, refresh_id: int)

(Unimplemented) Delete a refresh

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

• refresh_id – int Unique id of the refresh operation.

get_monitor(object_type: str, object_id: str) → Monitor

Read a data quality monitor on a Unity Catalog object.

For the table object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the table’s parent catalog.

2. USE_CATALOG on the table’s parent catalog, and MANAGE and USE_SCHEMA on the table’s parent schema.

3. USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and SELECT on the table.

For the schema object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the schema’s parent catalog.

2. USE_CATALOG on the schema’s parent catalog, and USE_SCHEMA on the schema.

The returned information includes configuration values on the entity and parent entity as well as information on assets created by the monitor. Some information (e.g. dashboard) may be filtered out if the caller is in a different workspace than where the monitor was created.

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

Returns:

Monitor

get_refresh(object_type: str, object_id: str, refresh_id: int) → Refresh

Get data quality monitor refresh. The call must be made in the same workspace as where the monitor was created.

For the table object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the table’s parent catalog.

2. USE_CATALOG on the table’s parent catalog, and MANAGE and USE_SCHEMA on the table’s parent schema.

3. USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and SELECT on the table.

For the schema object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the schema’s parent catalog.

2. USE_CATALOG on the schema’s parent catalog, and USE_SCHEMA on the schema.

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

• refresh_id – int Unique id of the refresh operation.

Returns:

Refresh

list_monitor([, page_size: Optional[int], page_token: Optional[str]]) → Iterator[Monitor]

(Unimplemented) List data quality monitors.

Parameters:

• page_size – int (optional)

• page_token – str (optional)

Returns:

Iterator over Monitor

list_refresh(object_type: str, object_id: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[Refresh]

List data quality monitor refreshes. The call must be made in the same workspace as where the monitor was created.

For the table object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the table’s parent catalog.

2. USE_CATALOG on the table’s parent catalog, and MANAGE and USE_SCHEMA on the table’s parent schema.

3. USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and SELECT on the table.

For the schema object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the schema’s parent catalog.

2. USE_CATALOG on the schema’s parent catalog, and USE_SCHEMA on the schema.

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

• page_size – int (optional)

• page_token – str (optional)

Returns:

Iterator over Refresh

update_monitor(object_type: str, object_id: str, monitor: Monitor, update_mask: str) → Monitor

Update a data quality monitor on Unity Catalog object.

For the table object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the table’s parent catalog.

2. USE_CATALOG on the table’s parent catalog, and MANAGE and USE_SCHEMA on the table’s parent schema.

3. USE_CATALOG on the table’s parent catalog, USE_SCHEMA on the table’s parent schema, and MANAGE on the table.

For the schema object_type, the caller must have either of the following sets of permissions:

1. MANAGE and USE_CATALOG on the schema’s parent catalog.

2. USE_CATALOG on the schema’s parent catalog, and MANAGE and USE_SCHEMA on the schema.

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

• monitor – Monitor The monitor to update.

• update_mask – str The field mask to specify which fields to update as a comma-separated list. Example value: data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression

Returns:

Monitor

update_refresh(object_type: str, object_id: str, refresh_id: int, refresh: Refresh, update_mask: str) → Refresh

(Unimplemented) Update a refresh

Parameters:

• object_type – str The type of the monitored object. Can be one of the following: schema or table.

• object_id –

  str The UUID of the request object. It is schema_id for schema, and table_id for table.

  Find the schema_id from either:

  1. The schema_id of the Schemas resource.

  2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

  Find the table_id from either:

  1. The table_id of the Tables resource.

  2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field.

• refresh_id – int Unique id of the refresh operation.

• refresh – Refresh The refresh to update.

• update_mask – str The field mask to specify which fields to update.

Returns:

Refresh