Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_query_interrupt() functionThe mi_query_interrupt() function interrupts the current statement.

The mi_query_interrupt() function

The mi_query_interrupt() function interrupts the current statement.

Syntax

mi_integer mi_query_interrupt(conn, block_until_acknowledged)
   MI_CONNECTION *conn;
   mi_integer block_until_acknowledged;

conn: A pointer to a connection descriptor established by a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect().
block_until_acknowledged: This value is currently ignored.


Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

The mi_query_interrupt() function interrupts execution of the current statement on the connection that conn references. The current statement is the most recently executed SQL statement sent to the database server on that connection. This function releases the resources for the current statement. If the current statement was a query, mi_query_interrupt() closes any implicit cursor that mi_exec() or mi_exec_prepared_statement() opened to hold the rows.

The mi_query_interrupt() function does not affect prepared statements or calls to DataBlade® API file-access functions. After mi_query_interrupt() executes, the next iteration of the mi_get_result() function returns a status of MI_NO_MORE_RESULTS.

Return values

MI_OK: The function was successful; the query was either successfully interrupted or had already completed.
MI_ERROR: The function was not successful; an exception was encountered.