Accessor functions
The Virtual-Index Interface (VII) library contains functions that primarily access selected fields from the various descriptors.
This section lists detailed information about specific
VII accessor functions in alphabetical order by function name. To
find the accessor functions for a particular descriptor, look for
the corresponding function-name prefix.
| Descriptor | Accessor-function prefix |
|---|---|
| Key | mi_key_*() |
| Qualification | mi_qual_ mi_eval_am_qual() mi_init_am_qual() |
| Qualification parameter | mi_qual_param_ |
| Row ID | mi_id_*() |
| Scan | mi_scan_ |
| Statistics | mi_tstats_ |
| Table | mi_tab_ |
- The mi_id_fragid() accessor function
The mi_id_fragid() function retrieves the fragment identifier from the row-ID descriptor. - The mi_id_rowid() accessor function
The mi_id_rowid() function retrieves the row identifier from the row-ID descriptor. - The mi_id_setfragid() accessor function
The mi_id_setfragid() function sets the fragment identifier for the row. - The mi_id_setrowid() accessor function
The mi_id_setrowid() function sets the row identifier for the row. - The mi_istats_setclust() accessor function
The mi_istats_setclust() function stores the degree of clustering for an index in the statistics descriptor. - The mi_istats_set2lval() accessor function
The mi_istats_set2lval() function stores the second-largest index-key value in the statistics descriptor. - The mi_istats_set2sval() accessor function
The mi_istats_set2sval() function stores the second-smallest index-key value in the statistics descriptor. - The mi_istats_setnlevels() accessor function
The mi_istats_setnlevels() function stores the number of index levels in the statistics descriptor. - The mi_istats_setnleaves() accessor function
The mi_istats_setnleaves() function stores the number of index leaf nodes in the statistics descriptor. - The mi_istats_setnunique() accessor function
The mi_istats_setnunique() function stores the number of unique index keys in the statistics descriptor. - The mi_key_funcid() accessor function
The mi_key_funcid() function retrieves the identifier of the function that computes the key values in a functional index. - The mi_key_nkeys() accessor function
The mi_key_nkeys() function returns the number of columns in the index key. - The mi_key_opclass() and mi_key_opclass_name() accessor functions
Identify the mi_key_opclass() and mi_key_opclass_name() functions by identifier number or name, the operator class that provides the support, and strategy functions for a specified column in a key. - The mi_key_opclass_nstrat() accessor function
The mi_key_opclass_nstrat() function retrieves the number of strategy functions in the operator class associated with the key. - The mi_key_opclass_nsupt() accessor function
The mi_key_opclass_nsupt() function retrieves the number of support functions in the operator class associated with the key. - The mi_key_opclass_strat() accessor function
The mi_key_opclass_strat() function retrieves the name of an operator-class strategy function. - The mi_key_opclass_supt() accessor function
The mi_key_opclass_supt() function returns the name of an operator-class support function. - The mi_qual_boolop() accessor function
The mi_qual_boolop() function retrieves the Boolean operator that combines two qualifications in a complex expression. - The mi_qual_column() accessor function
The mi_qual_column() function identifies the key-column argument to a strategy function. - The mi_qual_commuteargs() accessor function
The mi_qual_commuteargs() function determines whether the constant precedes the column in a strategy-function argument list. - The mi_qual_constant() accessor function
The mi_qual_constant() function retrieves the constant value that the where clause specifies as a strategy-function argument. - The mi_qual_constant_nohostvar() accessor function
The mi_qual_constant_nohostvar() function returns an explicit constant value, if any, from the strategy-function arguments. - The mi_qual_constisnull() accessor function
The mi_qual_constisnull() function determines whether the arguments to a strategy function include a NULL constant. - The mi_qual_constisnull_nohostvar() accessor function
The mi_qual_constisnull_nohostvar() function determines whether a strategy-function argument list contains an explicit NULL value. - The mi_qual_const_depends_hostvar() accessor function
The mi_qual_const_depends_hostvar() function indicates whether the value of a host variable influences the evaluation of a qualification. - The mi_qual_const_depends_outer() accessor function
The mi_qual_const_depends_outer() function indicates that an outer join provides the constant in a qualification. - The mi_qual_funcid() accessor function
The mi_qual_funcid() function returns the routine identifier of a strategy function. - The mi_qual_funcname() accessor function
The mi_qual_funcname() function returns the name of a strategy function. - The mi_qual_handlenull() accessor function
The mi_qual_handlenull() function determines whether the strategy function can accept NULL arguments. - The mi_qual_issimple() accessor function
The mi_qual_issimple() function determines whether a qualification is a function. - The mi_qual_needoutput() accessor function
The mi_qual_needoutput() function determines whether the access method must set the value for an OUT argument in a UDR. - The mi_qual_negate() accessor function
The mi_qual_negate() function indicates whether the NOT Boolean operator applies to the results of the specified qualification. The NOT operator can negate the return value of a function or a Boolean expression. - The mi_qual_nquals() accessor function
The mi_qual_nquals() function retrieves the number of qualifications in an AND or OR qualification expression. - The mi_qual_qual() accessor function
The mi_qual_qual() function points to one function or Boolean expression in a complex qualification. - The mi_qual_setoutput() accessor function
The mi_qual_setoutput() function sets a constant-argument value for a UDR. - The mi_qual_setreopt() accessor function
The mi_qual_setreopt() function sets an indicator in the qualification descriptor to force reoptimization. - The mi_qual_stratnum() accessor function
The mi_qual_stratnum() function locates a strategy function that a WHERE clause specifies in the list of strategy functions for the corresponding operator class. - The mi_scan_forupdate() accessor function
The mi_scan_forupdate() function determines if the SELECT query includes a FOR UPDATE clause. - The mi_scan_isolevel() accessor function
The mi_scan_isolevel() function retrieves the isolation level that the database server expects for the table that am_getnext scans. - The mi_scan_locktype() accessor function
The mi_scan_locktype() function retrieves the lock type that the database server expects for the table that am_getnext scans. - The mi_scan_newquals() accessor function
The mi_scan_newquals() function indicates whether the qualification descriptor includes changes between multiple scans for the same query statement. - The mi_scan_nprojs() accessor function
The mi_scan_nprojs() function returns a value that is 1 less than the number of key columns. - The mi_scan_projs() accessor function
The mi_scan_projs() function identifies each key column. - The mi_scan_quals() accessor function
The mi_scan_quals() function returns the qualification descriptor, which describes the conditions that an entry must satisfy to qualify for selection. - The mi_scan_setuserdata() accessor function
The mi_scan_setuserdata() function stores a pointer to user data in the scan descriptor. - The mi_scan_table() accessor function
The mi_scan_table() function retrieves a pointer to the table descriptor for the table that the access method scans. - The mi_scan_userdata() accessor function
The mi_scan_userdata() function retrieves the pointer from the scan descriptor that points to a user data structure. - The mi_tab_amparam() accessor function
The mi_tab_amparam() function retrieves any user-defined configuration values for the index. - The mi_tab_check_msg() function
The mi_tab_check_msg() function sends messages to the oncheck utility. - The mi_tab_check_is_recheck() accessor function
The mi_tab_check_is_recheck() function indicates whether the current execution of the am_check purpose function should repair a specific problem that the previous execution detected. - The mi_tab_check_set_ask() accessor function
The mi_tab_check_set_ask() function sets a flag in the table descriptor to indicate that am_check detects a repairable problem in the index. - The mi_tab_createdate() accessor function
The mi_tab_createdate() function returns the date that the index was created. - The mi_tab_isindex() accessor function
The mi_tab_isindex() function indicates whether the table descriptor describes an index. - The mi_tab_isolevel() accessor function
The mi_tab_isolevel() function retrieves the isolation level that the SET ISOLATION or SET TRANSACTION statement applies. - The mi_tab_keydesc() accessor function
The mi_tab_keydesc() function returns a pointer to the key descriptor. - The mi_tab_mode() accessor function
The mi_tab_mode() function retrieves the I/O mode of the index from the table descriptor. - The mi_tab_name() accessor function
The mi_tab_name() function retrieves the index name that the active SQL statement or oncheck command specifies. - The mi_tab_nextrow() accessor function
The mi_tab_nextrow() function fetches the next index entry from several that the database server stores in shared memory. - The mi_tab_niorows() accessor function
The mi_tab_niorows() function retrieves the number of rows that the database server expects to process in am_getnext or am_insert. - The mi_tab_nparam_exist() accessor function
The mi_tab_nparam_exist() function returns the number of virtual indexes that contain identical key columns. - The mi_tab_numfrags() accessor function
The mi_tab_numfrags() function retrieves the number of fragments in the index. - The mi_tab_owner() accessor function
The mi_tab_owner() function retrieves the owner of the table. - The mi_tab_param_exist() accessor function
The mi_tab_param_exist() function retrieves the index-configuration parameters that are available for one of multiple indexes that consist of the same key columns. - The mi_tab_partnum() accessor function
The mi_tab_partnum() function retrieves the fragment identifier for the index. - The mi_tab_rowdesc() accessor function
The mi_tab_rowdesc() function retrieves the row descriptor, which describes the columns that belong to the index that the table descriptor identifies. - The mi_tab_setnextrow() accessor function
The am_getnext purpose function calls mi_tab_setnextrow() to store the next entry that qualifies for selection. - 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. - The mi_tab_setuserdata() accessor function
The mi_tab_setuserdata() function stores a pointer to user data in the table descriptor. - The mi_tab_spaceloc() accessor function
The mi_tab_spaceloc() function retrieves the location of the extspace where the index is. - The mi_tab_spacename() accessor function
The mi_tab_spacename() function retrieves the name of the storage space where the virtual index is. - The mi_tab_spacetype() accessor function
The mi_tab_spacetype() function retrieves the type of storage space where the virtual index is. - The mi_tab_unique() accessor function
The mi_tab_unique() function determines if a CREATE INDEX statement specifies that the index contains only unique keys. - The mi_tab_update_stat_mode() accessor function
The mi_tab_update_stat_mode() function indicates whether an UPDATE STATISTICS function includes a LOW, MEDIUM, or HIGH mode keyword. - The mi_tab_userdata() accessor function
The mi_tab_userdata() function retrieves, from the table descriptor, a pointer to a user-data structure that the access method maintains in shared memory.
Parent topic: Descriptor function reference
Related concepts: