cts.estimate

cts.estimatectsestimate Returns the number of fragments selected by a search. This can be used as a fast estimate of the number results.

A cts:query specifying the search to perform. If a string is entered, the string is treated as a cts.wordQuery of the specified string.

query

cts.query?

Options to this search. The default is (). See cts.search for details on available options.

options

String[]

A document quality weight to use when computing scores. The default is 1.0.

quality-weight

Number?

A sequence of IDs of forests to which the search will be constrained. An empty sequence means to search all forests in the database. The default is (). In the XQuery version, you can use cts:search with this parameter and an empty cts:and-query to specify a forest-specific XPath statement (see the third example below). If you use this to constrain an XPath to one or more forests, you should set the quality-weight to zero to keep the XPath document order.

forest-ids

String[]

The maximum value to return. Stop selecting fragments if this number is reached.

maximum

Number?

Number

  cts.estimate(cts.wordQuery("unsually"))
   => 10476