table

package

v2.0.5 Latest Latest Go to latest Published: Jan 10, 2026 License: AGPL-3.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/guadalsistema/go-compose-sql

Links

Open Source Insights

Documentation ¶

Index ¶

type Column
- func Col[T any](name string) *Column[T]
- func NewColumn[T any](name string) *Column[T]
type ColumnOptions
type ColumnRef
type ForeignKeyRef
type Table
- func NewTable[T any](name string, columnStruct T) *Table[T]

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Column ¶

type Column[T any] struct {
	// contains filtered or unexported fields
}

Column represents a database column with type safety

func Col ¶

func Col[T any](name string) *Column[T]

Col is a shorthand for NewColumn

func NewColumn ¶

func NewColumn[T any](name string) *Column[T]

NewColumn creates a new column

func (*Column[T]) AutoIncrement ¶

func (c *Column[T]) AutoIncrement() *Column[T]

AutoIncrement marks this column as auto-incrementing

func (*Column[T]) Default ¶

func (c *Column[T]) Default(val T) *Column[T]

Default sets a default value for this column

func (*Column[T]) ForeignKey ¶

func (c *Column[T]) ForeignKey(table, column string) *Column[T]

ForeignKey sets a foreign key reference

func (*Column[T]) FullName ¶

func (c *Column[T]) FullName() string

FullName returns the fully qualified column name (table.column)

func (*Column[T]) Name ¶

func (c *Column[T]) Name() string

Name returns the column name

func (*Column[T]) NotNull ¶

func (c *Column[T]) NotNull() *Column[T]

NotNull marks this column as NOT NULL

func (*Column[T]) Options ¶

func (c *Column[T]) Options() ColumnOptions

Options returns the column options

func (*Column[T]) PrimaryKey ¶

func (c *Column[T]) PrimaryKey() *Column[T]

PrimaryKey marks this column as a primary key

func (*Column[T]) TableName ¶

func (c *Column[T]) TableName() string

TableName returns the table name this column belongs to

func (*Column[T]) Type ¶ added in v2.0.4

func (c *Column[T]) Type() reflect.Type

Type returns the reflect.Type of this column's Go type This is used by the query builder to determine expected types for scanning

func (*Column[T]) Unique ¶

func (c *Column[T]) Unique() *Column[T]

Unique marks this column as UNIQUE

type ColumnOptions ¶

type ColumnOptions struct {
	PrimaryKey bool
	NotNull    bool
	Unique     bool
	AutoIncr   bool
	DefaultVal interface{}
	ForeignKey *ForeignKeyRef
}

ColumnOptions holds column metadata

type ColumnRef ¶

type ColumnRef struct {
	Name     string
	FullName string
	Type     reflect.Type
	Options  ColumnOptions
}

ColumnRef holds metadata about a column without type parameters

type ForeignKeyRef ¶

type ForeignKeyRef struct {
	Table  string
	Column string
}

ForeignKeyRef represents a foreign key relationship

type Table ¶

type Table[T any] struct {
	C T // Column accessor (holds column definitions)
	// contains filtered or unexported fields
}

Table represents a database table with typed columns

func NewTable ¶

func NewTable[T any](name string, columnStruct T) *Table[T]

NewTable creates a new table with the given name and column definitions

func (*Table[T]) ColumnNames ¶

func (t *Table[T]) ColumnNames() []string

ColumnNames returns all column names

func (*Table[T]) ColumnTypes ¶ added in v2.0.4

func (t *Table[T]) ColumnTypes() []reflect.Type

ColumnTypes returns all column types for use in type conversion

func (*Table[T]) Columns ¶

func (t *Table[T]) Columns() []*ColumnRef

Columns returns all column references

func (*Table[T]) Name ¶

func (t *Table[T]) Name() string

Name returns the table name

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL