From 22fd829c17539b9c248218e93332bdacfab7dc22 Mon Sep 17 00:00:00 2001 From: hkad98 Date: Mon, 15 Apr 2024 16:36:03 +0200 Subject: [PATCH] docs: remove obsolete methods from PDM --- .../docs/data/physical-data-model/_index.md | 6 -- .../get_declarative_pdm.md | 31 ----------- .../load_and_put_declarative_pdm.md | 55 ------------------- .../load_declarative_pdm.md | 34 ------------ .../put_declarative_pdm.md | 42 -------------- .../physical-data-model/scan_and_put_pdm.md | 31 ----------- .../store_declarative_pdm.md | 40 -------------- 7 files changed, 239 deletions(-) delete mode 100644 docs/content/en/docs/data/physical-data-model/get_declarative_pdm.md delete mode 100644 docs/content/en/docs/data/physical-data-model/load_and_put_declarative_pdm.md delete mode 100644 docs/content/en/docs/data/physical-data-model/load_declarative_pdm.md delete mode 100644 docs/content/en/docs/data/physical-data-model/put_declarative_pdm.md delete mode 100644 docs/content/en/docs/data/physical-data-model/scan_and_put_pdm.md delete mode 100644 docs/content/en/docs/data/physical-data-model/store_declarative_pdm.md diff --git a/docs/content/en/docs/data/physical-data-model/_index.md b/docs/content/en/docs/data/physical-data-model/_index.md index 30a2066ee..09bbca2f9 100644 --- a/docs/content/en/docs/data/physical-data-model/_index.md +++ b/docs/content/en/docs/data/physical-data-model/_index.md @@ -11,12 +11,6 @@ See [Create a Physical Data Model](https://www.gooddata.com/docs/cloud/model-dat ## Methods -* [get_declarative_pdm](./get_declarative_pdm/) -* [put_declarative_pdm](./put_declarative_pdm/) -* [store_declarative_pdm](./store_declarative_pdm/) -* [load_declarative_pdm](./load_declarative_pdm/) -* [load_and_put_declarative_pdm](./load_and_put_declarative_pdm/) -* [scan_and_put_pdm](./scan_and_put_pdm/) * [store_pdm_to_disk](./store_pdm_to_disk/) * [load_pdm_from_disk](./load_pdm_from_disk/) diff --git a/docs/content/en/docs/data/physical-data-model/get_declarative_pdm.md b/docs/content/en/docs/data/physical-data-model/get_declarative_pdm.md deleted file mode 100644 index 67b23d3c2..000000000 --- a/docs/content/en/docs/data/physical-data-model/get_declarative_pdm.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "get_declarative_pdm" -linkTitle: "get_declarative_pdm" -weight: 120 -superheading: "catalog_data_source." ---- - - - -``get_declarative_pdm(data_source_id: str)`` - -Retrieves the physical data model for a given data source. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeTables" >}} -Physical Data Model object. -{{< /parameter >}} -{{% /parameters-block %}} - -## Example - -```python -# Get Physical Data Model in declarative form -declarative_tables = sdk.catalog_data_source.get_declarative_pdm(data_source_id="123") -``` diff --git a/docs/content/en/docs/data/physical-data-model/load_and_put_declarative_pdm.md b/docs/content/en/docs/data/physical-data-model/load_and_put_declarative_pdm.md deleted file mode 100644 index 30ee10df6..000000000 --- a/docs/content/en/docs/data/physical-data-model/load_and_put_declarative_pdm.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "load_and_put_declarative_pdm" -linkTitle: "load_and_put_declarative_pdm" -weight: 160 -superheading: "catalog_data_source." ---- - - - -``load_and_put_declarative_pdm(data_source_id: str, layout_root_path: Path = Path.cwd())`` - -This method combines [load_declarative_pdm](../load_declarative_pdm/) and [put_declarative_pdm](../put_declarative_pdm/) methods to load and set layouts stored using [store_declarative_pdm](../store_declarative_pdm/). - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} - -## Example - -The load and put can be done two ways. - -Either by one call: - - -```python -# Load and put data sources in one method -sdk.catalog_user.load_and_put_declarative_pdm( - data_source_id="123", - layout_root_path = Path.cwd() -) -``` -Or by two separate calls: - -```python -# Load declarative Physical Data model -declarative_tables = sdk.catalog_data_source.load_declarative_pdm( - data_source_id="123", - layout_root_path=Path.cwd() -) -# Put declarative tables back on server -sdk.catalog_data_source.put_declarative_pdm( - data_source_id="123", - declarative_tables -) -``` - -The result is identical. diff --git a/docs/content/en/docs/data/physical-data-model/load_declarative_pdm.md b/docs/content/en/docs/data/physical-data-model/load_declarative_pdm.md deleted file mode 100644 index 58e205017..000000000 --- a/docs/content/en/docs/data/physical-data-model/load_declarative_pdm.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "load_declarative_pdm" -linkTitle: "load_declarative_pdm" -weight: 150 -superheading: "catalog_data_source." ---- - - - -``load_declarative_pdm(data_source_id: str, layout_root_path: Path = Path.cwd())`` - -Loads declarative physical data model layout, which was stored using [store_declarative_pdm](../store_declarative_pdm/) for a given data source. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} - -## Example - -```python -# Load declarative Physical Data model -declarative_tables = sdk.catalog_data_source.load_declarative_pdm( - data_source_id="123", - layout_root_path=Path.cwd() -) -``` diff --git a/docs/content/en/docs/data/physical-data-model/put_declarative_pdm.md b/docs/content/en/docs/data/physical-data-model/put_declarative_pdm.md deleted file mode 100644 index e361276ed..000000000 --- a/docs/content/en/docs/data/physical-data-model/put_declarative_pdm.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "put_declarative_pdm" -linkTitle: "put_declarative_pdm" -weight: 130 -superheading: "catalog_data_source." ---- - - - -``put_declarative_pdm(data_source_id: str, declarative_tables: CatalogDeclarativeTables)`` - -Sets the physical data model for a given data source. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="declarative_tables" p_type="CatalogDeclarativeTables" >}}Physical Data Model object. Can be obtained via get_declarative_pdm. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} - -## Example - -```python -# Load declarative tables -declarative_tables = sdk.catalog_data_source.load_declarative_pdm( - data_source_id="123", - layout_root_path=Path.cwd() -) - -# Do changes -# ... - -# Put declarative tables back on server -sdk.catalog_data_source.put_declarative_pdm( - data_source_id="123", - declarative_tables -) -``` diff --git a/docs/content/en/docs/data/physical-data-model/scan_and_put_pdm.md b/docs/content/en/docs/data/physical-data-model/scan_and_put_pdm.md deleted file mode 100644 index 1db2c3e0f..000000000 --- a/docs/content/en/docs/data/physical-data-model/scan_and_put_pdm.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "scan_and_put_pdm" -linkTitle: "scan_and_put_pdm" -weight: 200 -superheading: "catalog_data_source." ---- - - - -``scan_and_put_pdm(data_source_id: str, scan_request: CatalogScanModelRequest = CatalogScanModelRequest())`` - -This method combines [scan_data_source](../../data-source/scan_data_source/) and [put_declarative_pdm](../put_declarative_pdm/) methods. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="scan_request" p_type="Optional[CatalogScanModelRequest]" >}} -Options for the Scan Request. Defaults to CatalogScanModelRequest(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} - -## Example - -```python -# scan and put Physical Data Model to server -sdk.catalog_data_source.scan_and_put_pdm(data_source_id="demo-test-ds") -``` diff --git a/docs/content/en/docs/data/physical-data-model/store_declarative_pdm.md b/docs/content/en/docs/data/physical-data-model/store_declarative_pdm.md deleted file mode 100644 index 517eecdfc..000000000 --- a/docs/content/en/docs/data/physical-data-model/store_declarative_pdm.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "store_declarative_pdm" -linkTitle: "store_declarative_pdm" -weight: 139 -superheading: "catalog_data_source." ---- - - - -``store_declarative_pdm(data_source_id: str, layout_root_path: Path = Path.cwd())`` - -Stores the physical data model layout in directory hierarchy for a given data source. - - gooddata_layouts - └── organization_id - └── data_sources - └── data_source_a - └── pdm - ├── table_A.yaml - └── table_B.yaml - - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd().(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} - -## Example - -```python -# Store declarative PDM in directory hierarchy -sdk.catalog_data_source.store_declarative_pdm(data_source_id="123",layour_root_path=Path.cwd()) -```