TSQLQuery class

In unit SQLDB

Class to handle SQL commands (with or without result set).

Declaration

pascal

TSQLQuery = class(TCustomSQLQuery)

Inheritance

Description

TSQLQuery exposes the properties and some methods introduced in TCustomSQLQuery. It encapsulates a single SQL statement: it implements all the necessary TDataset functionality to be able to handle a result set. It can also be used to execute a single SQL statement that does not return data, using the ExecSQL method.

Typically, the Database property must be set once, the Transaction property as well. Then the SQL property can be set. Depending on the kind of SQL statement, the Open method can be used to retrieve data, or the ExecSQL method can be used to execute the SQL statement (this can be used for DDL statements, or update statements).

Properties

`SchemaType`	public	Schema type.
`StatementType`	public	SQL statement type.
`MaxIndexesCount`	published	Maximum allowed number of indexes.
`FieldDefs`	published	List of field definitions.
`Active`	published	Is the dataset open or closed.
`AutoCalcFields`	published	How often should the value of calculated fields be calculated.
`Filter`	published	Filter to apply to the data in memory.
`Filtered`	published	Is the filter active or not.
`AfterCancel`	published	Event triggered after a Cancel operation.
`AfterClose`	published	Event triggered after the dataset is closed.
`AfterDelete`	published	Event triggered after a successful Delete operation.
`AfterEdit`	published	Event triggered after the dataset is put in edit mode.
`AfterInsert`	published	Event triggered after the dataset is put in insert mode.
`AfterOpen`	published	Event triggered after the dataset is opened.
`AfterPost`	published	Event called after changes have been posted to the underlying database.
`AfterRefresh`	published	Event triggered after refresh.
`AfterScroll`	published	Event triggered after the cursor has changed position.
`BeforeCancel`	published	Event triggered before a Cancel operation.
`BeforeClose`	published	Event triggered before the dataset is closed.
`BeforeDelete`	published	Event triggered before a Delete operation.
`BeforeEdit`	published	Event triggered before the dataset is put in edit mode.
`BeforeInsert`	published	Event triggered before the dataset is put in insert mode.
`BeforeOpen`	published	Event triggered before the dataset is opened.
`BeforePost`	published	Event called before changes are posted to the underlying database.
`BeforeRefresh`	published	Event triggered before refresh.
`BeforeScroll`	published	Event triggered before the cursor changes position.
`Database`	published	The TSQLConnection instance on which to execute SQL Statements.
`Transaction`	published	Transaction in which to execute SQL statements.
`ReadOnly`	published	Indicates if records can be added, deleted, or modified in the dataset.
`SQL`	published	The SQL statement to execute.
`InsertSQL`	published	Statement to be used when inserting a new row in the database.
`UpdateSQL`	published	Statement to be used when updating an existing row in the database.
`DeleteSQL`	published	Statement to be used when deleting a new row in the database.
`RefreshSQL`	published	Refresh query to re-fetch field values after a DB update.
`IndexDefs`	published	List of local index Definitions.
`Options`	published	Options controlling the behaviour of the dataset.
`Params`	published	Parameters detected in the SQL statement.
`ParamCheck`	published	Should the SQL statement be checked for parameters.
`Macros`	published	Set of macros for this SQL statement.
`MacroCheck`	published	Check for macros in the SQL statement.
`MacroChar`	published	Macro delimiter character.
`ParseSQL`	published	Should the SQL statement be parsed or not.
`UpdateMode`	published	How to create update SQL statements.
`UsePrimaryKeyAsKey`	published	Should primary key fields be marked pfInKey.
`DataSource`	published	Source for parameter values for unbound parameters.
`Sequence`	published	Sequence to use for auto-generating values using a sequence.
`ServerFilter`	published	Append server-side filter to SQL statement.
`ServerFiltered`	published	Should server-side filter be applied.
`ServerIndexDefs`	published	List of indexes on the primary table of the query.

Events

`OnCalcFields`	published	Event triggered when values for calculated fields must be computed.
`OnDeleteError`	published	Event triggered when a delete operation fails.
`OnEditError`	published	Event triggered when an edit operation fails.
`OnFilterRecord`	published	Event triggered to filter records.
`OnNewRecord`	published	Event triggered when a new record is created.
`OnPostError`	published	Event triggered when a post operation fails.