sempy_labs.graphql package

Module contents

sempy_labs.graphql.create_graphql_api(name: str, description: str | None = None, workspace: str | UUID | None = None)

Creates a GraphQL API.

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

Parameters:

  • name (str) – Name of the GraphQL API.

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

  • 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.graphql.list_graphql_apis(workspace: str | UUID | None) → DataFrame

Shows the Graph QL APIs within a workspace.

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

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 GraphQL APIs within a workspace.

Return type:

pandas.DataFrame