Skip to main content


datatype class %Library.Text extends %Library.String


The %Text data type class represents a content-addressable document that supports word-based searching and relevance ranking. When you specify %Text as the type class of a property, you must also specify the maximum length of the document in the MAXLEN parameter, and the language of the document in the LANGUAGECLASS parameter. You may also specify the name of the index that will be used to compute the relevance ranking metric.

For detailed usage information, see the class documentation for the %Text.Text class.

Efficient content-based document retrieval requires the use of an index. The type of index you create depends on the type query that the application requires. The simplest type of content-based query is the Boolean query. A Boolean query is comprised of a set of search terms, or words, that are combined with AND/OR/NOT operations to identify the documents of interest. SQL provides the %CONTAINS operator to search for an ANDed list of search terms. %CONTAINS operations may be combined with OR and NOT to specify any Boolean text query. The terms need not be adjacent in the document, although queries can be restricted to adjacent terms such as "White House" by setting NGRAMLEN=2 in the class specified in the LANGUAGECLASS property.

To create an English Text property named myDocument with a full text index suitable for Boolean queries you could specify:

PROPERTY myDocument As %Text (MAXLEN = 256, LANGUAGECLASS = "%Text.English");
INDEX myIndex ON myDocument(KEYS) [ TYPE=BITMAP ];

An issue with Boolean queries is that it can be difficult to specify a query that returns all of the relevant documents, but only those documents. Almost invariably the results will either omit some of the relevant documents because the query is too specific, or will include some non-relevant documents because the query is too general. For example, to locate information about full text indexing in a set of documentation, the terms

  text document search query SQL SELECT index similarity ranking Boolean %CONTAINS 'full text'
all seem to be reasonably descriptive terms for the topic, but simply ANDing all these terms together in a single %CONTAINS operator is likely to find no documents (other than this document). In SQL you can address this sort of problem by casting a wider net with the %CONTAINS operator, then ranking the results with the %SIMILARITY operator, and finally limiting the results to the TOP n rows. For example, a query that finds a relevant set of documents might be:
SELECT TOP 20 document FROM OnlineDocs 
	WHERE document %CONTAINS ('SQL', 'full text', 'query')
	ORDER BY %SIMILARITY (document, 'text document search query SQL SELECT index similarity ranking Boolean %CONTAINS') DESC
This query finds all documents containing the terms 'SQL', 'full text', and 'query' anywhere within the document, then ranks the documents based on similarity with the terms listed in the %SIMILARITY operator, and returns the top 20 results that are deemed to be the most relevant.

Similarity queries are much more computationally expensive than Boolean queries. Performing similarity queries efficiently requires an index that contains additional information with each indexed term, and so bitmap indexes cannot be used. The structure of an index that can be used for similarity queries is determined by the SimilarityIdx() class method of the specified LANGUAGECLASS. If you use one of the predefined language classes in the %Text package, then you would declare your property and index as follows:

PROPERTY myDocument As %Text (MAXLEN = 256, LANGUAGECLASS = "%Text.English", SIMILARITYINDEX = "mySimilarityIndex");
INDEX mySimilarityIndex ON myDocument(KEYS) [ DATA = myDocument(ELEMENTS) ];

Method Inventory


parameter LANGUAGECLASS = %Text.English;

The LANGUAGECLASS parameter specifies the fully qualified name of the language implementation class. Optionally, he LANGUAGECLASS may be set to the name of a global that indirectly defines the language class name. If a global name is specified, then the global must be defined and available at index build time and at SQL query execution time.

parameter MAXLEN;

The MAXLEN parameter specifies the maximum length of the %Text property in bytes. Note that, unlike the %String class, the MAXLEN parameter must be explicitly set to a positive integer on each %Text property.

The SIMILARITYINDEX parameter specifies the name of an index on the current property that has the structure expected by the SimilarityIdx class method of the class specified in the LANGUAGECLASS parameter. The SimilarityIdx class method in the %Text.Text class requires the index global to have the structure: ^textIndexGlobal([constantSubscripts,]key,ID) = value. An index with this structure can be created by compiling an index specification such as:

PROPERTY myDocument As %Text (MAXLEN = 256, LANGUAGECLASS = "%Text.English", SIMILARITYINDEX = "myIndex");
INDEX myIndex ON myDocument(KEYS) DATA [ myDocument(VALUES) ];
The SimilarityIdx method of the %Text.Text class requires the index specified in the SIMILARITYINDEX parameter to have exactly this structure. The index may not be a bitmap index, additional subscripts or data values may not be added to the Index specification, and the index must inherit the collation of the property.


classmethod BuildValueArray(serialProp As %Binary, ByRef valueArray As %Binary) as %Status
classmethod ChooseSearchKey(searchString As %String) as %String
classmethod CreateQList(document As %String, collationExpr As %String) as %List
classmethod IsValid(%val As %RawString) as %Status
Tests if the logical value %val, which is a string, is valid. The validation is based on the class parameter settings used for the class attribute this data type is associated with. In this case, MINLEN, MAXLEN, VALUELIST, and PATTERN.
classmethod MakeSearchTerms(searchPattern As %String, ngramlen As %Integer = 0) as %List
classmethod Similarity(document As %String, qList As %List) as %Numeric
classmethod SimilarityIdx(ID As %String, textIndex As %String, qList As %List) as %Numeric
classmethod Standardize(searchString As %String, origtext As %Boolean = 0) as %String

Inherited Members

Inherited Methods

FeedbackOpens in a new tab