This documentation is for the unstable version of GoodData, currrently in development.
For stable version, go to the latest stable version of this article.
For stable version, go to the latest stable version of this article.
catalog_data_source.
scan_pdm_and_generate_logical_model
scan_pdm_and_generate_logical_model(data_source_id: str, generate_ldm_request: CatalogGenerateLdmRequest, scan_request: CatalogScanModelRequest, report_warnings: bool) -> 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
| name | type | description |
|---|---|---|
| data_source_id | str | Data Source identification string. e.g. "demo" |
| generate_ldm_request | CatalogGenerateLdmRequest | LDM options. Defaults to CatalogGenerateLdmRequest(separator="__", wdf_prefix="wdf") |
| scan_request | CatalogScanModelRequest | Options for the Scan Request. Defaults to CatalogScanModelRequest(). |
| report_warnings | bool | Switch to turn on warnings. Defaults to False. |
Returns
| type | description |
|---|---|
| CatalogDeclarativeModel | Object Containing declarative Logical Data Model |
Example
# Scan and generate logical model
ldm, pdm = sdk.catalog_data_source.scan_pdm_and_generate_logical_model(data_source_id="demo-test-ds")