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 HierarchySystemObject
Dundas.BI.ExtensibilityComponentBase
Dundas.BI.Data.DataProvidersDataProvider
Dundas.BI.Data.DataProviders.OlapOlapDataProvider
Dundas.BI.Data.DataProvidersPlaceholderProvider
Dundas.BI.Data.DataProviders.RelationalRelationalDataProvider
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 (25.3.0.1000)
SyntaxThe DataProvider type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataProvider | Initializes a new instance of the DataProvider class |
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.) |
| JdbcParameterInitializer |
Gets the value of the character that is used to prefix JDBC parameters.
|
| JdbcParameterSeparator |
Gets the value of the character that is used to separate JDBC parameters.
|
| JdbcRegex |
Gets the Regex of the provider to help extract provider values from jdbc connection string.
|
| JdbcSubProtocol |
Gets the value of the JDBC subprotocol.
|
| 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.
|
| SubStorageType |
Gets the value of the provider's Sub Storage Type in Data Discovery.
|
| SupportedStructureTypes |
Gets the supported data structures.
|
| 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.
|
| 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).
|
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. |
 | GetBasicProviderValues |
Generates a collection of parameter values based on the provided host, port, and database information.
|
| 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. |
| GetJdbcProviderValues |
Retrieves a list of JDBC provider values based on the specified data connector.
|
| 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.
|
| ParseJdbcConnectionString |
Parses a JDBC connection string and extracts provider-specific parameter values.
|
| ProcessTask |
Processes the current task if the task is compatible with the data provider.
|
| ResolveProviderPropertyValue |
Resolves the value of a provider property into a ParameterValue instance.
|
| TestConnection |
Tests the connection.
|
| UpdateFromConnectionString |
Updates from connection string.
|
| ValidateProviderValues |
Validates data ProviderValues after they are retrieved from the Dundas BI database.
|
See Also