Full Text Search

Full text search is enabled by adding the text_search column property to a string column. The text_search property is also the default property for string type columns with no other column properties set.

The /filter/bystring endpoint enables you to use full text search with the "search" mode but with some stipulations:

• The first character of a search term cannot be a wildcard (* or ?)
• Search terms cannot be any of the following: a, an, and, are, as, at, be, but, by, for, if, in, into, is, it, no, not, of, on, or, such, that, the, their, then, these, they, this, to, was, will, with

The following search query options are available (with corresponding examples):

• Multiple search terms

  • perfect union - matches any record containing perfect, union, or both.

• Exact phrases

  • "Perfect Union" - matches the exact phrase Perfect Union

• Boolean (NOT, AND, OR, parentheses () -- OR assumed if no operator specified)

  • justice AND tranquility - matches only those records containing both justice and tranquility
  • justice OR tranquility - requires that either justice or tranquility be matched. Note that this is the default, so justice OR tranquility is equivalent to justice tranquility
  • justice NOT tranquility - requires that justice be matched and prohibits matching tranquility
  • (justice tranquility honesty) AND peace - requires that peace and at least one of justice, tranquility, or honesty be matched

• Zero or more char wildcard - (specified with *)

  • est*is* - matches any records containing a word that starts with est, followed by an amount of characters, followed by is, followed by another amount of characters. This example would match establish, establishable, and establishment

• Exactly one char wildcard - (specified with ?)

  • est???is? - matches strings that start with est, followed by exactly three letters, followed by is, followed by one more letter. This example would only match establish

• Fuzzy search (term~)

  • rear~ matches rear, fear, bear, read, etc.

• Proximity - match two words within a specified distance of each other

  • Union Tranquility~10 will match any record that has the words Union and Tranquility within 10 words of each other

• Increase the relevance of a matched search term versus other given terms

  • we have fun^5 would increase the relevance of a match against fun versus the other two terms

• Required, optional, and prohibited matches

  • required - use + in front of a term, e.g., +fun requires that fun be matched
  • optional - use no modifier in front of a term, e.g., fun optionally matches fun
  • prohibited - use - in front of a term, e.g., -fun prohibits matches containing fun

• Range - inclusive [<term1> TO <term2>] and exclusive {<term1> TO <term2>}.

  • [100 TO 200] finds all strings between 100 and 200 inclusive.
  • {alpha to beta} finds all strings between alpha and beta, but not the words alpha or beta

  Note

  This is a string search, so numbers will be seen as a string of numeric characters, not as a number (e.g., "2" > "123")

• Escaping special characters - Special characters are escaped with a backslash(\), special characters are: + - && || ! ( ) { } [ ] ^ \" ~ * ? : \\