columns

Documentation

Index

• type Column
  • func (c *Column) SetSelectSQL(s string)
  • func (c Column) UpdateString() string
• type Columns
  • func ColumnsForStruct(s interface{}, tableName string) (columns Columns)
  • func ColumnsForStructWithAlias(s interface{}, tableName string, tableAlias string) (columns Columns)
  • func ForStruct(s interface{}, tableName string) (columns Columns)
  • func ForStructWithAlias(s interface{}, tableName string, tableAlias string) (columns Columns)
  • func NewColumns(tableName string) Columns
  • func NewColumnsWithAlias(tableName string, tableAlias string) Columns
  • func (c *Columns) Add(names ...string) []*Column
  • func (c Columns) Readable() *ReadableColumns
  • func (c *Columns) Remove(names ...string)
  • func (c Columns) String() string
  • func (c Columns) SymbolizedString() string
  • func (c Columns) Writeable() *WriteableColumns
• type ReadableColumns
  • func (c ReadableColumns) SelectString() string
• type Tag
  • func (t Tag) Empty() bool
  • func (t Tag) Ignored() bool
• type Tags
  • func TagsFor(field reflect.StructField) Tags
  • func (t Tags) Find(name string) Tag
• type WriteableColumns
  • func (c WriteableColumns) UpdateString() string

Types

type Column

type Column struct {
	Name      string
	Writeable bool
	Readable  bool
	SelectSQL string
}

Column represents a SQL table column.

func (*Column) SetSelectSQL

func (c *Column) SetSelectSQL(s string)

SetSelectSQL sets a custom SELECT statement for the column.

func (Column) UpdateString

func (c Column) UpdateString() string

UpdateString returns the SQL statement to UPDATE the column.

type Columns

type Columns struct {
	Cols map[string]*Column

	TableName  string
	TableAlias string
	// contains filtered or unexported fields
}

Columns represent a list of columns, related to a given table.

func ColumnsForStruct

func ColumnsForStruct(s interface{}, tableName string) (columns Columns)

ColumnsForStruct returns a Columns instance for the struct passed in.

Deprecated: use ForStruct instead.

func ColumnsForStructWithAlias

func ColumnsForStructWithAlias(s interface{}, tableName string, tableAlias string) (columns Columns)

ColumnsForStructWithAlias returns a Columns instance for the struct passed in. If the tableAlias is not empty, it will be used.

Deprecated: use ForStructWithAlias instead.

func ForStruct

func ForStruct(s interface{}, tableName string) (columns Columns)

ForStruct returns a Columns instance for the struct passed in.

func ForStructWithAlias

func ForStructWithAlias(s interface{}, tableName string, tableAlias string) (columns Columns)

ForStructWithAlias returns a Columns instance for the struct passed in. If the tableAlias is not empty, it will be used.

func NewColumns

func NewColumns(tableName string) Columns

NewColumns constructs a list of columns for a given table name.

func NewColumnsWithAlias

func NewColumnsWithAlias(tableName string, tableAlias string) Columns

NewColumnsWithAlias constructs a list of columns for a given table name, using a given alias for the table.

func (*Columns) Add

func (c *Columns) Add(names ...string) []*Column

Add a column to the list.

func (Columns) Readable

func (c Columns) Readable() *ReadableColumns

Readable gets a list of the readable columns from the column list.

func (*Columns) Remove

func (c *Columns) Remove(names ...string)

Remove a column from the list.

func (Columns) String

func (c Columns) String() string

func (Columns) SymbolizedString

func (c Columns) SymbolizedString() string

SymbolizedString returns a list of tokens (:token) to bind a value to an INSERT query.

func (Columns) Writeable

func (c Columns) Writeable() *WriteableColumns

Writeable gets a list of the writeable columns from the column list.

type ReadableColumns

type ReadableColumns struct {
	Columns
}

ReadableColumns represents a list of columns Pop is allowed to read.

func (ReadableColumns) SelectString

func (c ReadableColumns) SelectString() string

SelectString returns the SQL column list part of the SELECT query.

type Tag

type Tag struct {
	Value string
	Name  string
}

Tag represents a field tag defined exclusively for pop package.

func (Tag) Empty

func (t Tag) Empty() bool

Empty validates if this pop tag is empty.

func (Tag) Ignored

func (t Tag) Ignored() bool

Ignored validates if this pop tag is ignored. assuming an ignored tag as "-".

type Tags

type Tags []Tag

Tags is a group of pop tags defined in just one model field.

func TagsFor

func TagsFor(field reflect.StructField) Tags

TagsFor is a function which returns all tags defined in model field.

func (Tags) Find

func (t Tags) Find(name string) Tag

Find find for a specific tag with the name passed as a param. returns an empty Tag in case it is not found.

type WriteableColumns

type WriteableColumns struct {
	Columns
}

WriteableColumns represents a list of columns Pop is allowed to write.

func (WriteableColumns) UpdateString

func (c WriteableColumns) UpdateString() string

UpdateString returns the SQL column list part of the UPDATE query.