TDAEDriver Class

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

Interfaces — Classes — Enums — Aliases — Implements

Overview

The TDAEDriver class is a base class for the DA driver implementation classes in the Data Abstract Architecture. It implements the IDADriver and IDADriver30 interfaces and provides base functionality.

Please refer to the articles Creating Drivers (Data Abstract) and How to create a Data Abstract Driver (Delphi) for an overall description.

Location

uDAEngine.pas

• Ancestry: TComponent | TDAEDriver | Descendants

Implemented interfaces

• IDADriver
• IDADriver30

Instance Methods

destructor Destroy   override
destructor Destroy
CustomizeConnectionObject   protected dynamic
Provides a way to perform additional procedures after acquiring a connection with the NewConnection methods. For example: The TDAEADODriver and TDAEIBXDriver classes use this method to set up TraceFlags. The TDAEDriver implementation does nothing. procedure CustomizeConnectionObject(aConnection: TDAEConnection) Parameters: aConnection: Reference to the used connection
DoSetTraceOptions   protected virtual
Executes actions specific to the implementation to perform event monitoring. The TDAEDriver implementation does nothing. procedure DoSetTraceOptions(TraceActive: boolean; TraceFlags: TDATraceOptions; Callback: TDALogTraceEvent) Parameters: TraceActive: Current mode TraceFlags: Set of TDATraceOption Callback: Method to call in various OnTraceEvent event handlers
Finalize   protected virtual safecall
Implements IDADriver.Finalize to free resources and do other cleanups. The TDAEDriver implementation does nothing. procedure Finalize
GetAuxDrivers   protected virtual safecall
Implements IDADriver.GetAuxDrivers to return a list of available auxiliary drivers. The TDAEDriver implementation initializes a List with empty IROStrings. procedure GetAuxDrivers(out List: IROStrings) Parameters: List: List of auxiliary driver names
GetAuxParams   protected virtual safecall
Implements IDADriver.GetAuxParams to return available driver parameters for a given AuxDriver driver. The TDAEDriver implementation initializes a List with empty IROStrings. procedure GetAuxParams(const AuxDriver: string; out List: IROStrings) Parameters: AuxDriver: Aux driver name in question List: List of auxiliary parameters
GetAvailableDriverOptions   protected virtual safecall
Implements IDADriver.GetAvailableDriverOptions to return a set of TDAAvailableDriverOptions. The TDAEDriver implementation returns [doServerName, doDatabaseName, doLogin]. function GetAvailableDriverOptions: TDAAvailableDriverOptions
GetAvailableDriverOptionsEx   protected virtual safecall
Implements IDADriver.GetAvailableDriverOptionsEx to return a set of TDAAvailableDriverOptions for the given AuxDriver. The TDAEDriver implementation delegates a call to GetAvailableDriverOptions. function GetAvailableDriverOptionsEx(AuxDriver: string): TDAAvailableDriverOptions Parameters: AuxDriver: Aux driver name in question
GetConnectionClass   protected virtual abstract
Abstract method which is used as an Abstract factory to create a concrete implementation of the TDAEConnection. function GetConnectionClass: TDAEConnectionClass
GetDefaultConnectionType   protected virtual safecall
Implements IDADriver.GetDefaultConnectionType by returning an empty string. function GetDefaultConnectionType(const AuxDriver: string): string Parameters: AuxDriver: Aux driver name in question
GetDefaultCustomParameters   protected virtual safecall
Implements IDADriver.GetDefaultCustomParameters by returning an empty string. function GetDefaultCustomParameters: string
GetDescription   protected virtual safecall abstract
Implements IDADriver.GetDescription as an abstract method. function GetDescription: string
GetDriverHelp   protected
Implements IDADriver30.GetDriverHelp by returning the loaded 'DRIVER_HELP' from the resources HTML text. function GetDriverHelp(aType: TDADriverHelpType): string Parameters: aType: See TDADriverHelpType
GetDriverID   protected virtual safecall abstract
Implements IDADriver.GetDriverID as an abstract method. function GetDriverID: string
GetMajVersion   protected virtual safecall
Implements IDADriver.GetMajVersion by returning 1. function GetMajVersion: byte
GetMinVersion   protected virtual safecall
Implements IDADriver.GetMinVersion by returning 0. function GetMinVersion: byte
Initialize   protected virtual safecall
Implements IDADriver.Initialize by doing nothing. procedure Initialize
NewConnection (IDAConnectionManager, TDAConnection): IDAConnection   protected overload safecall
Implements IDADriver.NewConnection by creating a new connection with help of the GetConnectionClass class, initializing its corresponding properties with the given aConnectionManager and aConnectionDefinition, and finally calling CustomizeConnectionObject for a created connection. Returns a created connection. function NewConnection(const aConnectionManager: IDAConnectionManager; aConnectionDefinition: TDAConnection): IDAConnection Parameters: aConnectionManager: Connection manager aConnectionDefinition: Connection parameters
NewConnection (string, string): IDAConnection   protected overload safecall
Implements IDADriver.NewConnection by creating a new aName connection with help of the GetConnectionClass and sets its ConnectionType up to aConnectionType. Returns a created connection. function NewConnection(const aName: string; const aConnectionType: string): IDAConnection Parameters: aName: Connection name aConnectionType: Connection type
SetTraceOptions   protected safecall
Implements IDADriver.SetTraceOptions by delegating a call to DoSetTraceOptions. procedure SetTraceOptions(TraceActive: boolean; TraceFlags: TDATraceOptions; Callback: TDALogTraceEvent) Parameters: TraceActive: TraceFlags: Callback:

Descendants

• TDAElevateDBBaseDriver
• TDAIBBaseDriver
• TDAMSSQLBaseDriver
• TDAMySQLBaseDriver
• TDAOracleBaseDriver
• TDAPostgresBaseDriver
• TDASQLiteBaseDriver

See Also

• Data Abstract Architecture
  • Data Abstract Connections (Delphi)
  • Creating Drivers (Data Abstract)
  • How to create a Data Abstract Driver (Delphi)
  • Drivers
• External links
  • Abstract factory pattern
• Lists
  • Data Abstract for Delphi:   Interfaces — Classes — Enums — Aliases — Implements
    • RemObjects SDK for Delphi:   Interfaces — Classes — Aliases — Implements
  • Data Abstract shared:   Data Types – File Types
  • other editions:
    • Data Abstract for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
    • Data Abstract for Xcode:   Protocols — Classes — Enums — 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