Method DescribeCatalog

Namespace: ReportWright.Data

Assembly: ReportWright.Data.Abstractions.dll

DescribeCatalog(ReportDefinition, string, CancellationToken)

Describes a data source's tables, columns and relationships, for the query designer.

public DataSourceCatalog? DescribeCatalog(ReportDefinition definition, string dataSourceName, CancellationToken cancellationToken)

Parameters

definition ReportDefinition: The report.
dataSourceName string: The data source's name as the report states it.
cancellationToken CancellationToken: Cancels the description.

Returns

DataSourceCatalog: The catalog, or null when the source's provider cannot describe it.

Exceptions

DataSourceNotResolvedException: The host resolves nothing for the data source.
DataSourceException: The source could not be described.