jet/sqlbuilder/column.go

// Modeling of columns

package sqlbuilder

import (
	"bytes"
	"regexp"
	"strings"
)

// XXX: Maybe add UIntColumn

// Representation of a tableName for query generation
type Column interface {
	Expression

	Name() string
	TableName() string
	// Internal function for tracking tableName that a column belongs to
	// for the purpose of serialization
	setTableName(table string) error
}

type NullableColumn bool

const (
	Nullable    NullableColumn = true
	NotNullable NullableColumn = false
)

//// A column that can be refer to outside of the projection list
//type NonAliasColumn interface {
//	Column
//}

type Collation string

const (
	UTF8CaseInsensitive Collation = "utf8_unicode_ci"
	UTF8CaseSensitive   Collation = "utf8_unicode"
	UTF8Binary          Collation = "utf8_bin"
)

// Representation of MySQL charsets
type Charset string

const (
	UTF8 Charset = "utf8"
)

// The base type for real materialized columns.
type baseColumn struct {
	expressionInterfaceImpl

	name      string
	nullable  NullableColumn
	tableName string
}

func newBaseColumn(name string, nullable NullableColumn, tableName string, parent Column) baseColumn {
	bc := baseColumn{
		name:      name,
		nullable:  nullable,
		tableName: tableName,
	}

	bc.expressionInterfaceImpl.parent = parent

	return bc
}

func (c *baseColumn) Name() string {
	return c.name
}

func (c *baseColumn) TableName() string {
	return c.tableName
}

func (c *baseColumn) setTableName(table string) error {
	c.tableName = table
	return nil
}

func (c baseColumn) SerializeSql(out *bytes.Buffer, options ...serializeOption) error {
	if c.tableName != "" {
		_, _ = out.WriteString(c.tableName)
		_, _ = out.WriteString(".")
	}
	containsDot := strings.Contains(c.name, ".")

	if containsDot {
		out.WriteString("\"")
	}
	_, _ = out.WriteString(c.name)
	if containsDot {
		out.WriteString("\"")
	}

	if contains(options, FOR_PROJECTION) && !contains(options, ALIASED) && c.tableName != "" {
		_, _ = out.WriteString(" AS \"" + c.tableName + "." + c.name + "\"")
	}

	return nil
}

//
//type bytesColumn struct {
//	baseColumn
//}
//
//// Representation of VARBINARY/BLOB columns
//// This function will panic if name is not valid
//func BytesColumn(name string, nullable NullableColumn) Column {
//	if !validIdentifierName(name) {
//		panic("Invalid column name in bytes column")
//	}
//	bc := &bytesColumn{}
//	bc.name = name
//	bc.nullable = nullable
//	return bc
//}
//
//type stringColumn struct {
//	baseColumn
//	charset   Charset
//	collation Collation
//}
//
//// Representation of VARCHAR/TEXT columns
//// This function will panic if name is not valid
//func StrColumn(
//	name string,
//	charset Charset,
//	collation Collation,
//	nullable NullableColumn) Column {
//
//	if !validIdentifierName(name) {
//		panic("Invalid column name in str column")
//	}
//	sc := &stringColumn{charset: charset, collation: collation}
//	sc.name = name
//	sc.nullable = nullable
//	return sc
//}
//
//type dateTimeColumn struct {
//	baseColumn
//}
//
//// Representation of DateTime columns
//// This function will panic if name is not valid
//func DateTimeColumn(name string, nullable NullableColumn) Column {
//	if !validIdentifierName(name) {
//		panic("Invalid column name in datetime column")
//	}
//	dc := &dateTimeColumn{}
//	dc.name = name
//	dc.nullable = nullable
//	return dc
//}

//type IntegerColumn struct {
//	baseColumn
//}
//
//// Representation of any integer column
//// This function will panic if name is not valid
//func IntColumn(name string, nullable NullableColumn) *IntegerColumn {
//	if !validIdentifierName(name) {
//		panic("Invalid column name in int column")
//	}
//	ic := &IntegerColumn{}
//	ic.name = name
//	ic.nullable = nullable
//	return ic
//}

//type doubleColumn struct {
//	baseColumn
//}
//
//// Representation of any double column
//// This function will panic if name is not valid
//func DoubleColumn(name string, nullable NullableColumn) Column {
//	if !validIdentifierName(name) {
//		panic("Invalid column name in int column")
//	}
//	ic := &doubleColumn{}
//	ic.name = name
//	ic.nullable = nullable
//	return ic
//}
//
//type booleanColumn struct {
//	baseColumn
//
//	// XXX: Maybe allow isBoolExpression (for now, not included because
//	// the deferred lookup equivalent can never be isBoolExpression)
//}

// Representation of TINYINT used as a bool
// This function will panic if name is not valid
//func NewBoolColumn(name string, nullable NullableColumn) Column {
//	if !validIdentifierName(name) {
//		panic("Invalid column name in bool column")
//	}
//	bc := &booleanColumn{}
//	bc.name = name
//	bc.nullable = nullable
//	return bc
//}
//
//type aliasColumn struct {
//	baseColumn
//	expression Expression
//}
//
//func (c *aliasColumn) SerializeSql(out *bytes.Buffer) error {
//	_ = out.WriteByte('`')
//	_, _ = out.WriteString(c.name)
//	_ = out.WriteByte('`')
//	return nil
//}
//
//func (c *aliasColumn) SerializeSqlForColumnList(out *bytes.Buffer) error {
//	if !validIdentifierName(c.name) {
//		return errors.Newf(
//			"Invalid alias name `%s`.  Generated sql: %s",
//			c.name,
//			out.String())
//	}
//	if c.expression == nil {
//		return errors.Newf(
//			"Cannot alias a nil expression.  Generated sql: %s",
//			out.String())
//	}
//
//	_ = out.WriteByte('(')
//	if c.expression == nil {
//		return errors.Newf("nil alias clause.  Generate sql: %s", out.String())
//	}
//	if err := c.expression.SerializeSql(out); err != nil {
//		return err
//	}
//	_, _ = out.WriteString(") AS \"")
//	_, _ = out.WriteString(c.name)
//	_ = out.WriteByte('"')
//	return nil
//}

//func (c *aliasColumn) setTableName(table string) error {
//	return errors.Newf(
//		"Alias column '%s' should never have setTableName called on it",
//		c.name)
//}

// Representation of aliased clauses (expression AS name)
//func Alias(name string, c Expression) Column {
//	ac := &aliasColumn{}
//	ac.name = name
//	ac.expression = c
//	return ac
//}

// This is a strict subset of the actual allowed identifiers
var validIdentifierRegexp = regexp.MustCompile("^[a-zA-Z_]\\w*$")

// Returns true if the given string is suitable as an identifier.
func validIdentifierName(name string) bool {
	return validIdentifierRegexp.MatchString(name)
}

//
//// Pseudo Column type returned by tableName.C(name)
//type deferredLookupColumn struct {
//	isProjection
//	isExpression
//	tableName   *Table
//	colName string
//
//	cachedColumn NonAliasColumn
//}
//
//func (c *deferredLookupColumn) Name() string {
//	return c.colName
//}
//
//func (c *deferredLookupColumn) SerializeSqlForColumnList(
//	out *bytes.Buffer) error {
//
//	return c.SerializeSql(out)
//}
//
//func (c *deferredLookupColumn) SerializeSql(out *bytes.Buffer) error {
//	if c.cachedColumn != nil {
//		return c.cachedColumn.SerializeSql(out)
//	}
//
//	col, err := c.tableName.getColumn(c.colName)
//	if err != nil {
//		return err
//	}
//
//	c.cachedColumn = col
//	return col.SerializeSql(out)
//}
//
//func (c *deferredLookupColumn) setTableName(tableName string) error {
//	return errors.Newf(
//		"Lookup column '%s' should never have setTableName called on it",
//		c.colName)
//}
//
//func (c *deferredLookupColumn) Eq(rhs Expression) BoolExpression {
//	lit, ok := rhs.(*literalExpression)
//	if ok && sqltypes.Value(lit.value).IsNull() {
//		return newBoolExpression(c, rhs, []byte(" IS "))
//	}
//	return newBoolExpression(c, rhs, []byte(" = "))
//}
//
//func (c *deferredLookupColumn) Gte(rhs Expression) BoolExpression {
//	return Gte(c, rhs)
//}
//
//func (c *deferredLookupColumn) GteLiteral(rhs interface{}) BoolExpression {
//	return Gte(c, Literal(rhs))
//}
//
//func (c *deferredLookupColumn) Lte(rhs Expression) BoolExpression {
//	return Lte(c, rhs)
//}
//
//func (c *deferredLookupColumn) LteLiteral(literal interface{}) BoolExpression {
//	return Lte(c, Literal(literal))
//}
//
//func (c *deferredLookupColumn) Asc() OrderByClause {
//	return sqlbuilder.Asc(c)
//}
//
//func (c *deferredLookupColumn) Desc() OrderByClause {
//	return sqlbuilder.Desc(c)
//}