sempy_labs.sql_endpoint package

Module contents

sempy_labs.sql_endpoint.list_sql_endpoints(workspace: str | UUID | None = None) → DataFrame

Shows the SQL endpoints within a workspace.

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 pandas dataframe showing the SQL endpoints within a workspace.

Return type:

pandas.DataFrame

sempy_labs.sql_endpoint.refresh_sql_endpoint_metadata(item: str | UUID, type: Literal['Lakehouse', 'MirroredDatabase'], workspace: str | UUID | None = None, timeout_unit: Literal['Seconds', 'Minutes', 'Hours', 'Days'] = 'Minutes', timeout_value: int = 15, recreate_tables: bool = False) → DataFrame

Refreshes the metadata of a SQL endpoint.

This is a wrapper function for the following API: Items - Refresh Sql Endpoint Metadata.

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

Parameters:

  • item (str | uuid.UUID) – The name or ID of the item (Lakehouse or MirroredDatabase).

  • type (Literal['Lakehouse', 'MirroredDatabase']) – The type of the item. Must be ‘Lakehouse’ or ‘MirroredDatabase’.

  • 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.

  • timeout_unit (Literal['Seconds', 'Minutes', 'Hours', 'Days'], default='Minutes') – The unit of time for the request duration before timing out. Additional duration types may be added over time.

  • timeout_value (int, default=15) – The number of time units in the request duration.

  • recreate_tables (bool, default=False) – When set to true, this property instructs the system to drop and recreate all tables on SQL analytics endpoint during the refresh process. Use this option if you need to fully rebuild tables from their source definitions, for example to resolve inconsistencies or ensure a clean refresh.

Returns:

A pandas dataframe showing the status of the metadata refresh operation.

Return type:

pandas.DataFrame