Routines
This section provides you with reference information about the etx_contains() operator and other routines defined for the DataBlade® module.
You use the routines to do the following tasks:
- Execute a search
- Create and drop stopword lists
- Create and drop synonym lists
- Create and drop user-defined character sets
- Filter columns of data and enable filter tracing
- Highlight the location of a clue in a document and view the highlighted text
- Close an etx index
The following routines and operators are included in the module.
| Routine or operator | Description |
|---|---|
| etx_contains() | Executes a search |
| etx_CloseIndex() | Closes an etx index |
| etx_CreateCharSet() | Creates a user-defined character set |
| etx_CreateStopWlst() | Creates a list of words that are eliminated from the search |
| etx_CreateSynWlst() | Creates a list of synonyms that can be used in place of a root word in a search |
| etx_DropCharSet() | Drops a user-defined character set |
| etx_DropStopWlst() | Drops a stopword list |
| etx_DropSynWlst() | Drops a synonym list |
| etx_Filter() | Filters formatting information from data in a specified column so that only its contents are returned |
| EtxFilterTraceFile() | Enables tracing for filter operations |
| etx_GetHilite() | Determines the location of a clue in a document specified by an etx_contains operation |
| etx_HiliteDoc() | Returns the location of a clue in a specified document |
| etx_Release() | Returns version information for the |
| etx_ViewHilite() | Highlights the data returned by the etx_GetHilite() or etx_HiliteDoc() routines |
| etx_WordFreq() | Counts the number of documents in a specified index in which a specified word occurs |
The function txt_Release(), included in the HCL OneDB™ Text Descriptor DataBlade Module, is also described in this section. The function returns version information for the HCL OneDB Text Descriptor DataBlade Module.