catalog_workspace_content.

get_full_catalog

get_full_catalog(workspace_id: str, inject_valid_objects_func: bool) -> CatalogWorkspaceContent

Retrieves catalog for a workspace. Catalog contains all data sets and metrics defined in that workspace.

Parameters

nametypedescription
workspace_idstrWorkspace identification string e.g. "demo"
inject_valid_objects_funcboolShould valid_objects func be injected into the result container? When turned off, it enables pickling of the result, which is useful e.g. in Streamlit caching In such a case, developers must call compute_valid_objects in this service.

Returns

typedescription
CatalogWorkspaceContentObject containing all data sets and metrics.

Example

# Get full catalog
workspace_content = sdk.catalog_workspace_content.get_full_catalog(workspace_id="123")

# CatalogWorkspaceContent(
#   datasets=[
#       CatalogDataset(
#           id=campaign_channels,
#           title=Campaign channels,
#           facts=[
#               CatalogFact(
#                   id=spend,
#                   title=Spend
#               ),
#           CatalogFact(
#               id=budget,
#               title=Budget
#           )
#   ],
#   ...
# )