JAVA/CORBA CLASSES
Conducts a full-text search of all the documents in a database.
Defined in
Database
Syntax
public DocumentCollection FTSearch(String query) throws NotesException
public DocumentCollection FTSearch(String query, int max) throws NotesException
public DocumentCollection FTSearch(String query, int max, int sortopt, int otheropt) throws NotesException
Parameters
String query
DocumentCollection
This method is the same the same as FTSearchRange minus the start parameter.
If the database is not full-text indexed, this method works, but less efficiently. To test for an index, use the IsFTIndexed property. To create an index on a local database, use the updateFTIndex method.
This method returns a maximum of 5,000 documents by default. The Notes.ini variable FT_MAX_SEARCH_RESULTS overrides this limit for indexed databases or databases that are not indexed but that are running in an agent on the client. For a database that is not indexed and is running in an agent on the server, you must set the TEMP_INDEX_MAX_DOC Notes.ini variable as well. The absolute maximum is 2,147,483,647.
This method searches all documents in a database. To search only documents found in a particular view, use the FTSearch method in View. To search only documents found in a particular document collection, use the FTSearch method in DocumentCollection.
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. A Newsletter object formats its doclink report with either the document creation date or the relevance score, depending on the sort options you use in the document collection.
If the database has a multi-database index, you get a multi-database search. Navigation through the resulting document collection may be slow, but you can create a newsletter from the collection.
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 "Finding documents in a database" in Lotus Notes Help.
Language cross-reference
FTSearch method in LotusScript NotesDatabase class
Example See Also