Home | Previous Page | Next Page   Purpose-Function Reference > Purpose-Function Syntax >

am_delete

The database server calls am_delete for:

Syntax

mi_integer am_delete(MI_AM_TABLE_DESC *tableDesc, 
   mi_integer rowID))
tableDesc
points to the table descriptor.
rowID
is the identifier of the row to delete.

Usage

The am_delete purpose function deletes one row in the virtual table. In response to a DELETE statement, the database server first calls the appropriate purpose functions to scan for the table entry or entries that qualify for deletion and then executes am_delete separately for each qualifying entry.

Important:
The database server does not call the am_delete purpose function unless you set both the am_rowids and am_readwrite purpose flags. For more information about setting purpose flags, refer to SQL Statements for Access Methods.

Warning:
If the access method does not supply an am_delete purpose function, but an SQL statement requires it, the database server raises an error. For more information on how to handle this error, refer to Supplying Error Messages and a User Guide.

Return Values

MI_OK indicates success. MI_ERROR indicates failure.

Related Topics

See the descriptions of:

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]