DataProvider Class

Base class for all data providers.

Inheritance Hierarchy

SystemObject
  Dundas.BI.ExtensibilityComponentBase
    Dundas.BI.Data.DataProvidersDataProvider
      Dundas.BI.Data.DataProviders.OlapOlapDataProvider
      Dundas.BI.Data.DataProvidersPlaceholderProvider
      Dundas.BI.Data.DataProviders.RelationalRelationalDataProvider

Namespace: Dundas.BI.Data.DataProviders
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)

Syntax

C++

Copy

public abstract class DataProvider : ComponentBase

Public MustInherit Class DataProvider
	Inherits ComponentBase

public ref class DataProvider abstract : public ComponentBase

[<AbstractClassAttribute>]
type DataProvider = 
    class
        inherit ComponentBase
    end

The DataProvider type exposes the following members.

Constructors

	Name	Description
	DataProvider	Initializes a new instance of the DataProvider class

Top

Properties

	Name	Description
	ComponentDescription	Gets the standard component description. (Inherited from ComponentBase)
	ComponentId	Gets the component ID. (Inherited from ComponentBase)
	ComponentName	Gets the standard component name. (Inherited from ComponentBase)
	HasCustomConfigurationUI	Gets a value indicating whether this data provider is using a custom configuration UI.
	IsEnabled	Gets a value indicating whether the component is enabled. (Inherited from ComponentBase)
	ManualAuthentication	Gets a value indicating whether the data provider is expecting no external authentication.
	MaximumParameterValueCount	Gets the maximum number of parameter values the provider is able to support.
	NamedParameterFormat	Gets the named parameter format.
	PackageId	Gets the ID of the extension package to which the component belongs. (Inherited from ComponentBase)
	PropertyDescriptors	Gets the data provider specific property descriptors.
	QueryHints	Gets the query hints that are supported by the current provider.
	SupportedStructureTypes	Gets the supported data structures.
	SupportsArrayFlattening	Gets a value indicating whether the provider supports flattening of array elements.
	SupportsManualQuery	Gets a value indicating whether this data provider supports manual queries.
	SupportsParameterPushDown	Gets a value indicating whether this data provider supports pushing parameters into queries.
	SupportsSelectElementsExpansion	Gets a value indicating whether this provider supports injecting additional elements into a SelectTransform via GetExpandedElements(IListDataParameterValue, DataConnector). When , the transform will call GetExpandedElements(IListDataParameterValue, DataConnector) during refresh and validation to auto-select provider-driven columns (e.g. columns from an OData $expand navigation property).
	SupportsSessionSchemas	Gets a value indicating whether this data provider supports session schemas.
	SupportsTopOneElementDiscovery	Gets a value indicating whether this data provider supports top one element discovery behaviour.
	UsingProviderData	Gets a value indicating whether this data provider calls LoadProviderData and SaveProviderData(String).

Top

Methods

	Name	Description
	AllowStoringResult	Gets a value indicating whether the data returned by this provider can be put into cache or used in storage jobs.
	BuildConnectionString	Builds the connection string.
	DiscoverStructure(IDisposable, DataStructure)	Discovers the structure definition.
	DiscoverStructure(IDisposable, SupportedDataStructures, String)	Gets the structure definition with the specified name.
	DiscoverStructures	Gets the list of the structures with the specified type.
	EnumerateCustom	Enumerates the provider-specific values.
	EnumerateDatabases	Enumerates the available databases.
	EnumerateServers	Enumerates the available database servers.
	GenerateDefaultDataConnector	Generates default data connector.
	GetBasicStructureDetails	Get basic details of the structure.
	GetConnection	Gets the open connection.
	GetCredentialsProviderId	Gets the ID of the credentials provider.
	GetCustomConfigurationUI	Gets the custom configuration UI based on the requested content type.
	GetDataCacheKey	Gets the data cache key.
	GetDefaultStructureName	Gets the default structure name.
	GetDiagnosticInfo	Gets diagnostic information about the data provider.
	GetExpandedElements	Returns additional elements to be used in the SelectTransform.
	GetIncrementalWarehouseSupportType	Gets the type of incremental warehouse support provided by this data provider.
	IsDriverInstalled	Determines whether third party driver required for this data provider is installed.
	IsUsingUploadedFile	Determines whether the connection is made to a file stored in Dundas BI database.
	LoadDynamicProviderValues	Loads the dynamically retrieved provider values.
	Localize	Localizes the specified string using the engine localization service. (Inherited from ComponentBase)
	LogQueryStatement	Logs the query statement into Data.DataRetrieval.QueryAudit channel at the Information level.
	OnProviderValuesLoaded	Allows the data provider a chance to view and modify the ProviderValues after they are retrieved from the Dundas BI database.
	ProcessTask	Processes the current task if the task is compatible with the data provider.
	TestConnection	Tests the connection.
	UpdateFromConnectionString	Updates from connection string.
	ValidateProviderValues	Validates data ProviderValues after they are retrieved from the Dundas BI database.

Top

Reference

Dundas.BI.Data.DataProviders Namespace