Skip to content

Commit 401cdf6

Browse files
author
gdgate
authored
Merge pull request #171 from hkad98/PSDK-113
Documentation update Reviewed-by: https://github.com/pcerny
2 parents c5952d0 + 27b3dd9 commit 401cdf6

File tree

4 files changed

+62
-5
lines changed

4 files changed

+62
-5
lines changed

gooddata-sdk/docs/services/catalog-data-source.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The *gooddata_sdk.catalog_data_source* supports the following entity API calls:
8181
CatalogDataSource(
8282
id="test",
8383
name="Test2",
84-
data_source_type="POSTGRESQL",
84+
type="POSTGRESQL",
8585
url="jdbc:postgresql://localhost:5432/demo",
8686
schema="demo",
8787
credentials=BasicCredentials(
@@ -226,6 +226,22 @@ Physical data model (PDM)
226226

227227
Set physical model for a given data source.
228228

229+
* ``store_pdm_to_disk(self, datasource_id: str, path: Path = Path.cwd())``
230+
231+
Store the physical model layout in the directory for a given data source.
232+
The directory structure below shows the output for the path set to :code:`Path("pdm_location")`.
233+
234+
::
235+
236+
pdm_location
237+
└── pdm
238+
├── table_A.yaml
239+
└── table_B.yaml
240+
241+
* ``load_pdm_from_disk(self, path: Path = Path.cwd())``
242+
243+
The method is used to load pdm stored to disk using method `store_pdm_to_disk`.
244+
229245
* ``store_declarative_pdm(data_source_id: str, layout_root_path: Path = Path.cwd())``
230246

231247
Store physical model layout in directory hierarchy for a given data source.

gooddata-sdk/docs/services/catalog-workspace-content.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,24 @@ Logical data model (LDM)
117117

118118
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.
119119

120+
* ``store_ldm_to_disk(self, workspace_id: str, path: Path = Path.cwd())``
121+
122+
Store the ldm layout in the directory for a given workspace.
123+
The directory structure below shows the output for the path set to :code:`Path("ldm_location")`.
124+
125+
::
126+
127+
ldm_location
128+
└── ldm
129+
├── datasets
130+
│ └── dataset.yaml
131+
└── date_instances
132+
└── date_instance.yaml
133+
134+
* ``load_ldm_from_disk(self, path: Path = Path.cwd())``
135+
136+
The method is used to load ldm stored to disk using method `store_ldm_to_disk`.
137+
120138
* ``store_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd())``
121139

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

155+
156+
137157
* ``load_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd())``
138158

139159
Returns *CatalogDeclarativeModel*.
@@ -158,6 +178,31 @@ Analytics Model
158178

159179
Put an analytics model into a given workspace.
160180

181+
* ``store_analytics_model_to_disk(self, workspace_id: str, path: Path = Path.cwd())``
182+
183+
Store the analytics model layout in the directory for a given workspace.
184+
The directory structure below shows the output for the path set to :code:`Path("analytics_model_location")`.
185+
186+
::
187+
188+
analytics_model_location
189+
└── analytics_model
190+
├── analytical_dashboards
191+
│ └── analytical_dashboard.yaml
192+
├── dashboard_plugins
193+
│ └── dashboard_plugin.yaml
194+
├── filter_contexts
195+
│ └── filter_context.yaml
196+
├── metrics
197+
│ └── metric.yaml
198+
└── visualization_objects
199+
└── visualization_object.yaml
200+
201+
* ``load_analytics_model_from_disk(self, path: Path = Path.cwd())``
202+
203+
The method is used to load analytics model stored to disk using method `store_analytics_model_to_disk`.
204+
205+
161206
* ``store_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path.cwd())``
162207

163208
Store declarative analytics model layout in directory hierarchy.

gooddata-sdk/docs/services/compute.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ dimensions that influence how to organize the data in the result.
88
Higher level services like Table service use Compute service to execute computation in GoodData.CN.
99
Higher level service is also responsible for results presentation to the user e.g. in tabular form.
1010

11-
Entity methods
12-
**************
1311

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

gooddata-sdk/docs/services/table.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Table Service
44
The ``gooddata_sdk.table`` service allows you to consume analytics in typical tabular format. The service allows free-form
55
computations and computations of data for GoodData.CN Insights.
66

7-
Entity methods
8-
**************
97

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

0 commit comments

Comments
 (0)