zitadel/backend/v3/storage/database/column.go

package database

import "go.uber.org/mock/gomock"

// Column represents a column in a database table.
type Column interface {
	gomock.Matcher
	argWriter
	// WriteQualified writes the column with the table name as prefix.
	WriteQualified(builder *StatementBuilder)
	// WriteUnqualified writes the column without the table name as prefix.
	WriteUnqualified(builder *StatementBuilder)
	// Equals checks if two columns are equal.
	Equals(col Column) bool
}

type Columns []Column

// Matches implements [Column].
func (c Columns) Matches(x any) bool {
	for _, col := range c {
		if !col.Matches(x) {
			return false
		}
	}

	return true
}

// String implements [Column].
func (c Columns) String() string {
	return "database.Columns"
}

// WriteQualified implements [Column].
// Columns are separated by ", ".
func (c Columns) WriteQualified(builder *StatementBuilder) {
	for i, col := range c {
		if i > 0 {
			builder.WriteString(", ")
		}
		col.WriteQualified(builder)
	}
}

// WriteUnqualified implements [Column].
// Columns are separated by ", ".
func (c Columns) WriteUnqualified(builder *StatementBuilder) {
	for i, col := range c {
		if i > 0 {
			builder.WriteString(", ")
		}
		col.WriteUnqualified(builder)
	}
}

// Equals implements [Column].
func (c Columns) Equals(col Column) bool {
	if col == nil {
		return c == nil
	}
	other, ok := col.(Columns)
	if !ok || len(other) != len(c) {
		return false
	}
	for i, col := range c {
		if !col.Equals(other[i]) {
			return false
		}
	}
	return true
}

// WriteArg implements [Column].
func (c Columns) WriteArg(builder *StatementBuilder) {
	c.WriteQualified(builder)
}

var _ Column = (Columns)(nil)

type column struct {
	table string
	name  string
}

func NewColumn(table, name string) Column {
	return &column{table: table, name: name}
}

// Matches implements [Column].
func (c column) Matches(x any) bool {
	toMatch, ok := x.(*column)
	if !ok {
		return false
	}
	return c.table == toMatch.table && c.name == toMatch.name
}

// String implements [Column].
func (c column) String() string {
	return "database.column"
}

// WriteQualified implements [Column].
func (c column) WriteQualified(builder *StatementBuilder) {
	builder.Grow(len(c.table) + len(c.name) + 1)
	builder.WriteString(c.table)
	builder.WriteRune('.')
	builder.WriteString(c.name)
}

// WriteUnqualified implements [Column].
func (c column) WriteUnqualified(builder *StatementBuilder) {
	builder.WriteString(c.name)
}

// Equals implements [Column].
func (c *column) Equals(col Column) bool {
	if col == nil {
		return c == nil
	}
	toMatch, ok := col.(*column)
	if !ok {
		return false
	}
	return c.table == toMatch.table && c.name == toMatch.name
}

// WriteArg implements [Column].
func (c column) WriteArg(builder *StatementBuilder) {
	c.WriteQualified(builder)
}

var _ Column = (*column)(nil)

type functionColumn struct {
	fn  function
	col Column
}

type function string

const (
	_              function = ""
	functionLower  function = "LOWER"
	functionSHA256 function = "SHA256"
)

// LowerColumn returns a column that represents LOWER(col).
func LowerColumn(col Column) Column {
	return &functionColumn{fn: functionLower, col: col}
}

// SHA256Column returns a column that represents SHA256(col).
func SHA256Column(col Column) Column {
	return &functionColumn{fn: functionSHA256, col: col}
}

// Matches implements [Column].
func (c *functionColumn) Matches(x any) bool {
	toMatch, ok := x.(*functionColumn)
	if !ok || toMatch.fn != c.fn {
		return false
	}
	if toMatch.col == nil {
		return c.col == nil
	}
	if c.col == nil {
		return false
	}
	return toMatch.col.Matches(c.col)
}

// String implements [Column].
func (c *functionColumn) String() string {
	return "database.functionColumn"
}

// WriteQualified implements [Column].
func (c functionColumn) WriteQualified(builder *StatementBuilder) {
	builder.Grow(len(c.fn) + 2)
	builder.WriteString(string(c.fn))
	builder.WriteRune('(')
	c.col.WriteQualified(builder)
	builder.WriteRune(')')
}

// WriteUnqualified implements [Column].
func (c functionColumn) WriteUnqualified(builder *StatementBuilder) {
	builder.Grow(len(c.fn) + 2)
	builder.WriteString(string(c.fn))
	builder.WriteRune('(')
	c.col.WriteUnqualified(builder)
	builder.WriteRune(')')
}

// Equals implements [Column].
func (c *functionColumn) Equals(col Column) bool {
	if col == nil {
		return c == nil
	}
	toMatch, ok := col.(*functionColumn)
	if !ok || toMatch.fn != c.fn {
		return false
	}
	return c.col.Equals(toMatch.col)
}

// WriteArg implements [Column].
func (c functionColumn) WriteArg(builder *StatementBuilder) {
	c.WriteQualified(builder)
}

var _ Column = (*functionColumn)(nil)