FireDAC.Comp.Script.TFDScriptCommand

From RAD Studio API Documentation
Jump to: navigation, search

System.TObjectTFDScriptCommand
[–] Properties
Type: class
Visibility: public
Source:
FireDAC.Comp.Script.pas
FireDAC.Comp.Script.hpp
Unit: FireDAC.Comp.Script
Parent: FireDAC.Comp.Script

Delphi

TFDScriptCommand = class(TObject)

C++

class PASCALIMPLEMENTATION TFDScriptCommand : public System::TObject

Description

The base class for custom script commands.

The FireDAC SQL Script engine is fully extendable and allows to create custom script control commands.  Use the TFDScriptCommand class as a base class for custom script commands. The command developer must implement the following virtual methods:

  • Keywords--returns the list of the keywords, which run this command.
  • Help--returns the command help.
  • Parse--parses the script and prepares the command for execution.
  • Validate--runs the command in script validation mode.
  • Execute--runs the command in actual execution mode.

The command class must be registered with the SQL Script engine using the FDScriptCommandRegistry().AddCommand(...) call.

See Also