github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/index/query_options.go (about)

     1  // Copyright (c) 2020 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 index
    22  
    23  // SeriesLimitExceeded returns whether a given size exceeds the
    24  // series limit the query options imposes, if it is enabled.
    25  func (o QueryOptions) SeriesLimitExceeded(size int) bool {
    26  	return o.SeriesLimit > 0 && size >= o.SeriesLimit
    27  }
    28  
    29  // DocsLimitExceeded returns whether a given size exceeds the
    30  // docs limit the query options imposes, if it is enabled.
    31  func (o QueryOptions) DocsLimitExceeded(size int) bool {
    32  	return o.DocsLimit > 0 && size >= o.DocsLimit
    33  }
    34  
    35  // LimitsExceeded returns whether a given size exceeds the given limits.
    36  func (o QueryOptions) LimitsExceeded(seriesCount, docsCount int) bool {
    37  	return o.SeriesLimitExceeded(seriesCount) || o.DocsLimitExceeded(docsCount)
    38  }
    39  
    40  // Exhaustive returns true if the provided counts did not exceeded the query limits.
    41  func (o QueryOptions) Exhaustive(seriesCount, docsCount int) bool {
    42  	return !o.SeriesLimitExceeded(seriesCount) && !o.DocsLimitExceeded(docsCount)
    43  }