service.CatalogDataSourceService
_summary_
Properties
NoneMethods
| Name | Description |
|---|---|
| create_or_update_data_source(data_source: CatalogDataSource) | Pushes the Data Source to the GoodData environment. |
| get_data_source(data_source_id: str) | Retrieve Data Source entity using data source id. |
| delete_data_source(data_source_id: str) | Delete data source using Data Source id. |
| patch_data_source_attributes(data_source_id: str, attributes: dict) | Applies changes to the specified data source. |
| list_data_sources() | Lists all data sources. |
| get_declarative_data_sources() | Retrieve all data sources. |
| put_declarative_data_sources(declarative_data_sources: CatalogDeclarativeDataSources, credentials_path: Optional[Path], config_file: Optional[Union[str, Path]], test_data_sources: bool) | Set all data sources, including their related physical data model. |
| store_declarative_data_sources(layout_root_path: Path) | Store data sources layouts in a directory hierarchy. |
| load_declarative_data_sources(layout_root_path: Optional[Path]) | Load declarative data sources layout, which was stored using store_declarative_data_sources. |
| load_and_put_declarative_data_sources(layout_root_path: Optional[Path], credentials_path: Optional[Path], config_file: Optional[Union[str, Path]], test_data_sources: bool) | Loads and sets layouts stored using store_declarative_data_sources. |
| store_pdm_to_disk(pdm: CatalogDeclarativeTables, path: Path) | Store the physical data model layout in the directory. |
| load_pdm_from_disk(path: Path) | This method is used to load pdm stored to disk using method store_pdm_to_disk. |
| generate_logical_model(data_source_id: str, generate_ldm_request: CatalogGenerateLdmRequest) | Generate logical data model for a data source. |
| scan_pdm_and_generate_logical_model(data_source_id: str, generate_ldm_request: CatalogGenerateLdmRequest, scan_request: CatalogScanModelRequest, report_warnings: bool) | 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. |
| register_upload_notification(data_source_id: str) | Invalidate cache of your computed reports to force your analytics to be recomputed. |
| scan_data_source(data_source_id: str, scan_request: CatalogScanModelRequest, report_warnings: bool) | Scan data source specified by its id and optionally by specified scan request. |
| scan_schemata(data_source_id: str) | Returns a list of schemas that exist in the database. |
| scan_sql(data_source_id: str, sql_request: ScanSqlRequest) | Analyze SELECT SQL query in a given request. |
| test_data_sources_connection(declarative_data_sources: CatalogDeclarativeDataSources, credentials_path: Optional[Path], config_file: Optional[Union[str, Path]]) | Tests connection to declarative data sources. |
| staging_upload(csv_file: Path) | Upload a CSV file to the staging area. |
| analyze_csv(location: str) | Analyze an uploaded CSV file in the staging area. |
| import_csv(data_source_id: str, table_name: str, location: str, config: Optional[dict[str, Any]]) | Import a CSV file from staging into a GDSTORAGE data source. |
| delete_csv_files(data_source_id: str, file_names: list[str]) | Delete files from a GDSTORAGE data source. |
| upload_csv(data_source_id: str, csv_file: Path, table_name: str) | Upload a CSV file and import it into a GDSTORAGE data source. |
| report_warnings() | None |
| data_source_folder(data_source_id: str, layout_root_path: Path) | TODO |