DataProviderInfo

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

 

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.

 

constructor(aXmlNode: XmlNode; aNameChangeNotification: INameChangeNotification)

 

DataProviderInfo(XmlNode aXmlNode, INameChangeNotification aNameChangeNotification)

 

Sub New(aXmlNode As XmlNode, aNameChangeNotification As INameChangeNotification)

Parameters:

  • aXmlNode:
  • aNameChangeNotification:

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.

 

property AssemblyName: String read;

 

String AssemblyName { get; }

 

ReadOnly Property 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.

 

property CommandBuilderClassName: String read;

 

String CommandBuilderClassName { get; }

 

ReadOnly Property CommandBuilderClassName() As String

ConnectionClassName

 

property ConnectionClassName: String read;

 

String ConnectionClassName { get; }

 

ReadOnly Property ConnectionClassName() As String

DefaultProfileMapping

Returns default ProfileMapping from the DriverProfiles list. The default profile is one whose name equals "*".

 

property DefaultProfileMapping: ProfileMapping read;

 

ProfileMapping DefaultProfileMapping { get; }

 

ReadOnly Property DefaultProfileMapping() As ProfileMapping

Description

 

property Description: String read;

 

String Description { get; }

 

ReadOnly Property Description() As String

DriverBased

Indicates that driver specific ProfileMapping should be used.

 

property DriverBased: Boolean read;

 

Boolean DriverBased { get; }

 

ReadOnly Property DriverBased() As Boolean

DriverNotFoundText

 

property DriverNotFoundText: String read;

 

String DriverNotFoundText { get; }

 

ReadOnly Property DriverNotFoundText() As String

DriverProfiles

 

property DriverProfiles: RemObjects.Common.Collections.NamedObjectCollection<ProfileMapping> read;

 

RemObjects.Common.Collections.NamedObjectCollection<ProfileMapping> DriverProfiles { get; }

 

ReadOnly Property DriverProfiles() As RemObjects.Common.Collections.NamedObjectCollection<ProfileMapping>

FactoryClassName

This property indicates the name of the factory instance that must be acquired from the driver assembly by the GetFactory method.

 

property FactoryClassName: String read;

 

String FactoryClassName { get; }

 

ReadOnly Property FactoryClassName() As String

FindProfile

 

method FindProfile(aDriverName: String): DatabaseProfile

 

DatabaseProfile FindProfile(String aDriverName)

 

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.

 

method FindProfileMapping(aDriverName: String): ProfileMapping

 

ProfileMapping FindProfileMapping(String aDriverName)

 

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.

 

method GetFactory: DbProviderFactory

 

DbProviderFactory GetFactory()

 

Function GetFactory() As DbProviderFactory

GetProfile

 

method GetProfile(aDriverName: String): DatabaseProfile

 

DatabaseProfile GetProfile(String aDriverName)

 

Function GetProfile(aDriverName As String) As DatabaseProfile

Parameters:

  • aDriverName:

GetProfileMapping

 

method GetProfileMapping(aDriverName: String): ProfileMapping

 

ProfileMapping GetProfileMapping(String aDriverName)

 

Function GetProfileMapping(aDriverName As String) As ProfileMapping

Parameters:

  • aDriverName:

NewConnectionHelpText

 

property NewConnectionHelpText: String read;

 

String NewConnectionHelpText { get; }

 

ReadOnly Property 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).

 

property OptionalParams: List<String> read;

 

List<String> OptionalParams { get; }

 

ReadOnly Property OptionalParams() As List<String>

OriginalDriverParamName

 

property OriginalDriverParamName: String read;

 

String OriginalDriverParamName { get; }

 

ReadOnly Property 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.

 

property ParameterHandling: ParameterHandling read;

 

ParameterHandling ParameterHandling { get; }

 

ReadOnly Property ParameterHandling() As ParameterHandling

ParameterNameSymbol

Symbol that indicates a driver specific parameter prefix (for example, for MSSQL.Net, the value is "@").

 

property ParameterNameSymbol: String read;

 

String ParameterNameSymbol { get; }

 

ReadOnly Property ParameterNameSymbol() As String

ParameterSQLSymbol

Symbol that indicates an SQL specific parameter prefix (for example, for ORACLE.Net, the value is ":").

 

property ParameterSQLSymbol: String read;

 

String ParameterSQLSymbol { get; }

 

ReadOnly Property ParameterSQLSymbol() As String

ProviderName

 

property ProviderName: String read;

 

String ProviderName { get; }

 

ReadOnly Property ProviderName() As String

Validate

 

method Validate

 

void Validate()

 

Sub Validate()

Validated

 

property Validated: Boolean read;

 

Boolean Validated { get; }

 

ReadOnly Property Validated() As Boolean

ValidateDbFactory  protected

 

method ValidateDbFactory

 

void ValidateDbFactory()

 

Sub ValidateDbFactory()

ValidationError

 

property ValidationError: String read;

 

String ValidationError { get; }

 

ReadOnly Property ValidationError() As String

 

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.

 

property AssemblyName: String read;

 

String AssemblyName { get; }

 

ReadOnly Property 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.

 

property CommandBuilderClassName: String read;

 

String CommandBuilderClassName { get; }

 

ReadOnly Property CommandBuilderClassName() As String

ConnectionClassName

 

property ConnectionClassName: String read;

 

String ConnectionClassName { get; }

 

ReadOnly Property ConnectionClassName() As String

DefaultProfileMapping

Returns default ProfileMapping from the DriverProfiles list. The default profile is one whose name equals "*".

 

property DefaultProfileMapping: ProfileMapping read;

 

ProfileMapping DefaultProfileMapping { get; }

 

ReadOnly Property DefaultProfileMapping() As ProfileMapping

Description

 

property Description: String read;

 

String Description { get; }

 

ReadOnly Property Description() As String

DriverBased

Indicates that driver specific ProfileMapping should be used.

 

property DriverBased: Boolean read;

 

Boolean DriverBased { get; }

 

ReadOnly Property DriverBased() As Boolean

DriverNotFoundText

 

property DriverNotFoundText: String read;

 

String DriverNotFoundText { get; }

 

ReadOnly Property DriverNotFoundText() As String

DriverProfiles

 

property DriverProfiles: RemObjects.Common.Collections.NamedObjectCollection<ProfileMapping> read;

 

RemObjects.Common.Collections.NamedObjectCollection<ProfileMapping> DriverProfiles { get; }

 

ReadOnly Property DriverProfiles() As RemObjects.Common.Collections.NamedObjectCollection<ProfileMapping>

FactoryClassName

This property indicates the name of the factory instance that must be acquired from the driver assembly by the GetFactory method.

 

property FactoryClassName: String read;

 

String FactoryClassName { get; }

 

ReadOnly Property FactoryClassName() As String

NewConnectionHelpText

 

property NewConnectionHelpText: String read;

 

String NewConnectionHelpText { get; }

 

ReadOnly Property 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).

 

property OptionalParams: List<String> read;

 

List<String> OptionalParams { get; }

 

ReadOnly Property OptionalParams() As List<String>

OriginalDriverParamName

 

property OriginalDriverParamName: String read;

 

String OriginalDriverParamName { get; }

 

ReadOnly Property 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.

 

property ParameterHandling: ParameterHandling read;

 

ParameterHandling ParameterHandling { get; }

 

ReadOnly Property ParameterHandling() As ParameterHandling

ParameterNameSymbol

Symbol that indicates a driver specific parameter prefix (for example, for MSSQL.Net, the value is "@").

 

property ParameterNameSymbol: String read;

 

String ParameterNameSymbol { get; }

 

ReadOnly Property ParameterNameSymbol() As String

ParameterSQLSymbol

Symbol that indicates an SQL specific parameter prefix (for example, for ORACLE.Net, the value is ":").

 

property ParameterSQLSymbol: String read;

 

String ParameterSQLSymbol { get; }

 

ReadOnly Property ParameterSQLSymbol() As String

ProviderName

 

property ProviderName: String read;

 

String ProviderName { get; }

 

ReadOnly Property ProviderName() As String

Validated

 

property Validated: Boolean read;

 

Boolean Validated { get; }

 

ReadOnly Property Validated() As Boolean

ValidationError

 

property ValidationError: String read;

 

String ValidationError { get; }

 

ReadOnly Property ValidationError() As String

 

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.

 

constructor(aXmlNode: XmlNode; aNameChangeNotification: INameChangeNotification)

 

DataProviderInfo(XmlNode aXmlNode, INameChangeNotification aNameChangeNotification)

 

Sub New(aXmlNode As XmlNode, aNameChangeNotification As INameChangeNotification)

Parameters:

  • aXmlNode:
  • aNameChangeNotification:

FindProfile

 

method FindProfile(aDriverName: String): DatabaseProfile

 

DatabaseProfile FindProfile(String aDriverName)

 

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.

 

method FindProfileMapping(aDriverName: String): ProfileMapping

 

ProfileMapping FindProfileMapping(String aDriverName)

 

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.

 

method GetFactory: DbProviderFactory

 

DbProviderFactory GetFactory()

 

Function GetFactory() As DbProviderFactory

GetProfile

 

method GetProfile(aDriverName: String): DatabaseProfile

 

DatabaseProfile GetProfile(String aDriverName)

 

Function GetProfile(aDriverName As String) As DatabaseProfile

Parameters:

  • aDriverName:

GetProfileMapping

 

method GetProfileMapping(aDriverName: String): ProfileMapping

 

ProfileMapping GetProfileMapping(String aDriverName)

 

Function GetProfileMapping(aDriverName As String) As ProfileMapping

Parameters:

  • aDriverName:

Validate

 

method Validate

 

void Validate()

 

Sub Validate()

ValidateDbFactory  protected

 

method ValidateDbFactory

 

void ValidateDbFactory()

 

Sub ValidateDbFactory()