gocqlx/qb/cmp.go

// Copyright (C) 2017 ScyllaDB
// Use of this source code is governed by a ALv2-style
// license that can be found in the LICENSE file.

package qb

import (
	"bytes"
)

// op specifies Cmd operation type.
type op byte

const (
	eq op = iota
	ne
	lt
	leq
	gt
	geq
	in
	cnt
	cntKey
	like
)

// Cmp if a filtering comparator that is used in WHERE and IF clauses.
type Cmp struct {
	value  value
	column string
	op     op
}

func (c Cmp) writeCql(cql *bytes.Buffer) (names []string) {
	cql.WriteString(c.column)
	switch c.op {
	case eq:
		cql.WriteByte('=')
	case ne:
		cql.WriteString("!=")
	case lt:
		cql.WriteByte('<')
	case leq:
		cql.WriteByte('<')
		cql.WriteByte('=')
	case gt:
		cql.WriteByte('>')
	case geq:
		cql.WriteByte('>')
		cql.WriteByte('=')
	case in:
		cql.WriteString(" IN ")
	case cnt:
		cql.WriteString(" CONTAINS ")
	case cntKey:
		cql.WriteString(" CONTAINS KEY ")
	case like:
		cql.WriteString(" LIKE ")
	}
	return c.value.writeCql(cql)
}

// Eq produces column=?.
func Eq(column string) Cmp {
	return Cmp{
		op:     eq,
		column: column,
		value:  param(column),
	}
}

// EqTuple produces column=(?,?,...) with count number of placeholders.
func EqTuple(column string, count int) Cmp {
	return Cmp{
		op:     eq,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// EqNamed produces column=? with a custom parameter name.
func EqNamed(column, name string) Cmp {
	return Cmp{
		op:     eq,
		column: column,
		value:  param(name),
	}
}

// EqTupleNamed produces column=(?,?,...) with count number of placeholders and custom name.
func EqTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     eq,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// EqLit produces column=literal and does not add a parameter to the query.
func EqLit(column, literal string) Cmp {
	return Cmp{
		op:     eq,
		column: column,
		value:  lit(literal),
	}
}

// EqFunc produces column=someFunc(?...).
func EqFunc(column string, fn *Func) Cmp {
	return Cmp{
		op:     eq,
		column: column,
		value:  fn,
	}
}

// Ne produces column!=?.
func Ne(column string) Cmp {
	return Cmp{
		op:     ne,
		column: column,
		value:  param(column),
	}
}

// NeTuple produces column!=(?,?,...) with count number of placeholders.
func NeTuple(column string, count int) Cmp {
	return Cmp{
		op:     ne,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// NeNamed produces column!=? with a custom parameter name.
func NeNamed(column, name string) Cmp {
	return Cmp{
		op:     ne,
		column: column,
		value:  param(name),
	}
}

// NeTupleNamed produces column!=(?,?,...) with count number of placeholders and custom name.
func NeTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     ne,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// NeLit produces column!=literal and does not add a parameter to the query.
func NeLit(column, literal string) Cmp {
	return Cmp{
		op:     ne,
		column: column,
		value:  lit(literal),
	}
}

// NeFunc produces column!=someFunc(?...).
func NeFunc(column string, fn *Func) Cmp {
	return Cmp{
		op:     ne,
		column: column,
		value:  fn,
	}
}

// Lt produces column<?.
func Lt(column string) Cmp {
	return Cmp{
		op:     lt,
		column: column,
		value:  param(column),
	}
}

// LtTuple produces column<(?,?,...) with count placeholders.
func LtTuple(column string, count int) Cmp {
	return Cmp{
		op:     lt,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// LtNamed produces column<? with a custom parameter name.
func LtNamed(column, name string) Cmp {
	return Cmp{
		op:     lt,
		column: column,
		value:  param(name),
	}
}

// LtTupleNamed produces column<(?,?,...) with count placeholders and custom name.
func LtTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     lt,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// LtLit produces column<literal and does not add a parameter to the query.
func LtLit(column, literal string) Cmp {
	return Cmp{
		op:     lt,
		column: column,
		value:  lit(literal),
	}
}

// LtFunc produces column<someFunc(?...).
func LtFunc(column string, fn *Func) Cmp {
	return Cmp{
		op:     lt,
		column: column,
		value:  fn,
	}
}

// LtOrEq produces column<=?.
func LtOrEq(column string) Cmp {
	return Cmp{
		op:     leq,
		column: column,
		value:  param(column),
	}
}

// LtOrEqTuple produces column<=(?,?,...) with count placeholders.
func LtOrEqTuple(column string, count int) Cmp {
	return Cmp{
		op:     leq,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// LtOrEqNamed produces column<=? with a custom parameter name.
func LtOrEqNamed(column, name string) Cmp {
	return Cmp{
		op:     leq,
		column: column,
		value:  param(name),
	}
}

// LtOrEqTupleNamed produces column<=(?,?,...) with count placeholders and custom name.
func LtOrEqTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     leq,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// LtOrEqLit produces column<=literal and does not add a parameter to the query.
func LtOrEqLit(column, literal string) Cmp {
	return Cmp{
		op:     leq,
		column: column,
		value:  lit(literal),
	}
}

// LtOrEqFunc produces column<=someFunc(?...).
func LtOrEqFunc(column string, fn *Func) Cmp {
	return Cmp{
		op:     leq,
		column: column,
		value:  fn,
	}
}

// Gt produces column>?.
func Gt(column string) Cmp {
	return Cmp{
		op:     gt,
		column: column,
		value:  param(column),
	}
}

// GtTuple produces column>(?,?,...) with count placeholders.
func GtTuple(column string, count int) Cmp {
	return Cmp{
		op:     gt,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// GtNamed produces column>? with a custom parameter name.
func GtNamed(column, name string) Cmp {
	return Cmp{
		op:     gt,
		column: column,
		value:  param(name),
	}
}

// GtTupleNamed produces column>(?,?,...) with count placeholders and custom name.
func GtTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     gt,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// GtLit produces column>literal and does not add a parameter to the query.
func GtLit(column, literal string) Cmp {
	return Cmp{
		op:     gt,
		column: column,
		value:  lit(literal),
	}
}

// GtFunc produces column>someFunc(?...).
func GtFunc(column string, fn *Func) Cmp {
	return Cmp{
		op:     gt,
		column: column,
		value:  fn,
	}
}

// GtOrEq produces column>=?.
func GtOrEq(column string) Cmp {
	return Cmp{
		op:     geq,
		column: column,
		value:  param(column),
	}
}

// GtOrEqTuple produces column>=(?,?,...) with count placeholders.
func GtOrEqTuple(column string, count int) Cmp {
	return Cmp{
		op:     geq,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// GtOrEqNamed produces column>=? with a custom parameter name.
func GtOrEqNamed(column, name string) Cmp {
	return Cmp{
		op:     geq,
		column: column,
		value:  param(name),
	}
}

// GtOrEqTupleNamed produces column>=(?,?,...) with count placeholders and custom name.
func GtOrEqTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     geq,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// GtOrEqLit produces column>=literal and does not add a parameter to the query.
func GtOrEqLit(column, literal string) Cmp {
	return Cmp{
		op:     geq,
		column: column,
		value:  lit(literal),
	}
}

// GtOrEqFunc produces column>=someFunc(?...).
func GtOrEqFunc(column string, fn *Func) Cmp {
	return Cmp{
		op:     geq,
		column: column,
		value:  fn,
	}
}

// In produces column IN ?.
func In(column string) Cmp {
	return Cmp{
		op:     in,
		column: column,
		value:  param(column),
	}
}

// InTuple produces column IN ?.
func InTuple(column string, count int) Cmp {
	return Cmp{
		op:     in,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// InNamed produces column IN ? with a custom parameter name.
func InNamed(column, name string) Cmp {
	return Cmp{
		op:     in,
		column: column,
		value:  param(name),
	}
}

// InTupleNamed produces column IN ? with a custom parameter name.
func InTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     in,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// InLit produces column IN literal and does not add a parameter to the query.
func InLit(column, literal string) Cmp {
	return Cmp{
		op:     in,
		column: column,
		value:  lit(literal),
	}
}

// Contains produces column CONTAINS ?.
func Contains(column string) Cmp {
	return Cmp{
		op:     cnt,
		column: column,
		value:  param(column),
	}
}

// ContainsTuple produces column CONTAINS (?,?,...) with count placeholders.
func ContainsTuple(column string, count int) Cmp {
	return Cmp{
		op:     cnt,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// ContainsKey produces column CONTAINS KEY ?.
func ContainsKey(column string) Cmp {
	return Cmp{
		op:     cntKey,
		column: column,
		value:  param(column),
	}
}

// ContainsKeyTuple produces column CONTAINS KEY (?,?,...) with count placehplders.
func ContainsKeyTuple(column string, count int) Cmp {
	return Cmp{
		op:     cntKey,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// ContainsNamed produces column CONTAINS ? with a custom parameter name.
func ContainsNamed(column, name string) Cmp {
	return Cmp{
		op:     cnt,
		column: column,
		value:  param(name),
	}
}

// ContainsKeyNamed produces column CONTAINS KEY ? with a custom parameter name.
func ContainsKeyNamed(column, name string) Cmp {
	return Cmp{
		op:     cntKey,
		column: column,
		value:  param(name),
	}
}

// ContainsTupleNamed produces column CONTAINS (?,?,...) with count placeholders and custom name.
func ContainsTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     cnt,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// ContainsKeyTupleNamed produces column CONTAINS KEY (?,?,...) with count placehplders and custom name.
func ContainsKeyTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     cntKey,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

// ContainsLit produces column CONTAINS literal and does not add a parameter to the query.
func ContainsLit(column, literal string) Cmp {
	return Cmp{
		op:     cnt,
		column: column,
		value:  lit(literal),
	}
}

// Like produces column LIKE ?.
func Like(column string) Cmp {
	return Cmp{
		op:     like,
		column: column,
		value:  param(column),
	}
}

// LikeTuple produces column LIKE (?,?,...) with count placeholders.
func LikeTuple(column string, count int) Cmp {
	return Cmp{
		op:     like,
		column: column,
		value: tupleParam{
			param: param(column),
			count: count,
		},
	}
}

// LikeTupleNamed produces column LIKE (?,?,...) with count placeholders and custom name.
func LikeTupleNamed(column string, count int, name string) Cmp {
	return Cmp{
		op:     like,
		column: column,
		value: tupleParam{
			param: param(name),
			count: count,
		},
	}
}

type cmps []Cmp

func (cs cmps) writeCql(cql *bytes.Buffer) (names []string) {
	for i, c := range cs {
		names = append(names, c.writeCql(cql)...)
		if i < len(cs)-1 {
			cql.WriteString(" AND ")
		}
	}
	cql.WriteByte(' ')
	return
}

type where cmps

func (w where) writeCql(cql *bytes.Buffer) (names []string) {
	if len(w) == 0 {
		return
	}

	cql.WriteString("WHERE ")
	return cmps(w).writeCql(cql)
}

type _if cmps

func (w _if) writeCql(cql *bytes.Buffer) (names []string) {
	if len(w) == 0 {
		return
	}

	cql.WriteString("IF ")
	return cmps(w).writeCql(cql)
}