feat: add api to gooddata-sdk for agg fact

risk: low

Author: fiedlr

gooddata-sdk/gooddata_sdk/catalog/identifier.py

@@ -16,6 +16,7 @@
 )
 from gooddata_api_client.model.declarative_user_group_identifier import DeclarativeUserGroupIdentifier
 from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier
+from gooddata_api_client.model.fact_identifier import FactIdentifier
 from gooddata_api_client.model.grain_identifier import GrainIdentifier
 from gooddata_api_client.model.label_identifier import LabelIdentifier
 from gooddata_api_client.model.reference_identifier import ReferenceIdentifier
@@ -82,6 +83,16 @@ def client_class() -> builtins.type[DeclarativeUserIdentifier]:
         return DeclarativeUserIdentifier
 
 
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogFactIdentifier(Base):
+    id: str
+    type: str = attr.field(validator=value_in_allowed)
+
+    @staticmethod
+    def client_class() -> builtins.type[FactIdentifier]:
+        return FactIdentifier
+
+
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogLabelIdentifier(Base):
     id: str

gooddata-sdk/gooddata_sdk/catalog/workspace/content_service.py

@@ -21,6 +21,7 @@
 from gooddata_sdk.catalog.workspace.declarative_model.workspace.logical_model.ldm import CatalogDeclarativeModel
 from gooddata_sdk.catalog.workspace.declarative_model.workspace.workspace import LAYOUT_WORKSPACES_DIR
 from gooddata_sdk.catalog.workspace.entity_model.content_objects.dataset import (
+    CatalogAggregatedFact,
     CatalogAttribute,
     CatalogFact,
     CatalogLabel,
@@ -191,6 +192,24 @@ def get_facts_catalog(self, workspace_id: str) -> list[CatalogFact]:
         catalog_facts = [CatalogFact.from_api(fact) for fact in facts.data]
         return catalog_facts
 
+    def get_aggregated_facts_catalog(self, workspace_id: str) -> list[CatalogAggregatedFact]:
+        """Retrieve all aggregated facts in a given workspace.
+
+        Args:
+            workspace_id (str):
+                Workspace identification string e.g. "demo"
+
+        Returns:
+            list[CatalogFact]:
+                List of all facts in a given workspace.
+        """
+        get_agg_facts = functools.partial(
+            self._entities_api.get_all_entities_aggregated_facts, workspace_id, _check_return_type=False
+        )
+        agg_facts = load_all_entities(get_agg_facts)
+        catalog_agg_facts = [CatalogAggregatedFact.from_api(agg_fact) for agg_fact in agg_facts.data]
+        return catalog_agg_facts
+
     def get_dependent_entities_graph(self, workspace_id: str) -> CatalogDependentEntitiesResponse:
         """There are dependencies among all catalog objects, the chain is the following:
         `fact/attribute/label → dataset → metric → visualization → dashboard`

gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset/dataset.py

@@ -6,17 +6,24 @@
 
 import attr
 from gooddata_api_client.model.data_source_table_identifier import DataSourceTableIdentifier
+from gooddata_api_client.model.declarative_aggregated_fact import DeclarativeAggregatedFact
 from gooddata_api_client.model.declarative_attribute import DeclarativeAttribute
 from gooddata_api_client.model.declarative_dataset import DeclarativeDataset
 from gooddata_api_client.model.declarative_dataset_sql import DeclarativeDatasetSql
 from gooddata_api_client.model.declarative_fact import DeclarativeFact
 from gooddata_api_client.model.declarative_label import DeclarativeLabel
 from gooddata_api_client.model.declarative_reference import DeclarativeReference
 from gooddata_api_client.model.declarative_reference_source import DeclarativeReferenceSource
+from gooddata_api_client.model.declarative_source_fact_reference import DeclarativeSourceFactReference
 from gooddata_api_client.model.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn
 
 from gooddata_sdk.catalog.base import Base
-from gooddata_sdk.catalog.identifier import CatalogGrainIdentifier, CatalogLabelIdentifier, CatalogReferenceIdentifier
+from gooddata_sdk.catalog.identifier import (
+    CatalogFactIdentifier,
+    CatalogGrainIdentifier,
+    CatalogLabelIdentifier,
+    CatalogReferenceIdentifier,
+)
 from gooddata_sdk.catalog.workspace.declarative_model.workspace.logical_model.data_filter_references import (
     CatalogDeclarativeWorkspaceDataFilterReferences,
 )
@@ -34,6 +41,7 @@ class CatalogDeclarativeDataset(Base):
     description: Optional[str] = None
     attributes: Optional[list[CatalogDeclarativeAttribute]] = None
     facts: Optional[list[CatalogDeclarativeFact]] = None
+    aggregated_facts: Optional[list[CatalogDeclarativeAggregatedFact]] = None
     data_source_table_id: Optional[CatalogDataSourceTableIdentifier] = None
     sql: Optional[CatalogDeclarativeDatasetSql] = None
     tags: Optional[list[str]] = None
@@ -86,6 +94,30 @@ def client_class() -> type[DeclarativeFact]:
         return DeclarativeFact
 
 
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogDeclarativeSourceFactReference(Base):
+    operation: str
+    reference: CatalogFactIdentifier
+
+    @staticmethod
+    def client_class() -> type[DeclarativeFact]:
+        return DeclarativeSourceFactReference
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogDeclarativeAggregatedFact(Base):
+    id: str
+    source_column: str
+    source_fact_reference: Optional[CatalogDeclarativeSourceFactReference] = None
+    source_column_data_type: Optional[str] = None
+    description: Optional[str] = None
+    tags: Optional[list[str]] = None
+
+    @staticmethod
+    def client_class() -> type[DeclarativeAggregatedFact]:
+        return DeclarativeAggregatedFact
+
+
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogDataSourceTableIdentifier(Base):
     id: str

gooddata-sdk/gooddata_sdk/catalog/workspace/entity_model/content_objects/dataset.py

@@ -99,6 +99,18 @@ def as_computable(self) -> Metric:
     # TODO - dataset?
 
 
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogAggregatedFact(AttrCatalogEntity):
+    @staticmethod
+    def client_class() -> Any:
+        return JsonApiFactOut
+
+    def as_computable(self) -> Metric:
+        return SimpleMetric(local_id=self.id, item=self.obj_id)
+
+    # TODO - dataset?
+
+
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogDataset(AttrCatalogEntity):
     @property