A Sandcastle Documented Class Library

# DataProvider Class

Base class for all data providers.
This class supports the application infrastructure and is not intended to be used directly from your code.
Inheritance Hierarchy
System
Object
Dundas.BI.Extensibility
ComponentBase
Dundas.BI.Data.DataProviders
DataProvider
Dundas.BI.Data.DataProviders.Olap
OlapDataProvider
Dundas.BI.Data.DataProviders
PlaceholderProvider
Dundas.BI.Data.DataProviders.Relational
RelationalDataProvider

Namespace: Dundas.BI.Data.DataProviders
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
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.)
| Logger | Gets the logger for the module or extension package corresponding to the component. (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.
| SupportsManualQuery | Gets a value indicating whether this data provider supports manual queries.
| UsingProviderData | Gets a value indicating whether this data provider calls LoadProviderData and SaveProviderData(String).

Top
Methods

| Name | Description
--- | --- | ---
| 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.
| 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.
| 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.
| 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.
| ProcessTask | Processes the current task if the task is compatible with the data provider.
| TestConnection | Tests the connection.
| UpdateFromConnectionString | Updates from connection string.

Top
See Also

#### Reference

Dundas.BI.Data.DataProviders Namespace