List_Index routine [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== List_Index routine    ======


 
==== Description ====
 
Returns information about indexes for a specified table or for all tables.
 
==== Syntax ====
 
**List_Index**(//tablename//, //returncolumnlist//, //indextypelist//)
 
==== Parameters ====
 
The List_Index routine has the following parameters.

^Parameter^Description^^
|//Tablename//|Specifies the table name to find index information for. If null, then indexing information is returned for all attached tables.||
|//Returncolumnlist//|Specifies a column or list of columns to return from the table specified in //tablename//. If null, the TABLE_NAME and COLUMN_NAME columns from the SYSDICT table are returned.||
|//indextypelist//|Specifies the type of indexes to return. If no index type is specified, all index types are returned. The index options are:\\ \\ __indextypelist__ __Description__\\ 1 - Btree index.\\ 2 - Cross Reference index.\\ 3 - Relational index.|

 
==== Returns ====
 
A row for each column specified in //returncolumnlist//. Each return row contains the following:

(table, column, btree, crossref, relational)

^Return column^Value^
|//Table//|Table name.|
|//Column//|Column name.|
|//Btree//|If true (1), a Btree index exists for //column.//|
|//crossref//|If true (1), a Cross Reference index exists for //column.//|
|//relational//|If true (1), a Relational index exists for //column.//|


==== Example ====
 
<code>
run List_Index "CUSTOMERS"
</code>

produces:

<code>
CUSTOMERS, CUSTOMER_NAME, 0, 1, 0
CUSTOMERS, CUSTOMER_NAME_XREF, 1, 0, 0
CUSTOMERS, FNAME, 1, 0, 0
CUSTOMERS, LNAME, 1, 0, 0
CUSTOMERS, STATE, 1, 1, 0
CUSTOMERS, STATE_XREF, 1, 0, 0
</code>