Interface IConnection
Represents a connection established via IConnectionTemplate. Used to get data provider list.
Inherited Members
Namespace: BiExcellence.OpenBi.Api.Commands.ConnectionTemplates
Assembly: BiExcellence.OpenBi.Api.DataProvider.dll
Syntax
public interface IConnection : IAsyncDisposable
Properties
ConnectionTemplate
Gets the connection template.
Declaration
IConnectionTemplate ConnectionTemplate { get; }
Property Value
| Type | Description |
|---|---|
| IConnectionTemplate |
DataProviderName
Gets the data provider name.
Declaration
string DataProviderName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
GetDataProvidersAsync(bool?, bool?, bool?, CancellationToken)
Returns a list of data providers for the connection.
Declaration
Task<IList<IDataProviderNode>> GetDataProvidersAsync(bool? withCombined = null, bool? withKpis = null, bool? withScorecards = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| bool? | withCombined | |
| bool? | withKpis | |
| bool? | withScorecards | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<IList<IDataProviderNode>> |