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_funcarg_get_routine_id() functionThe mi_funcarg_get_routine_id() function returns the routine identifier for the companion UDR of a cost or selectivity function.

The mi_funcarg_get_routine_id() function

The mi_funcarg_get_routine_id() function returns the routine identifier for the companion UDR of a cost or selectivity function.

Syntax

mi_integer mi_funcarg_get_routine_id(funcarg_ptr)
   MI_FUNCARG *funcarg_ptr;

funcarg_ptr: A pointer to the MI_FUNCARG structure that describes the companion UDR.


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

Usage

The mi_funcarg_get_routine_id() function returns the routine identifier from the MI_FUNCARG structure that funcarg_ptr references. The MI_FUNCARG structure provides information about an argument of a companion UDR to its cost or selectivity function.

Tip: The DataBlade® API provides the mi_funcid data type to hold routine identifiers. The mi_funcid data type has the same structure as the mi_integer data type. However, this DataBlade API function still assumes that routine identifiers are of type mi_integer.

Use the mi_funcarg_get_routine_id() function in a cost or selectivity function to obtain the routine identifier for the companion UDR.

Return values

>= 0: The routine identifier for the companion UDR.
MI_ERROR: The function was not successful.