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.
Categories of DataBlade® API functionsThis section summarizes by categories the functions that the DataBlade® API provides. It divides functions that are valid within DataBlade® API modules into several functional categories and lists the functions within each category.
The DataBlade® API function libraryThis section lists the functions in the DataBlade® API function library by categories.
Control of the Virtual-Processor environment (Server)The DataBlade® API provides functions for controlling the Virtual-Processor (VP) environment within a user-defined routine (UDR).

Control of the Virtual-Processor environment (Server)

The DataBlade® API provides functions for controlling the Virtual-Processor (VP) environment within a user-defined routine (UDR).

Table 1. DataBlade API functions for controlling the VP environment within a UDR
Function category	DataBlade API function	DataBlade API function
Controlling the VP environment	VP information: mi_vpinfo_classid() mi_vpinfo_isnoyield() mi_vpinfo_vpid() Locking a UDR to a VP: mi_module_lock() mi_udr_lock()	VP-class information: mi_class_id() mi_class_maxvps() mi_class_name() mi_class_numvp() Changing the VP environment: mi_call_on_vp() mi_process_exec()

Important: These advanced functions can adversely affect your UDR if you use them incorrectly. Use them only when no regular DataBlade API functions can perform the tasks you need done.