Wildcard search allows you to search for words with unknown letters or ranges of letters.
In a search query in text form, there are 2 forms of wildcard characters:
? for a single character;
?(n~m) for a group of characters, where n and m are numbers from 0 to 255, and n <= m.
Wildcard search is similar to regular expression search, but it works significantly faster when there are fewer groups of wildcard characters and they are closer to the end of a search query.
Wildcard search is flexible enough to be used for prefix queries, since a prefix query is a special case of a wildcard query. Since version 26.10, wildcard search uses as many threads as there are processor cores by default. Since version 26.11, the searches of an index that run at the same time share these threads (see the Search thread safety page).
A wildcard counts the characters of a word as UTF-16 code units: a character above the basic multilingual plane, for example an emoji that the alphabet of the index makes a letter, counts as two characters, which two one-character wildcards or a wildcard of two characters match.
Examples of wildcard search with queries in text form are presented below.
C#
stringindexFolder=@"c:\MyIndex\";stringdocumentsFolder=@"c:\MyDocuments\";// Creating an index in the specified folderIndexindex=newIndex(indexFolder);// Indexing documents from the specified folderindex.Add(documentsFolder);// Search in the indexSearchResultresult1=index.Search("m?rry");// Search for 'merry', 'marry', etc.SearchResultresult2=index.Search("card?(1~6)");// Search for 'cardiff', 'cardinal', 'cardio', 'cards', etc.
To build a query for the wildcard search in object form, use the WordPattern class. This class contains the following methods for adding known parts of a word and wildcards to a pattern:
AppendString appends a string of known characters.
AppendWildcard appends a wildcard for the specified minimum and maximum numbers of characters (?(min~max) in text form). Both values must be in the range from 0 to 255, and the minimum must not be greater than the maximum; otherwise, ArgumentOutOfRangeException is thrown.
The known characters are converted to lower case, since words are stored in the index in lower case. An example of constructing a query in object form is presented below.
C#
stringindexFolder=@"c:\MyIndex\";stringdocumentsFolder=@"c:\MyDocuments\";// Creating an index in the specified folderIndexindex=newIndex(indexFolder);// Indexing documents from the specified folderindex.Add(documentsFolder);// Search with pattern "m?rry"// Search for 'merry', 'marry', etc.WordPatternpattern1=newWordPattern();pattern1.AppendString("m");pattern1.AppendOneCharacterWildcard();pattern1.AppendString("rry");SearchQueryquery1=SearchQuery.CreateWordPatternQuery(pattern1);SearchResultresult1=index.Search(query1);// Search with pattern "card?(1~6)"// Search for 'cardiff', 'cardinal', 'cardio', 'cards', etc.WordPatternpattern2=newWordPattern();pattern2.AppendString("card");pattern2.AppendWildcard(1,6);SearchQueryquery2=SearchQuery.CreateWordPatternQuery(pattern2);SearchResultresult2=index.Search(query2);
Since version 26.11, the following rules apply to wildcard search:
In a query in text form, a backslash escapes a character of a word pattern, as in a word: an escaped character is a character of the pattern, not a wildcard. For example, in an index whose alphabet makes the question mark a letter, the pattern wh\?t? finds “wh?ts” and not “whats”. A backslash that is not followed by a character that can be escaped makes the query invalid. See the Search for text containing special characters page.
A pattern whose wildcards need more characters than the longest word that an index holds (80 characters), for example ?(100~200), finds nothing. Before, such a pattern found all the words of 80 characters.
A pattern that is too complex to be searched for, whose wildcards of a limited length allow more than about 4000 characters in total, finds nothing, and the error is reported by the ErrorOccurred event of the index and in the warnings of the result. Before, the Search method threw ArgumentException.
A search is canceled (see the Search options page) also while it looks for the words of the index that match the pattern.
The words that match a pattern are kept for the next searches with the same query until the index is changed, so a repeated search is faster.
In a case-sensitive search, a word pattern finds the words in any letter case, and the warnings of the result tell it (see the Case sensitive search page).
More resources
GitHub examples
You may easily run the code from documentation articles and see the features in action in our GitHub examples: