[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] | Reference for unit 'SQLDB' (#fcl)

# TSQLScript

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Component to execute various SQL statements

## Declaration

Source position: sqldb.pp line 721

`type TSQLScript = class(TCustomSQLscript)`
`public`
`constructor Create(); override;` |  | Create a new TSQLScript instance.
`destructor Destroy; override;` |  | Remove the TSQLScript instance from memory.
`procedure Execute; override;` |  | Execute the script.
`procedure ExecuteScript;` |  | Convenience function, simply calls Execute
`property Aborted;` |  | True when the script was aborted
`property Line;` |  | Current line of execution in the script
`published`
`property DataBase: TDatabase; [rw]` |  | Database on which to execute the script
`property Transaction: TDBTransaction; [rw]` |  | Transaction to use in the script
`property OnDirective: TSQLScriptDirectiveEvent; [rw]` |  | Event handler if a directive is encountered
`property AutoCommit;` |  | Automatically commit every statement
`property UseDollarString;` |  | Enable support for dollarstrings
`property DollarStrings;` |  | List of alternate string delimiter token sequences
`property Directives;` |  | List of directives
`property Defines;` |  | Defined macros
`property Script;` |  | The script to execute
`property Terminator;` |  | Terminator character.
`property CommentsinSQL;` |  | Should comments be passed to the SQL engine ?
`property UseSetTerm;` |  | Should the SET TERM directive be recognized
`property UseCommit;` |  | Control automatic handling of the COMMIT command.
`property UseDefines;` |  | Automatically handle pre-processor defines
`property OnException;` |  | Exception handling event
`end;`

## Inheritance

`TSQLScript` |  | Component to execute various SQL statements
`TCustomSQLscript`
?
`TObject`

## Description

TSQLScript is a component that can be used to execute many SQL statements using a TSQLQuery component. The SQL statements are specified in a script TSQLScript.Script separated by a terminator character (typically a semicolon (;)).

## See also

TSQLTransaction |  | Transaction in which a TSQLQuery is handled
TSQLConnection |  | An abstract class representing a connection to a SQL Database
TCustomSQLQuery.ExecSQL |  | Execute a SQL statement that does not return a result set
TSQLQuery.SQL |  | The SQL statement to execute

Documentation generated on: May 14 2021