This documentation is for an older version of GoodData.
Go to the latest version of this article.
CatalogDataSourceService.
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 CatalogScanResultPdm: An instance of CatalogScanResultPdm. Containing pdm itself and a list of warnings that occurred during scanning. |