The mi_tab_setniorows() accessor function

The mi_tab_setniorows() function indicates that the access method can handle more than one row per call and the number of rows for which the database server should allocate memory.

Syntax

mi_integer mi_tab_setniorows(MI_AM_TABLE_DESC *tableDesc,
   mi_integer nrows)
tableDesc
Points to the table descriptor.
nrows
Specifies the maximum number of rows that am_getnext processes.

Usage

The access method must call this function before it calls mi_tab_setnextrow(). Multiple calls to mi_tab_setniorows() during the execution of a single statement causes an exception to be raised.

Return values

The integer indicates the actual number of rows for which the database server allocates memory. Currently, the return value equals nrows. A zero or negative return value indicates an error.