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_func_commutator() functionThe mi_func_commutator() function obtains the name of a commutator function for a user-defined function.

The mi_func_commutator() function

The mi_func_commutator() function obtains the name of a commutator function for a user-defined function.

Syntax

char *mi_func_commutator(funcdesc_ptr)
   MI_FUNC_DESC *funcdesc_ptr;

funcdesc_ptr: A pointer to a function descriptor for a user-defined function.


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

Usage

The mi_func_commutator() function obtains the name of the commutator function for the user-defined function associated with the funcdesc_ptr function descriptor. When you register a user-defined function, you can use the COMMUTATOR routine modifier of the CREATE FUNCTION statement to associate a commutator function with the user-defined function. To be a commutator function, a user-defined function must have either of the following similarities to the registered user-defined function:

The commutator function takes the same arguments as the registered user-defined function but in opposite order.
The commutator function returns the same result as the registered user-defined function.

The mi_func_commutator() function is one of the functions of the Fastpath interface.

Return values

A char pointer: A pointer to the name of the commutator function for the user-defined function that the funcdesc_ptr function descriptor identifies.
NULL: The function was not successful.