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_udr_lock() functionThe mi_udr_lock() function locks an instance of a UDR onto the virtual processor (VP) on which it begins execution.

The mi_udr_lock() function

The mi_udr_lock() function locks an instance of a UDR onto the virtual processor (VP) on which it begins execution.

Syntax

mi_integer mi_udr_lock(lock_flag)
   mi_integer lock_flag;

lock_flag

The integer value to set the VP lock flag for the current instance of the UDR. This flag can have either of the following values:

MI_TRUE: Sets the VP lock flag to prevent the routine manager from migrating the UDR instance to another VP
MI_FALSE: Unsets the VP lock flag to tell the routine manager that it can migrate the UDR when necessary


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

Usage

The mi_udr_lock() function sets the VP lock flag to the value that lock_flag specifies. The VP lock flag indicates whether to lock the routine instance of a UDR to the current VP. The current VP is the VP on which the current UDR is running. When the VP lock flag is MI_TRUE, the routine manager does not allow the UDR instance to migrate to another VP.

Important: A value of MI_TRUE in the VP lock flag does not prevent another instance of the UDR from executing on another VP.

Return values

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