catalog_data_source.

test_data_sources_connection

test_data_sources_connection(declarative_data_sources: CatalogDeclarativeDataSources, credentials_path: Optional[Path], config_file: Optional[Union[str, Path]])

Tests connection to declarative data sources.

If `credentials_path` is omitted then the connection is tested with empty credentials. In case some connection failed the `ValueError` is raised with information about why the connection to the data source failed, e.g. host unreachable or invalid login or password.

Parameters

nametypedescription
declarative_data_sourcesCatalogDeclarativeDataSourcesDeclarative Data Sources object
credentials_pathOptional[Path]Path to the credentials. Defaults to None.
config_fileOptional[Union[str, Path]]Path to the config file. Defaults to None.

Returns

None

Example

# Get data sources
declarative_data_sources = sdk.catalog_data_source.get_declarative_data_sources()

# Test data source connection
sdk.catalog_data_source.test_data_sources_connection(
    declarative_data_sources=declarative_data_sources,
    credentials_path=Path("credentials")
)