DBdelete

Synopsis

DBdelete deletes a row or rows of data from a table in the current database.

Input Ports

dbvisual_connect_descriptor ptr to a structure

statement string

process_statement int

Parameters

message string

connect_information DBconnectInformation group

dbvisual_descriptor ptr to a structure

db_specific_error_message string

db_specific_error_code int

statement_error_offset int

processing int

return_code int

Output Ports

None

Description

DBdelete deletes a row or rows or data from a table in the current database by executing a SQL DELETE statement. The rows deleted are those fitting the qualifications in the predicates of the DELETE statement.

DBdelete starts a transaction if one has not already been started. To terminate the transaction, use DBcommit or DBrollback.

Input

dbvisual_connect_descriptor

A pointer to the connection descriptor of the session in which DBqueryis to execute. This is the output of the DBconnect module that initiated the session.

CAUTION: Do not modify this value. A fatal error will result.

statement

A SQL DELETE statement. This statement must be a complete, literal, SQL statement that includes all required keywords and all necessary input data values. It must NOT end with a semicolon. The maximum length allowed is 32K bytes.

For more information, see The Toolkits Book.

process_statement

A trigger that initiates execution of the DELETE statement. When this value changes to a value greater than 0, the statement is executed.

Parameters

message

An message that describes the status of the delete. For a list of possible values, see The Toolkits Book.

connect_information

Information about the current connection:

the database driver

the server host

the server name

the database name

the user ID

the connect string

the status of the connection: connected (1) or disconnected (0)

This parameter is of type DBconnectInformation. For more information, see DBconnectInformation .

dbvisual_descriptor

For internal use only.

CAUTION: Do not modify this value. A fatal error will result.

db_specific_error_message

An error message returned by the database server when an error occurs during its processing of the delete. For more information, see your database documentation.

db_specific_error_code

An error code associated with the error message returned by the database server when an error occurs during its processing of the delete. For more information, see your database documentation. A value of 0 indicates success; a nonzero value indicates failure.

statement_error_offset

A returned value indicating the position in the DELETE statement where an error occurred. This value is returned only if the database server returns an error message indicating that the DELETE statement is invalid.

This information is useful for constructing an error message; see DBerrorString .

processing

A return value that indicates the processing status of the delete. This value is set to 1 while the delete is being processed and is cleared to 0 to indicate that the delete has completed.

return_code

The status code associated with the message returned in the message parameter. A value of 0 indicates success; a nonzero value indicates failure. For a list of possible values, see The Toolkits Book.

Output Port

none.

Example

Not available.

File

v/db.v

See also related modules