This documentation is for an older version of GoodData.
Go to the latest version of this article.
catalog_data_source.
scan_data_source
scan_data_source(data_source_id: str, scan_request: CatalogScanModelRequest = CatalogScanModelRequest(), report_warnings: bool = False)
Scans the data source specified by its id and optionally by specified scan request.
CatalogScanResultPdm contains PDM and warnings. Warnings contain information about columns which were not added to the PDM because their data types are not supported.
Additional parameter report_warnings can be passed to suppress or to report warnings.
By default warnings are returned but not reported to STDOUT. If you set report_warnings to True, warnings are reported to STDOUT.
Parameters
| name | type | description |
|---|---|---|
| data_source_id | string | Data source identification string. e.g. "demo" |
| scan_request | Optional[CatalogScanModelRequest] | Options for the Scan Request. Defaults to CatalogScanModelRequest(). |
| report_warnings | Optional[bool] | Switch to turn on warnings. Defaults to False. |
Returns
| type | description |
|---|---|
| CatalogScanResultPdm | Physical Data Model scan result object. |
Example
# Scan data source
scan_result_pdm = sdk.catalog_data_source.scan_data_source(data_source_id="demo-test-ds")