sa_text_index_vocab System Procedure

Lists all terms that appear in a TEXT index, and the total number of indexed values in which each term appears.

Syntax

sa_text_index_vocab(
	'text-index-name',
	'table-name',
	'table-owner'
	)

Parameters

text-index-name – use this CHAR(128) parameter to specify the name of the TEXT index.
table-name – use this CHAR(128) parameter to specify the name of the table on which the TEXT index is built.
table-owner – use this CHAR(128) parameter to specify the owner of the table.

Privileges

You must have EXECUTE privilege on the system procedure. You must also have one of the following:

SELECT ANY TABLE system privilege
SELECT privilege on the indexed table

Remarks

sa_text_index_vocab returns all terms that appear in a TEXT index, and the total number of indexed values in which each term appears (which is less than the total number of occurrences, if the term appears multiple times in some indexed values).

Parameter values cannot be host variables or expressions. The arguments text-index-name, table-name, and table-owner must be constraints or variables.

Example

Execute sa_text_index_vocab to return all the terms that appear in the TEXT index MyTextIndex on table Customers owned by GROUPO:

sa_text_index_vocab
(‘MyTextIndex’,‘Customers’,‘GROUPO’);

Terms in the index
term	freq
a	1
Able	1
Acres	1
Active	5
Advertising	1
Again	1
...	...