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_lo_delete_immediate() functionThe mi_lo_delete_immediate() function deletes a smart large object.

The mi_lo_delete_immediate() function

The mi_lo_delete_immediate() function deletes a smart large object.

Syntax

mi_integer mi_lo_delete_immediate(conn, LO_hdl)
   MI_CONNECTION *conn;
   MI_LO_HANDLE *LO_hdl;

conn

This value is one of the following connection values:

A pointer to a connection descriptor established by a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect().

A NULL-valued pointer (database server only)

LO_hdl

A pointer to the LO handle that identifies the smart large object to be deleted.


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

Usage

The mi_lo_delete_immediate() function deletes the smart large object that the LO_hdl LO handle identifies. Normally, the database server deletes all smart large objects that have a reference count of zero and no open LO file descriptors at the end of the transaction. Therefore, you do not usually need to issue explicit delete calls. The mi_lo_delete_immediate() function is useful when you want to delete some transient smart large object right away and reuse its associated resources. This function can delete a transient smart large object only when no open LO file descriptors exist for the smart large object.

Server only: The mi_lo_delete_immediate() function does not need a connection descriptor to execute. If your UDR does not need a valid connection for other operations, you can specify a NULL-valued pointer for the conn parameter to establish a NULL connection. For information about the advantages of a NULL connection, see the HCL OneDB™ DataBlade® API Programmer's Guide.

The mi_lo_delete_immediate() function immediately deletes all the information related to the specified smart large object. After the call to mi_lo_delete_immediate(), all released resources can be reused, and any operations attempted on this smart large object fail.

Important: This mi_lo_delete_immediate() is not recoverable. Even if the transaction is rolled back, the deleted smart large object cannot be recreated.

Return values

MI_OK: The function was successful.
MI_ERROR: The function was not successful.