////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
////

===== Purpose

Executes a MongoDB https://docs.mongodb.org/manual/reference/operator/query/text/#op._S_text[$text] search query and returns the number of hits.

===== Examples

[source,groovy]
----
assert Product.countHits("coffee") == 5
----

===== Description

The `countHits` method uses MongoDB's full text search support to perform full text search on a "text" index and return the size of the returned cursor.
