RelationalDataProvider Class |
The base relational data provider.
This class is not intended to be used directly from your code, unless
you are implementing a custom data provider.
Inheritance HierarchySystemObject
Dundas.BI.ExtensibilityComponentBase
Dundas.BI.Data.DataProvidersDataProvider
Dundas.BI.Data.DataProviders.RelationalRelationalDataProvider
Dundas.BI.Data.DataProviders.SpecialTabularProvider
Dundas.BI.ExtensibilityComponentBase
Dundas.BI.Data.DataProvidersDataProvider
Dundas.BI.Data.DataProviders.RelationalRelationalDataProvider
Dundas.BI.Data.DataProviders.SpecialTabularProvider
Namespace: Dundas.BI.Data.DataProviders.Relational
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (25.3.0.1000)
SyntaxThe RelationalDataProvider type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RelationalDataProvider | Initializes a new instance of the RelationalDataProvider 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.) |
| GenericCountExpression |
Gets the generic count expression for number of queried records.
|
| HasCustomConfigurationUI |
Gets a value indicating whether this data provider is using a custom configuration UI.
(Inherited from DataProvider.) |
| 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.
(Inherited from DataProvider.) |
| JdbcParameterSeparator |
Gets the value of the character that is used to separate JDBC parameters.
(Inherited from DataProvider.) |
| JdbcRegex |
Gets the Regex of the provider to help extract provider values from jdbc connection string.
(Inherited from DataProvider.) |
| JdbcSubProtocol |
Gets the value of the JDBC subprotocol.
(Inherited from DataProvider.) |
| ManualAuthentication |
Gets a value indicating whether the data provider is expecting no external authentication.
(Inherited from DataProvider.) |
| MaximumParameterValueCount |
Gets the maximum number of parameter values the provider is able to support.
(Inherited from DataProvider.) |
| NamedParameterFormat |
Gets the named parameter format.
(Inherited from DataProvider.) |
| NullReplacementExpression |
Gets the NULL replacement expression or if not supported.
|
| PackageId |
Gets the ID of the extension package to which the component belongs.
(Inherited from ComponentBase.) |
| PropertyDescriptors |
Gets the data provider specific property descriptors.
(Inherited from DataProvider.) |
| QueryHints |
Gets the query hints that are supported by the current provider.
(Inherited from DataProvider.) |
| RequiresAllColumnDefinitionsWhenReadingFromManualQueries |
Gets a value indicating if all column definitions must be supplied when retrieving data using a manual query.
|
| SingleValueArrayFilterExpression |
Gets the single value array filter format or Empty if not supported.
|
| SubStorageType |
Gets the value of the provider's Sub Storage Type in Data Discovery.
(Inherited from DataProvider.) |
| SupportedDateTrimGranularities |
Gets the supported date trimming functions.
|
| SupportedStructureTypes |
Gets the supported data structures.
(Overrides DataProviderSupportedStructureTypes.) |
| SupportsManualQuery |
Gets a value indicating whether this data provider supports manual queries.
(Inherited from DataProvider.) |
| SupportsParameterPushDown |
Gets a value indicating whether this data provider supports pushing parameters into queries.
(Overrides DataProviderSupportsParameterPushDown.) |
| SupportsSessionSchemas |
Gets a value indicating whether this data provider supports session schemas.
(Overrides DataProviderSupportsSessionSchemas.) |
| SupportsTopOneElementDiscovery |
Gets a value indicating whether this data provider supports top one element discovery behaviour.
(Inherited from DataProvider.) |
| UsingProviderData |
Gets a value indicating whether this data provider calls LoadProviderData and SaveProviderData(String).
(Inherited from DataProvider.) |
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.
(Inherited from DataProvider.) |
| AreCompatible |
Determines if two connectors are compatible for possible generation of single SQL.
|
| BuildConnectionString |
Builds the connection string.
(Inherited from DataProvider.) |
| CreateReader |
Creates the reader for the specified query object.
|
| CreateTable |
Creates a database table.
|
| CreateTemporaryTable |
Creates a temporary table.
|
| DiscoverColumns |
Discovers the columns for the specified query object.
|
| DiscoverStructure(IDisposable, DataStructure) |
Discovers the structure definition.
(Inherited from DataProvider.) |
| DiscoverStructure(IDisposable, SupportedDataStructures, String) |
Gets the structure definition with the specified name.
(Inherited from DataProvider.) |
| DiscoverStructures |
Gets the list of the structures with the specified type.
(Inherited from DataProvider.) |
| EnumerateCustom |
Enumerates the provider-specific values.
(Inherited from DataProvider.) |
| EnumerateDatabases |
Enumerates the available databases.
(Inherited from DataProvider.) |
| EnumerateServers |
Enumerates the available database servers.
(Inherited from DataProvider.) |
| GenerateDefaultDataConnector | Generates default data connector. (Inherited from DataProvider.) |
| GenerateFunctionCall |
Generates the statement that calls the table-valued function.
|
| GenerateQuery |
Generates the query.
|
| GetBasicStructureDetails |
Get basic details of the structure.
(Inherited from DataProvider.) |
| GetCapabilities |
Gets the relational provider capabilities.
|
| GetCastExpression |
Gets a data conversion expression, used in general for avoiding overflow exceptions when using aggregates.
|
| GetCollectionValueArrayFilterExpression |
Gets the collection value array filter expression.
|
| GetConnection |
Gets the open connection.
(Inherited from DataProvider.) |
| GetCredentialsProviderId |
Gets the ID of the credentials provider.
(Inherited from DataProvider.) |
| GetCustomConfigurationUI |
Gets the custom configuration UI based on the requested content type.
(Inherited from DataProvider.) |
| GetDataCacheKey |
Gets the data cache key.
(Inherited from DataProvider.) |
| GetDateTrimFunction(DateTimeGranularity, String) |
Returns a function that can be used to 'trim date/time' values to a specified grain.
|
| GetDateTrimFunction(IProviderConnector, DateTimeGranularity, String) |
Returns a function that can be used to 'trim date/time' values to a specified grain.
|
| GetDefaultStructureName |
Gets the default structure name.
(Inherited from DataProvider.) |
| GetDiagnosticInfo | Gets diagnostic information about the data provider. (Inherited from DataProvider.) |
| GetJdbcProviderValues |
Retrieves a list of JDBC provider values based on the specified data connector.
(Inherited from DataProvider.) |
| GetOpenReader(IDisposable, QueryDefinition) |
Creates and opens the reader for the specified query object.
|
| GetOpenReader(IDisposable, QueryDefinition, CommandBehavior) |
Creates and opens the reader for the specified query object.
|
| GetRemoteConnectionMetadata |
Gets the remote connection specific metadata.
|
| GetRemoteMetadata |
Gets the remote metadata.
|
| GetSingleRecord |
Returns the updated query statement with limit/top function wrapped with select query.
|
| GetSingleRecordWithLimit |
Returns the updated query statement with limit function wrapped within select query.
|
| GetSingleRecordWithLimitAndAlias |
Returns the updated query statement with limit function with alias wrapped within select query.
|
| GetSingleRecordWithTop |
Returns the updated query statement with top function wrapped within select query.
|
| GetSupportedAggregators |
Gets the supported aggregators.
|
| IsDriverInstalled |
Determines whether third party driver required for this data provider is installed.
(Inherited from DataProvider.) |
| IsUsingUploadedFile |
Determines whether the connection is made to a file stored in Dundas BI database.
(Inherited from DataProvider.) |
| LoadDynamicProviderValues | Loads the dynamically retrieved provider values. (Inherited from DataProvider.) |
| 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.
(Inherited from DataProvider.) |
| MakeCompatible |
Returns structure name from a different database.
|
| NormalizeName |
Escapes special characters or reserved words in a name.
|
| OnGetReader |
Called when GetOpenReader(IDisposable, QueryDefinition) is called.
|
| OnProviderValuesLoaded |
Allows the data provider a chance to view and modify the ProviderValues after they are retrieved from the Dundas BI database.
(Inherited from DataProvider.) |
| ParseJdbcConnectionString |
Parses a JDBC connection string and extracts provider-specific parameter values.
(Inherited from DataProvider.) |
| ParseStructureName |
Parses the structure name.
|
| ProcessTask |
Processes the current task if the task is compatible with the data provider.
(Overrides DataProviderProcessTask(ProviderTransformTask).) |
| SetConnectionSchema |
Sets the schema on the connection.
|
| TestConnection |
Tests the connection.
(Inherited from DataProvider.) |
| UpdateFromConnectionString |
Updates from connection string.
(Inherited from DataProvider.) |
| ValidateProviderValues |
Validates data ProviderValues after they are retrieved from the Dundas BI database.
(Inherited from DataProvider.) |
| ValidateSchema |
Determines if the schema is valid. Schema name can only contain alpha numeric character, underscore and hyphen.
|
| ValidateSchemaAgainstServer |
Validates the schema name against the actual source.
|
See Also