FTDomainSearch (NotesDatabase - JavaScript™)

Conducts a Domain Search, that is, a full-text search of all databases listed in a Domain Catalog and marked as included for multi-database indexing.

Defined in

NotesDatabase

Syntax

FTDomainSearch(query:string, max:int, sortopt:int, otheropt:int, start:int, count:int, entryForm:string) : NotesDocument
Parameter Description
query The full-text query. See the section "Query Syntax" that follows.
max The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents.
sortopt Use one of the following constants to specify a sorting option:
  • NotesDatabase.FT_SCORES 8 (default) sorts by relevance score. When the collection is sorted by relevance, the highest relevance appears first. To access the relevance score of each document in the collection, use the FTSearchScore property in NotesDocument.
  • NotesDatabase.FT_DATE_DES 32 sorts by document date in descending order.
  • NotesDatabase.FT_DATE_ASC 64 sorts by document date in ascending order.
otheropt Use the following constants to specify additional search options. To specify more than one option, use a logical or operation.
  • NotesDatabase.FT_DATABASE 8192 includes Domino® databases in the search scope.
  • NotesDatabase.FT_FILESYSTEM 4096 includes files other than Domino® databases in the search scope.
  • NotesDatabase.FT_THESAURUS 1024 uses thesaurus synonyms.
  • NotesDatabase.FT_FUZZY 16384 specifies a fuzzy search.
  • NotesDatabase.FT_STEMS 512 uses stem words as the basis of the search.
start The starting page to return.
count The number of pages to return.
entryForm The name of the search form in the domain catalog, for example, "Domain Search."
Return value Description
Document A document with a rich text field named "Body" that contains a table of matching document titles.

Usage

The current Database object must represent a Domain Catalog.

If you don't specify any sort options, you get the documents sorted by relevance score. If you ask for a sort by date, you don't get relevance scores.

Query syntax

To search for a word or phrase, enter the word or phrase as is, except that search keywords must be enclosed in quotes. Remember to escape quotes if you are inside a literal.

Wildcards, operators, and other syntax are permitted. For the complete syntax rules, see "Refining a search query using operators" in Notes® Help. Search for "query syntax" in the Domino® Designer Eclipse help system or information center (for example, http://publib.boulder.ibm.com/infocenter/domhelp/v8r0/index.jsp), both of which include Notes®.

Language cross-reference

FTDomainSearch method in LotusScript® NotesDatabase class

FTDomainSearch method in Java™ Database class