TDAEStoredProcedure

 

Creates a new instance.

constructor Create(aConnection: IDAConnection; aDataset: TDataset; const aName: string)

Parameters:

• aConnection: Connection
• aDataset: Dataset
• aName: Name

---

Creates a new instance.

constructor Create(aConnection: TDAEConnection; const aName: string)

Parameters:

• aConnection: Connection.
• aName: name.

---

property CachedParams: TDictionary<string, Integer> read

---

Specifies that given field can return data in GetNativeFieldData method

function CanUseNativeFieldData(Index: Integer): Boolean

Parameters:

• Index: Required field index

---

Clears parameter values.

procedure ClearParams

---

Presents the IDAConnection to access information about available databases, tables, columns, etc.

property Connection: IDAConnection read

---

Connection

property Connection: TDAEConnection read

---

Creates native stored procedure object

function CreateDataset(aConnection: TDAEConnection): TDataset

Parameters:

• aConnection: owner connection

---

Creates an IDANativeDatabaseAccess implementor.

function CreateNativeDatabaseAccess: IDANativeDatabaseAccess

---

Creates the native object.

function CreateNativeObject(aConnection: TDAEConnection): TObject

Parameters:

• aConnection: connection

---

Access to the standard VCL TDataSet.

property Dataset: TDataset read

---

Creates a object specific to the given connection.

function DoCreateNativeObject: TObject

---

Executes stored procedure

function DoExecute: Integer

---

Empty method. Stored procedures do not need to be prepared by default.

procedure DoPrepare(Value: Boolean)

Parameters:

• Value: not used

---

Implementation of Dynamic Where.

property DynamicWhere: TDAWhereBuilder read write

---

Executes stored procedure

function Execute: Integer

---

function FindCachedParameter(const AParams: TParams; const AParamName: string): TParam

Parameters:

• AParams:
• AParamName:

---

Finds the AParamName parameter in the |TParams collection.

function FindParameter(const AParams: TParams; const AParamName: string): TParam

Parameters:

• AParams:
• AParamName:

---

Implements IDASQLCommand by returning the result of CreateDataset.

function GetDataset: TDataset

---

Implements IDASQLCommand by returning a value set in the constructor.

function GetName: string

---

Sets the DataSize to the according field size value, allocates the Data memory and copies the content of the field.

function GetNativeFieldData(Index: Integer; var Buffer: TBytes): Boolean

Parameters:

• Index: Required field index
• Buffer:

---

Returns the field type of the Index field

function GetNativeFieldDataType(Index: Integer): TFieldType

Parameters:

• Index: field index

---

Implements IDASQLCommand by returning the current parameters.

function GetParams: TDAParamCollection

---

Retrieves the values of the given parameters.

procedure GetParamValues(Params: TDAParamCollection)

Parameters:

• Params: Parameters

---

Retrieves the values from Params2 for the daptOutput, daptInputOutput and daptResult parameters of Params1.

procedure GetParamValuesStd(Params1: TDAParamCollection; Params2: TParams)

Parameters:

• Params1: Parameters guide
• Params2: Values source

---

Returns the stored procedure name.

function GetStoredProcedureName: string

---

Gets mapping |TFieldType to TDADataType.

function intVCLTypeToDAType(aFieldType: TFieldType; ASize: Integer; ADecimalPrecision: Integer; aDecimalScale: Integer): TDADataType

Parameters:

• aFieldType:
• ASize:
• ADecimalPrecision:
• aDecimalScale:

---

Returns true if data access object is TDataset descendant.

function IsTDatasetCompatible: Boolean

---

Returns a human-readable name for the command.

property Name: string read

---

property NativeDatabaseAccess: IDANativeDatabaseAccess read

---

Implements IDASQLCommandNativeObject by delegating the call to the FNativeDatabaseAccess member.

function NativeFieldCount: Integer

---

property NativeFields[Index: Integer]: IDANativeField read

---

Implements IDASQLCommandNativeObject by delegating the call to the FNativeDatabaseAccess member.

function NativeFindField(const FieldName: string): IDANativeField

Parameters:

• FieldName: name of the searched field

---

Access to the standard VCL |TObject which implements the data access.

property NativeObject: TObject read

---

Fires right after a command was executed.

property OnAfterExecute: TDAAfterExecuteCommandEvent read write
delegate:  procedure OnAfterExecute(const Sender: IDASQLCommand; ActualSQL: string; ElapsedMilliseconds: Cardinal)

---

Fires before command execution

property OnBeforeExecute: TDABeforeExecuteCommandEvent read write
delegate:  procedure OnBeforeExecute(const Sender: IDASQLCommand)

---

Fires when exception is detected during command execution

property OnExecuteError: TDAExecuteCommandErrorEvent read write
delegate:  procedure OnExecuteError(const Sender: IDASQLCommand; ActualSQL: string; Error: Exception)

---

Locates a specific parameter, based on its name. If no matching parameter is defined, an exception will be raised.

function ParamByName(const aName: string): TDAParam

Parameters:

• aName: name of the parameter

---

Provides access to the list of parameters defined for the command.

property Params: TDAParamCollection read

---

Specifies whether the SQL statement has been prepared for execution on the database (true) or not (false). Setting this property to true will automatically prepare the statement. Preparing statements on the database server allows for faster execution, especially if the statement will be executed multiple times, as the server will not need to re-parse the SQL text for every execution. Please refer to your database system's documentation for more information on preparing statements.

Note that changing the SQL or Where properties will automatically un-prepare the statement.

property Prepared: Boolean read write

---

Abstract class. RefreshParams must be implemented in the descendants.

procedure PrepareSQLStatement

---

procedure RecreateCachedParams(aParams: TParams)

Parameters:

• aParams:

---

Refreshes the list of parameters defined for the command based on the actual parameter names found in the SQL statement and Where clause.

procedure RefreshParams

---

Refreshes the parameters. Descendants may use it for RefreshParams.

procedure RefreshParamsStd(AParams: TParams)

Parameters:

• AParams: Input parameters

---

Converts values from Data Abstract TDAParam values.

procedure SetParamValues(Params: TDAParamCollection)

Parameters:

• Params: parameters

---

Utility method to set the values of Params2 (|TParams) for the daptOutput, daptInputOutput and daptResult parameters of Params1 (TDAParamCollection).

procedure SetParamValuesStd(Params1: TDAParamCollection; Params2: TParams)

Parameters:

• Params1: Parameters guide
• Params2: Values holder

---

Sets the stored procedure name.

procedure SetStoredProcedureName(const Name: string)

Parameters:

• Name: Stored procedure name

---

Defines the SQL statement to be executed.

property SQL: string read write

---

Checks if SQL contains Dynamic Where macros.

function SQLContainsDynamicWhere: Boolean

---

Stored procedure name

property StoredProcedureName: string read write

 

property CachedParams: TDictionary<string, Integer> read

---

Presents the IDAConnection to access information about available databases, tables, columns, etc.

property Connection: IDAConnection read

---

Connection

property Connection: TDAEConnection read

---

Access to the standard VCL TDataSet.

property Dataset: TDataset read

---

Implementation of Dynamic Where.

property DynamicWhere: TDAWhereBuilder read write

---

Returns a human-readable name for the command.

property Name: string read

---

property NativeDatabaseAccess: IDANativeDatabaseAccess read

---

property NativeFields[Index: Integer]: IDANativeField read

---

Access to the standard VCL |TObject which implements the data access.

property NativeObject: TObject read

---

Provides access to the list of parameters defined for the command.

property Params: TDAParamCollection read

---

Specifies whether the SQL statement has been prepared for execution on the database (true) or not (false). Setting this property to true will automatically prepare the statement. Preparing statements on the database server allows for faster execution, especially if the statement will be executed multiple times, as the server will not need to re-parse the SQL text for every execution. Please refer to your database system's documentation for more information on preparing statements.

Note that changing the SQL or Where properties will automatically un-prepare the statement.

property Prepared: Boolean read write

---

Defines the SQL statement to be executed.

property SQL: string read write

---

Stored procedure name

property StoredProcedureName: string read write

 

Creates a new instance.

constructor Create(aConnection: IDAConnection; aDataset: TDataset; const aName: string)

Parameters:

• aConnection: Connection
• aDataset: Dataset
• aName: Name

---

Creates a new instance.

constructor Create(aConnection: TDAEConnection; const aName: string)

Parameters:

• aConnection: Connection.
• aName: name.

---

Specifies that given field can return data in GetNativeFieldData method

function CanUseNativeFieldData(Index: Integer): Boolean

Parameters:

• Index: Required field index

---

Clears parameter values.

procedure ClearParams

---

Creates native stored procedure object

function CreateDataset(aConnection: TDAEConnection): TDataset

Parameters:

• aConnection: owner connection

---

Creates an IDANativeDatabaseAccess implementor.

function CreateNativeDatabaseAccess: IDANativeDatabaseAccess

---

Creates the native object.

function CreateNativeObject(aConnection: TDAEConnection): TObject

Parameters:

• aConnection: connection

---

Creates a object specific to the given connection.

function DoCreateNativeObject: TObject

---

Executes stored procedure

function DoExecute: Integer

---

Empty method. Stored procedures do not need to be prepared by default.

procedure DoPrepare(Value: Boolean)

Parameters:

• Value: not used

---

Executes stored procedure

function Execute: Integer

---

function FindCachedParameter(const AParams: TParams; const AParamName: string): TParam

Parameters:

• AParams:
• AParamName:

---

Finds the AParamName parameter in the |TParams collection.

function FindParameter(const AParams: TParams; const AParamName: string): TParam

Parameters:

• AParams:
• AParamName:

---

Implements IDASQLCommand by returning the result of CreateDataset.

function GetDataset: TDataset

---

Implements IDASQLCommand by returning a value set in the constructor.

function GetName: string

---

Sets the DataSize to the according field size value, allocates the Data memory and copies the content of the field.

function GetNativeFieldData(Index: Integer; var Buffer: TBytes): Boolean

Parameters:

• Index: Required field index
• Buffer:

---

Returns the field type of the Index field

function GetNativeFieldDataType(Index: Integer): TFieldType

Parameters:

• Index: field index

---

Implements IDASQLCommand by returning the current parameters.

function GetParams: TDAParamCollection

---

Retrieves the values of the given parameters.

procedure GetParamValues(Params: TDAParamCollection)

Parameters:

• Params: Parameters

---

Retrieves the values from Params2 for the daptOutput, daptInputOutput and daptResult parameters of Params1.

procedure GetParamValuesStd(Params1: TDAParamCollection; Params2: TParams)

Parameters:

• Params1: Parameters guide
• Params2: Values source

---

Returns the stored procedure name.

function GetStoredProcedureName: string

---

Gets mapping |TFieldType to TDADataType.

function intVCLTypeToDAType(aFieldType: TFieldType; ASize: Integer; ADecimalPrecision: Integer; aDecimalScale: Integer): TDADataType

Parameters:

• aFieldType:
• ASize:
• ADecimalPrecision:
• aDecimalScale:

---

Returns true if data access object is TDataset descendant.

function IsTDatasetCompatible: Boolean

---

Implements IDASQLCommandNativeObject by delegating the call to the FNativeDatabaseAccess member.

function NativeFieldCount: Integer

---

Implements IDASQLCommandNativeObject by delegating the call to the FNativeDatabaseAccess member.

function NativeFindField(const FieldName: string): IDANativeField

Parameters:

• FieldName: name of the searched field

---

Locates a specific parameter, based on its name. If no matching parameter is defined, an exception will be raised.

function ParamByName(const aName: string): TDAParam

Parameters:

• aName: name of the parameter

---

Abstract class. RefreshParams must be implemented in the descendants.

procedure PrepareSQLStatement

---

procedure RecreateCachedParams(aParams: TParams)

Parameters:

• aParams:

---

Refreshes the list of parameters defined for the command based on the actual parameter names found in the SQL statement and Where clause.

procedure RefreshParams

---

Refreshes the parameters. Descendants may use it for RefreshParams.

procedure RefreshParamsStd(AParams: TParams)

Parameters:

• AParams: Input parameters

---

Converts values from Data Abstract TDAParam values.

procedure SetParamValues(Params: TDAParamCollection)

Parameters:

• Params: parameters

---

Utility method to set the values of Params2 (|TParams) for the daptOutput, daptInputOutput and daptResult parameters of Params1 (TDAParamCollection).

procedure SetParamValuesStd(Params1: TDAParamCollection; Params2: TParams)

Parameters:

• Params1: Parameters guide
• Params2: Values holder

---

Sets the stored procedure name.

procedure SetStoredProcedureName(const Name: string)

Parameters:

• Name: Stored procedure name

---

Checks if SQL contains Dynamic Where macros.

function SQLContainsDynamicWhere: Boolean

 

Fires right after a command was executed.

property OnAfterExecute: TDAAfterExecuteCommandEvent read write
delegate:  procedure OnAfterExecute(const Sender: IDASQLCommand; ActualSQL: string; ElapsedMilliseconds: Cardinal)

---

Fires before command execution

property OnBeforeExecute: TDABeforeExecuteCommandEvent read write
delegate:  procedure OnBeforeExecute(const Sender: IDASQLCommand)

---

Fires when exception is detected during command execution

property OnExecuteError: TDAExecuteCommandErrorEvent read write
delegate:  procedure OnExecuteError(const Sender: IDASQLCommand; ActualSQL: string; Error: Exception)