Skip to content

[bot] Merge master/b0af95da into rel/dev #1149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yenkins-admin merged 2 commits into from
Sep 11, 2025
Merged

[bot] Merge master/b0af95da into rel/dev #1149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cb400e
docs: add missing method
hkad98 Sep 9, 2025
b0af95d
Merge pull request #1139 from hkad98/jkd/trivial
hkad98 Sep 11, 2025
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
1 change: 1 addition & 0 deletions docs/content/en/latest/data/data-source/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ See [Connect Data](https://www.gooddata.com/docs/cloud/connect-data/) to learn h
* [generate_logical_model](./generate_logical_model/)
* [register_upload_notification](./register_upload_notification/)
* [scan_data_source](./scan_data_source/)
* [scan_pdm_and_generate_logical_model](./scan_pdm_and_generate_logical_model/)
* [scan_schemata](./scan_schemata/)
* [scan_sql](./scan_sql/)

Expand Down
51 changes: 51 additions & 0 deletions docs/content/en/latest/data/data-source/scan_pdm_and_generate_logical_model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: "scan_pdm_and_generate_logical_model"
linkTitle: "scan_pdm_and_generate_logical_model"
weight: 190
superheading: "catalog_data_source."
---

``scan_pdm_and_generate_logical_model(data_source_id: str, generate_ldm_request: Optional[CatalogGenerateLdmRequest] = None, scan_request: CatalogScanModelRequest = CatalogScanModelRequest(), report_warnings: bool = False) -> tuple[CatalogDeclarativeModel, CatalogScanResultPdm]``

Scan data source and use returned PDM to generate logical data model. If generate_ldm_request
contains PDM already, PDM tables received from the scan are appended without deduplication.

{{% parameters-block title="Parameters"%}}

{{< parameter p_name="data_source_id" p_type="string" >}}
Data Source identification string. e.g. "demo"
{{< /parameter >}}

{{< parameter p_name="generate_ldm_request" p_type="Optional[CatalogGenerateLdmRequest]" >}}
LDM options. Defaults to CatalogGenerateLdmRequest(separator="__", wdf_prefix="wdf")
{{< /parameter >}}

{{< parameter p_name="scan_request" p_type="Optional[CatalogScanModelRequest]" >}}
Options for the Scan Request. Defaults to CatalogScanModelRequest().
{{< /parameter >}}

{{< parameter p_name="report_warnings" p_type="bool" >}}
Switch to turn on warnings. Defaults to False.
{{< /parameter >}}

{{% /parameters-block %}}

{{% parameters-block title="Returns"%}}

{{< parameter p_type="CatalogDeclarativeModel" >}}
Object Containing declarative Logical Data Model.
{{< /parameter >}}

{{< parameter p_type="CatalogScanResultPdm" >}}
An instance of CatalogScanResultPdm.
Containing pdm itself and a list of warnings that occurred during scanning.
{{< /parameter >}}

{{% /parameters-block %}}

## Example

```python
# Scan and generate logical model
ldm, pdm = sdk.catalog_data_source.scan_pdm_and_generate_logical_model(data_source_id="demo-test-ds")
```
Loading