get_data_source_lists

Returns the data-source lists of the open project — the places CAT loaded data-source definitions from.

Signature #

cat.get_data_source_lists()

Parameters #

None.

What it does #

Returns the project’s data-source lists: the project file’s own implicit list and every Data source list the project declares (a YAML file, a database table, an Excel sheet, …), each with its provider and connection. Use it to see where data sources come from; get_data_sources returns the data sources themselves, with DataSourceListID pointing back here.

Returns #

A .NET collection of DataSourceList objects: DataSourceListID, Name, Order, ProviderNameAndVersion, ConnectionString, Query, IsImplicit (the project file’s own list), FullName (for example # 1: Project file (Yaml@1)), Settings.

Raises #

The license key and plan check (first call of the process) raises the CatPortalError family listed on the Introduction page. With no open project: RuntimeError: There is no open project. Open a CAT project file first.

Examples #

cat.open_project("D:/Testing/DwhTests.cat.yaml")
for l in cat.get_data_source_lists():
    print(l.Order, l.Name, l.ProviderNameAndVersion)

Related #

• Introduction — session model, logging, .NET objects, exceptions, plans and the license key.
• Lists.
• get_data_sources.