github.com/m3db/m3@v1.5.0/src/query/functions/binary/types.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 binary
    22  
    23  import (
    24  	"github.com/m3db/m3/src/query/block"
    25  	"github.com/m3db/m3/src/query/parser"
    26  )
    27  
    28  // VectorMatchCardinality describes the cardinality relationship
    29  // of two Vectors in a binary operation.
    30  type VectorMatchCardinality int
    31  
    32  const (
    33  	// CardOneToOne is used for one-one relationship
    34  	CardOneToOne VectorMatchCardinality = iota
    35  	// CardManyToOne is used for many-one relationship
    36  	CardManyToOne
    37  	// CardOneToMany is used for one-many relationship
    38  	CardOneToMany
    39  	// CardManyToMany is used for many-many relationship
    40  	CardManyToMany
    41  )
    42  
    43  // VectorMatching describes how elements from two Vectors in a binary
    44  // operation are supposed to be matched.
    45  type VectorMatching struct {
    46  	// Set determines if this has been set or is using default values.
    47  	Set bool
    48  	// Card is the cardinality of the two Vectors.
    49  	Card VectorMatchCardinality
    50  	// MatchingLabels contains the labels which define equality of a pair of
    51  	// elements from the Vectors.
    52  	MatchingLabels [][]byte
    53  	// On includes the given label names from matching,
    54  	// rather than excluding them.
    55  	On bool
    56  	// Include contains additional labels that should be included in
    57  	// the result from the side with the lower cardinality.
    58  	Include []string
    59  }
    60  
    61  // VectorMatcherBuilder creates a vector matcher based on incoming block types.
    62  type VectorMatcherBuilder func(lhs, rhs block.Block) VectorMatching
    63  
    64  // NodeParams describes the types of nodes used for binary operations.
    65  type NodeParams struct {
    66  	LNode, RNode         parser.NodeID
    67  	ReturnBool           bool
    68  	VectorMatcherBuilder VectorMatcherBuilder
    69  }