sempy_labs.mirrored_catalog package

Module contents

sempy_labs.mirrored_catalog.delete_mirrored_catalog(mirrored_catalog: str | UUID, workspace: str | UUID | None = None)

Deletes a mirrored catalog from a workspace.

This is a wrapper function for the following API: Items - Delete Mirrored Catalog.

Service Principal Authentication is supported (see here for examples).

Parameters:

  • mirrored_catalog (str | uuid.UUID) – The name or ID of the mirrored catalog.

  • workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

sempy_labs.mirrored_catalog.get_mirroring_status(mirrored_catalog: str | UUID, workspace: str | UUID | None = None) → dict

Gets the mirroring status of a mirrored catalog.

This is a wrapper function for the following API: Monitoring - Mirroring Status.

Service Principal Authentication is supported (see here for examples).

Parameters:

  • mirrored_catalog (str | uuid.UUID) – The name or ID of the mirrored catalog.

  • workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

Returns:

A dictionary containing the mirroring status of the specified mirrored catalog.

Return type:

dict

sempy_labs.mirrored_catalog.list_mirrored_catalogs(workspace: str | UUID | None = None) → DataFrame

List all mirrored catalogs in a workspace.

This is a wrapper function for the following API: Items - List Mirrored Catalogs.

Service Principal Authentication is supported (see here for examples).

Parameters:

workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

Returns:

A DataFrame containing the details of the mirrored catalogs in the specified workspace.

Return type:

pandas.DataFrame

sempy_labs.mirrored_catalog.list_tables_mirroring_status(mirrored_catalog: str | UUID, workspace: str | UUID | None = None) → DataFrame

Returns the per-table mirroring status for the mirrored catalog.

This is a wrapper function for the following API: Monitoring - Tables Mirroring Status.

Service Principal Authentication is supported (see here for examples).

Parameters:

  • mirrored_catalog (str | uuid.UUID) – The name or ID of the mirrored catalog.

  • workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.

Returns:

A DataFrame containing the per-table mirroring status of the specified mirrored catalog.

Return type:

pandas.DataFrame

sempy_labs.mirrored_catalog.refresh_catalog_metadata(mirrored_catalog: str | UUID, workspace: str | UUID | None = None)

Refreshes the metadata of a mirrored catalog.

This is a wrapper function for the following API: Refresh - Refresh Catalog Metadata.

Service Principal Authentication is supported (see here for examples).

Parameters:

  • mirrored_catalog (str | uuid.UUID) – The name or ID of the mirrored catalog.

  • workspace (str | uuid.UUID, default=None) – The Fabric workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.