DataProviderInfo Class

This is a Library topic for Data Abstract for .NET
This page is generated from external data, please do not update

Namespaces — Interfaces — Classes — Enums — Implements

Overview

DataProviderInfo is a class that stores information about ADO.NET providers known to the server application.

This class is used by other classes in the RemObjects.DataAbstract.Server assembly to obtain database specific information, for example, ConnectionStringParser uses this class to build a connection string. The Configuration class will load a list of DataProviderInfo from configuration data on server start. In most cases, you will not use this class directly, but if you wish to add your own database driver, you can describe it in the configuration file as shown in this article.

Location

• Assembly: RemObjects.DataAbstract.Server.dll
• Namespace: RemObjects.DataAbstract.Server
• Ancestry: NamedObject | DataProviderInfo

Properties

AssemblyName
This property is used internally by the GetFactory method to load specific assemblies (for example, FirebirdSql.Data.FirebirdClient, Version=2.5.1.0, Culture=neutral, PublicKeyToken=3750abcc3150b00c). Can be null if the ProviderName property is specified. Prism:   property AssemblyName: String read C#:   String AssemblyName { get; } VB:   Property ReadOnly AssemblyName As String
CommandBuilderClassName
This property, as well as ConnectionClassName, will be used internally in the InternalProviderFactory which is created by the GetFactory method if no value for FactoryClassName is set. Prism:   property CommandBuilderClassName: String read C#:   String CommandBuilderClassName { get; } VB:   Property ReadOnly CommandBuilderClassName As String
ConnectionClassName
Prism:   property ConnectionClassName: String read C#:   String ConnectionClassName { get; } VB:   Property ReadOnly ConnectionClassName As String
DefaultProfileMapping
Returns default ProfileMapping from the DriverProfiles list. The default profile is one whose name equals "*". Prism:   property DefaultProfileMapping: ProfileMapping read C#:   ProfileMapping DefaultProfileMapping { get; } VB:   Property ReadOnly DefaultProfileMapping As ProfileMapping
Description
Prism:   property Description: String read C#:   String Description { get; } VB:   Property ReadOnly Description As String
DriverBased
Indicates that driver specific ProfileMapping should be used. Prism:   property DriverBased: Boolean read C#:   Boolean DriverBased { get; } VB:   Property ReadOnly DriverBased As Boolean
DriverNotFoundText
Prism:   property DriverNotFoundText: String read C#:   String DriverNotFoundText { get; } VB:   Property ReadOnly DriverNotFoundText As String
DriverProfiles
Prism:   property DriverProfiles: NamedObjectCollection<ProfileMapping> read C#:   NamedObjectCollection<ProfileMapping> DriverProfiles { get; } VB:   Property ReadOnly DriverProfiles As NamedObjectCollection<ProfileMapping>
FactoryClassName
This property indicates the name of the factory instance that must be acquired from the driver assembly by the GetFactory method. Prism:   property FactoryClassName: String read C#:   String FactoryClassName { get; } VB:   Property ReadOnly FactoryClassName As String
NewConnectionHelpText
Prism:   property NewConnectionHelpText: String read C#:   String NewConnectionHelpText { get; } VB:   Property ReadOnly NewConnectionHelpText As String
OptionalParams
List of parameters that will be added to the connection string (for example, for a MSSQL.net provider, it would be the "Integrated Security=SSPI" parameter). Prism:   property OptionalParams: List<String> read C#:   List<String> OptionalParams { get; } VB:   Property ReadOnly OptionalParams As List<String>
OriginalDriverParamName
Prism:   property OriginalDriverParamName: String read C#:   String OriginalDriverParamName { get; } VB:   Property ReadOnly OriginalDriverParamName As String
ParameterHandling
Indicates how the driver handles encoding of parameters within SQL queries. Parameters can either be handled sequentially (i.e. based on the order of their occurrence in the query text), or by name. Prism:   property ParameterHandling: ParameterHandling read C#:   ParameterHandling ParameterHandling { get; } VB:   Property ReadOnly ParameterHandling As ParameterHandling
ParameterNameSymbol
Symbol that indicates a driver specific parameter prefix (for example, for MSSQL.Net, the value is "@"). Prism:   property ParameterNameSymbol: String read C#:   String ParameterNameSymbol { get; } VB:   Property ReadOnly ParameterNameSymbol As String
ParameterSQLSymbol
Symbol that indicates an SQL specific parameter prefix (for example, for ORACLE.Net, the value is ":"). Prism:   property ParameterSQLSymbol: String read C#:   String ParameterSQLSymbol { get; } VB:   Property ReadOnly ParameterSQLSymbol As String
ProviderName
Prism:   property ProviderName: String read C#:   String ProviderName { get; } VB:   Property ReadOnly ProviderName As String
Validated
Prism:   property Validated: Boolean read C#:   Boolean Validated { get; } VB:   Property ReadOnly Validated As Boolean
ValidationError
Prism:   property ValidationError: String read C#:   String ValidationError { get; } VB:   Property ReadOnly ValidationError As String

Instance Methods

constructor
Creates a new instance of DataProviderInfo and loads information from the aXmlNode parameter. If the configuration settings are invalid, the DAConfigurationError exception will be raised. Oxygene:   constructor(aXmlNode: XmlNode; aNameChangeNotification: INameChangeNotification) C#:   constructor(XmlNode aXmlNode, INameChangeNotification aNameChangeNotification) VB:   Sub New (aXmlNode As XmlNode, aNameChangeNotification As INameChangeNotification) Parameters: aXmlNode: aNameChangeNotification:
FindProfile
Oxygene:   method FindProfile(aDriverName: String): DatabaseProfile C#:   DatabaseProfile FindProfile(String aDriverName) VB:   Function FindProfile(aDriverName As String) As DatabaseProfile Parameters: aDriverName:
FindProfileMapping
Finds a profile with a specified name within the DriverProfiles list. If the DriverBased property is set to false, DefaultProfileMapping is returned. Oxygene:   method FindProfileMapping(aDriverName: String): ProfileMapping C#:   ProfileMapping FindProfileMapping(String aDriverName) VB:   Function FindProfileMapping(aDriverName As String) As ProfileMapping Parameters: aDriverName:
GetFactory
This method will return the DbProviderFactory depending on class settings. If the ProviderName property is set, the factory class will be acquired from the DbProviderFactories class. Otherwise, an instance of FactoryClassName will be obtained from the assembly or an InternalProviderFactory instance will be created. Oxygene:   method GetFactory: DbProviderFactory C#:   DbProviderFactory GetFactory() VB:   Function GetFactory As DbProviderFactory
GetProfile
Oxygene:   method GetProfile(aDriverName: String): DatabaseProfile C#:   DatabaseProfile GetProfile(String aDriverName) VB:   Function GetProfile(aDriverName As String) As DatabaseProfile Parameters: aDriverName:
GetProfileMapping
Oxygene:   method GetProfileMapping(aDriverName: String): ProfileMapping C#:   ProfileMapping GetProfileMapping(String aDriverName) VB:   Function GetProfileMapping(aDriverName As String) As ProfileMapping Parameters: aDriverName:
Validate
Oxygene:   method Validate C#:   void Validate() VB:   Sub Validate
ValidateDbFactory   protected
Oxygene:   method ValidateDbFactory C#:   void ValidateDbFactory() VB:   Sub ValidateDbFactory

See Also

• Lists
  • Data Abstract for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects SDK for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects Script for .NET:   Namespaces — Classes
  • Data Abstract shared:   Data Types – File Types
  • other editions:
    • Data Abstract for Xcode:   Protocols — Classes — Enums — Implements
    • Data Abstract for Delphi:   Interfaces — Classes — Enums — Aliases — Implements
    • Data Abstract for Java:   Namespaces — Interfaces — Classes — Enums — Implements
    • Data Abstract for JavaScript:   Objects

Product: RemObjects Data Abstract
Available Editions: Data Abstract for .NET, Delphi and Xcode

Glossary — Articles — Features — Library — Samples