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

Namespace:  Dundas.BI.Data.DataProviders
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax
public abstract class DataProvider : ComponentBase

The DataProvider type exposes the following members.

Constructors
  NameDescription
Protected methodDataProvider
Initializes a new instance of the DataProvider class
Top
Properties
  NameDescription
Public propertyComponentDescription
Gets the standard component description.
(Inherited from ComponentBase.)
Public propertyComponentId
Gets the component ID.
(Inherited from ComponentBase.)
Public propertyComponentName
Gets the standard component name.
(Inherited from ComponentBase.)
Public propertyHasCustomConfigurationUI
Gets a value indicating whether this data provider is using a custom configuration UI.
Public propertyIsEnabled
Gets a value indicating whether the component is enabled.
(Inherited from ComponentBase.)
Public propertyManualAuthentication
Gets a value indicating whether the data provider is expecting no external authentication.
Public propertyMaximumParameterValueCount
Gets the maximum number of parameter values the provider is able to support.
Public propertyNamedParameterFormat
Gets the named parameter format.
Public propertyPackageId
Gets the ID of the extension package to which the component belongs.
(Inherited from ComponentBase.)
Public propertyPropertyDescriptors
Gets the data provider specific property descriptors.
Public propertyQueryHints
Gets the query hints that are supported by the current provider.
Public propertySupportedStructureTypes
Gets the supported data structures.
Public propertySupportsManualQuery
Gets a value indicating whether this data provider supports manual queries.
Public propertySupportsParameterPushDown
Gets a value indicating whether this data provider supports pushing parameters into queries.
Public propertySupportsSessionSchemas
Gets a value indicating whether this data provider supports session schemas.
Public propertySupportsTopOneElementDiscovery
Gets a value indicating whether this data provider supports top one element discovery behaviour.
Public propertyUsingProviderData
Top
Methods
  NameDescription
Public methodAllowStoringResult
Gets a value indicating whether the data returned by this provider can be put into cache or used in storage jobs.
Public methodBuildConnectionString
Builds the connection string.
Public methodDiscoverStructure(IDisposable, DataStructure)
Discovers the structure definition.
Public methodDiscoverStructure(IDisposable, SupportedDataStructures, String)
Gets the structure definition with the specified name.
Public methodDiscoverStructures
Gets the list of the structures with the specified type.
Public methodEnumerateCustom
Enumerates the provider-specific values.
Public methodEnumerateDatabases
Enumerates the available databases.
Public methodEnumerateServers
Enumerates the available database servers.
Public methodGenerateDefaultDataConnector
Generates default data connector.
Public methodGetBasicStructureDetails
Get basic details of the structure.
Public methodGetConnection
Gets the open connection.
Public methodGetCredentialsProviderId
Gets the ID of the credentials provider.
Public methodGetCustomConfigurationUI
Gets the custom configuration UI based on the requested content type.
Public methodGetDataCacheKey
Gets the data cache key.
Public methodGetDefaultStructureName
Gets the default structure name.
Public methodGetDiagnosticInfo
Gets diagnostic information about the data provider.
Public methodIsDriverInstalled
Determines whether third party driver required for this data provider is installed.
Public methodIsUsingUploadedFile
Determines whether the connection is made to a file stored in Dundas BI database.
Public methodLoadDynamicProviderValues
Loads the dynamically retrieved provider values.
Protected methodLocalize
Localizes the specified string using the engine localization service.
(Inherited from ComponentBase.)
Public methodLogQueryStatement
Logs the query statement into Data.DataRetrieval.QueryAudit channel at the Information level.
Public methodOnProviderValuesLoaded
Allows the data provider a chance to view and modify the ProviderValues after they are retrieved from the Dundas BI database.
Public methodProcessTask
Processes the current task if the task is compatible with the data provider.
Public methodTestConnection
Tests the connection.
Public methodUpdateFromConnectionString
Updates from connection string.
Public methodValidateProviderValues
Validates data ProviderValues after they are retrieved from the Dundas BI database.
Top
See Also