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 Hierarchy

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

The RelationalDataProvider type exposes the following members.

Constructors
  NameDescription
Protected methodRelationalDataProvider
Initializes a new instance of the RelationalDataProvider 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 propertyGenericCountExpression
Gets the generic count expression for number of queried records.
Public propertyHasCustomConfigurationUI
Gets a value indicating whether this data provider is using a custom configuration UI.
(Inherited from DataProvider.)
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.
(Inherited from DataProvider.)
Public propertyMaximumParameterValueCount
Gets the maximum number of parameter values the provider is able to support.
(Inherited from DataProvider.)
Public propertyNamedParameterFormat
Gets the named parameter format.
(Inherited from DataProvider.)
Public propertyNullReplacementExpression
Gets the NULL replacement expression or if not supported.
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.
(Inherited from DataProvider.)
Public propertyQueryHints
Gets the query hints that are supported by the current provider.
(Inherited from DataProvider.)
Public propertyRequiresAllColumnDefinitionsWhenReadingFromManualQueries
Gets a value indicating if all column definitions must be supplied when retrieving data using a manual query.
Public propertySupportedDateTrimGranularities
Gets the supported date trimming functions.
Public propertySupportedStructureTypes
Gets the supported data structures.
(Overrides DataProviderSupportedStructureTypes.)
Public propertySupportsManualQuery
Gets a value indicating whether this data provider supports manual queries.
(Inherited from DataProvider.)
Public propertySupportsParameterPushDown
Gets a value indicating whether this data provider supports pushing parameters into queries.
(Overrides DataProviderSupportsParameterPushDown.)
Public propertySupportsSessionSchemas
Gets a value indicating whether this data provider supports session schemas.
(Overrides DataProviderSupportsSessionSchemas.)
Public propertySupportsTopOneElementDiscovery
Gets a value indicating whether this data provider supports top one element discovery behaviour.
(Inherited from DataProvider.)
Public propertyUsingProviderData (Inherited from DataProvider.)
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.
(Inherited from DataProvider.)
Public methodAreCompatible
Determines if two connectors are compatible for possible generation of single SQL.
Public methodBuildConnectionString
Builds the connection string.
(Inherited from DataProvider.)
Protected methodCreateReader
Creates the reader for the specified query object.
Public methodCreateTable
Creates a database table.
Public methodCreateTemporaryTable
Creates a temporary table.
Public methodDiscoverColumns
Discovers the columns for the specified query object.
Public methodDiscoverStructure(IDisposable, DataStructure)
Discovers the structure definition.
(Inherited from DataProvider.)
Public methodDiscoverStructure(IDisposable, SupportedDataStructures, String)
Gets the structure definition with the specified name.
(Inherited from DataProvider.)
Public methodDiscoverStructures
Gets the list of the structures with the specified type.
(Inherited from DataProvider.)
Public methodEnumerateCustom
Enumerates the provider-specific values.
(Inherited from DataProvider.)
Public methodEnumerateDatabases
Enumerates the available databases.
(Inherited from DataProvider.)
Public methodEnumerateServers
Enumerates the available database servers.
(Inherited from DataProvider.)
Public methodGenerateDefaultDataConnector
Generates default data connector.
(Inherited from DataProvider.)
Public methodGenerateFunctionCall
Generates the statement that calls the table-valued function.
Public methodGenerateQuery
Generates the query.
Public methodGetBasicStructureDetails
Get basic details of the structure.
(Inherited from DataProvider.)
Public methodGetCapabilities
Gets the relational provider capabilities.
Public methodGetCastExpression
Gets a data conversion expression, used in general for avoiding overflow exceptions when using aggregates.
Public methodGetConnection
Gets the open connection.
(Inherited from DataProvider.)
Public methodGetCredentialsProviderId
Gets the ID of the credentials provider.
(Inherited from DataProvider.)
Public methodGetCustomConfigurationUI
Gets the custom configuration UI based on the requested content type.
(Inherited from DataProvider.)
Public methodGetDataCacheKey
Gets the data cache key.
(Inherited from DataProvider.)
Public methodGetDateTrimFunction(DateTimeGranularity, String)
Returns a function that can be used to 'trim date/time' values to a specified grain.
Public methodGetDateTrimFunction(IProviderConnector, DateTimeGranularity, String)
Returns a function that can be used to 'trim date/time' values to a specified grain.
Public methodGetDefaultStructureName
Gets the default structure name.
(Inherited from DataProvider.)
Public methodGetDiagnosticInfo
Gets diagnostic information about the data provider.
(Inherited from DataProvider.)
Public methodGetOpenReader(IDisposable, QueryDefinition)
Creates and opens the reader for the specified query object.
Protected methodGetOpenReader(IDisposable, QueryDefinition, CommandBehavior)
Creates and opens the reader for the specified query object.
Public methodGetRemoteConnectionMetadata
Gets the remote connection specific metadata.
Public methodGetRemoteMetadata
Gets the remote metadata.
Public methodGetSingleRecord
Returns the updated query statement with limit/top function wrapped with select query.
Protected methodGetSingleRecordWithLimit
Returns the updated query statement with limit function wrapped within select query.
Protected methodGetSingleRecordWithLimitAndAlias
Returns the updated query statement with limit function with alias wrapped within select query.
Protected methodGetSingleRecordWithTop
Returns the updated query statement with top function wrapped within select query.
Public methodGetSupportedAggregators
Gets the supported aggregators.
Public methodIsDriverInstalled
Determines whether third party driver required for this data provider is installed.
(Inherited from DataProvider.)
Public methodIsUsingUploadedFile
Determines whether the connection is made to a file stored in Dundas BI database.
(Inherited from DataProvider.)
Public methodLoadDynamicProviderValues
Loads the dynamically retrieved provider values.
(Inherited from DataProvider.)
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.
(Inherited from DataProvider.)
Public methodMakeCompatible
Returns structure name from a different database.
Public methodNormalizeName
Escapes special characters or reserved words in a name.
Public methodOnGetReader
Public methodOnProviderValuesLoaded
Allows the data provider a chance to view and modify the ProviderValues after they are retrieved from the Dundas BI database.
(Inherited from DataProvider.)
Public methodParseStructureName
Parses the structure name.
Public methodProcessTask
Processes the current task if the task is compatible with the data provider.
(Overrides DataProviderProcessTask(ProviderTransformTask).)
Public methodSetConnectionSchema
Sets the schema on the connection.
Public methodTestConnection
Tests the connection.
(Inherited from DataProvider.)
Public methodUpdateFromConnectionString
Updates from connection string.
(Inherited from DataProvider.)
Public methodValidateProviderValues
Validates data ProviderValues after they are retrieved from the Dundas BI database.
(Inherited from DataProvider.)
Public methodValidateSchema
Determines if the schema is valid. Schema name can only contain alpha numeric character, underscore and hyphen.
Top
See Also