sempy_labs.eventhouse package

Module contents

sempy_labs.eventhouse.create_eventhouse(name: str, definition: dict | None, description: str | None = None, workspace: str | UUID | None = None)

Creates a Fabric eventhouse.

This is a wrapper function for the following API: Items - Create Eventhouse.

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

Parameters:

  • name (str) – Name of the eventhouse.

  • definition (dict) – The definition (EventhouseProperties.json) of the eventhouse.

  • description (str, default=None) – A description of the environment.

  • 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.eventhouse.delete_eventhouse(name: str, workspace: str | UUID | None = None)

Deletes a Fabric eventhouse.

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

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

Parameters:

  • name (str) – Name of the eventhouse.

  • 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.eventhouse.get_eventhouse_definition(eventhouse: str | UUID, workspace: str | UUID | None = None, return_dataframe: bool = False) → dict | DataFrame

Gets the eventhouse definition.

This is a wrapper function for the following API: Items - Get Eventhouse Definition.

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

Parameters:

  • eventhouse (str) – Name of the eventhouse.

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

  • return_dataframe (bool, default=False) – If True, returns a dataframe. If False, returns a json dictionary.

Returns:

The eventhouse definition in .json format or as a pandas dataframe.

Return type:

dict | pandas.DataFrame

sempy_labs.eventhouse.list_eventhouses(workspace: str | UUID | None = None) → DataFrame

Shows the eventhouses within a workspace.

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

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

Return type:

pandas.DataFrame