Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion gooddata-sdk/docs/services/catalog-data-source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The *gooddata_sdk.catalog_data_source* supports the following entity API calls:
CatalogDataSource(
id="test",
name="Test2",
data_source_type="POSTGRESQL",
type="POSTGRESQL",
url="jdbc:postgresql://localhost:5432/demo",
schema="demo",
credentials=BasicCredentials(
Expand Down Expand Up @@ -226,6 +226,22 @@ Physical data model (PDM)

Set physical model for a given data source.

* ``store_pdm_to_disk(self, datasource_id: str, path: Path = Path.cwd())``

Store the physical model layout in the directory for a given data source.
The directory structure below shows the output for the path set to :code:`Path("pdm_location")`.

::

pdm_location
└── pdm
├── table_A.yaml
└── table_B.yaml

* ``load_pdm_from_disk(self, path: Path = Path.cwd())``

The method is used to load pdm stored to disk using method `store_pdm_to_disk`.

* ``store_declarative_pdm(data_source_id: str, layout_root_path: Path = Path.cwd())``

Store physical model layout in directory hierarchy for a given data source.
Expand Down
45 changes: 45 additions & 0 deletions gooddata-sdk/docs/services/catalog-workspace-content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,24 @@ Logical data model (LDM)

Put a logical data model into a given workspace. You can pass an additional validator parameter which checks that for every data source id in the logical data model the corresponding data source exists.

* ``store_ldm_to_disk(self, workspace_id: str, path: Path = Path.cwd())``

Store the ldm layout in the directory for a given workspace.
The directory structure below shows the output for the path set to :code:`Path("ldm_location")`.

::

ldm_location
└── ldm
├── datasets
│ └── dataset.yaml
└── date_instances
└── date_instance.yaml

* ``load_ldm_from_disk(self, path: Path = Path.cwd())``

The method is used to load ldm stored to disk using method `store_ldm_to_disk`.

* ``store_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd())``

Store logical data model layout in directory hierarchy.
Expand All @@ -134,6 +152,8 @@ Logical data model (LDM)
└── date_instances
└── date_instance.yaml



* ``load_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd())``

Returns *CatalogDeclarativeModel*.
Expand All @@ -158,6 +178,31 @@ Analytics Model

Put an analytics model into a given workspace.

* ``store_analytics_model_to_disk(self, workspace_id: str, path: Path = Path.cwd())``

Store the analytics model layout in the directory for a given workspace.
The directory structure below shows the output for the path set to :code:`Path("analytics_model_location")`.

::

analytics_model_location
└── analytics_model
├── analytical_dashboards
│ └── analytical_dashboard.yaml
├── dashboard_plugins
│ └── dashboard_plugin.yaml
├── filter_contexts
│ └── filter_context.yaml
├── metrics
│ └── metric.yaml
└── visualization_objects
└── visualization_object.yaml

* ``load_analytics_model_from_disk(self, path: Path = Path.cwd())``

The method is used to load analytics model stored to disk using method `store_analytics_model_to_disk`.


* ``store_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path.cwd())``

Store declarative analytics model layout in directory hierarchy.
Expand Down
2 changes: 0 additions & 2 deletions gooddata-sdk/docs/services/compute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ dimensions that influence how to organize the data in the result.
Higher level services like Table service use Compute service to execute computation in GoodData.CN.
Higher level service is also responsible for results presentation to the user e.g. in tabular form.

Entity methods
**************

The *gooddata_sdk.compute* supports the following entity API calls:

Expand Down
2 changes: 0 additions & 2 deletions gooddata-sdk/docs/services/table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Table Service
The ``gooddata_sdk.table`` service allows you to consume analytics in typical tabular format. The service allows free-form
computations and computations of data for GoodData.CN Insights.

Entity methods
**************

The *gooddata_sdk.table* supports the following entity API calls:

Expand Down