github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/m3ninx/search/query/all.go (about)

     1  // Copyright (c) 2019 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package query
    22  
    23  import (
    24  	"github.com/m3db/m3/src/m3ninx/generated/proto/querypb"
    25  	"github.com/m3db/m3/src/m3ninx/search"
    26  	"github.com/m3db/m3/src/m3ninx/search/searcher"
    27  )
    28  
    29  const allQueryStr = "all()"
    30  
    31  // AllQuery returns a query which matches all known documents.
    32  type AllQuery struct{}
    33  
    34  // NewAllQuery constructs a new AllQuery.
    35  func NewAllQuery() search.Query {
    36  	return &AllQuery{}
    37  }
    38  
    39  // Searcher returns a searcher over the provided readers.
    40  func (q *AllQuery) Searcher() (search.Searcher, error) {
    41  	return searcher.NewAllSearcher(), nil
    42  }
    43  
    44  // Equal reports whether q is equivalent to o.
    45  func (q *AllQuery) Equal(o search.Query) bool {
    46  	o, ok := singular(o)
    47  	if !ok {
    48  		return false
    49  	}
    50  
    51  	_, ok = o.(*AllQuery)
    52  	return ok
    53  }
    54  
    55  // ToProto returns the Protobuf query struct corresponding to the match all query.
    56  func (q *AllQuery) ToProto() *querypb.Query {
    57  	return &querypb.Query{
    58  		Query: &querypb.Query_All{
    59  			All: &querypb.AllQuery{},
    60  		},
    61  	}
    62  }
    63  
    64  func (q *AllQuery) String() string {
    65  	return allQueryStr
    66  }