Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

velum

package module

Go to main page

Versions in this module

v0

v0.0.3

May 21, 2025

v0.0.2

Apr 8, 2025

Changes in this version

+ type DatabaseWrapper interface

+ Begin func(context.Context) (Transaction, error)

+ InTx func(context.Context, func(Transaction) error) error

+ IsNotFound func(err error) bool

type ReturningCommand

+ func (c *ReturningCommand[T]) QueryRowTo(ctx context.Context, q QueryRowExecuter, str *T, args ...any) error

type Table

+ func (t *Table[T]) InsertScope(ctx context.Context, q Executer, row *T, scope Scope) (Result, error)

+ func (t *Table[T]) SelectAll(ctx context.Context, q QueryExecuter) ([]T, error)

v0.0.1

Apr 6, 2025

Changes in this version

+ var DefaultColumnNameBuilder = ToSnakeCase

+ var DefaultFieldTag = "dbw"

+ var DefaultFriendlySequenceNameBuilder = TableWithSeqSuffix

+ var DefaultParamPlaceholderBuilder = ArgAsNumber

+ var DeleteScope Scope = "delete"

+ var ErrInvalidScopePair = errors.New("invalid scope pair")

+ var ErrNoPrimaryKey = errors.New("no primary key defined")

+ var ErrScopeMismatch = errors.New("scope mismatch")

+ var InsertScope Scope = "insert"

+ var PrimaryKeyTagOption = "pk"

+ var StandardPrimaryKeyCol = "id"

+ var SystemScope Scope = "system"

+ var SystemScopes = []*Scope

+ var TagKey = "dbw"

+ var UpdateScope Scope = "update"

+ var VersionField Scope = "version"

+ func ArgAsNumber(i int) string

+ func ArgAsQuestionMark(i int) string

+ func InsertArgument(genMethod ColumnValueGenMethod, valueGenerator string, regularParam string) (sqlParam string)

+ func IsSystemScope(s Scope) bool

+ func IsTagOptionExist(tag string, tagOption string) bool

+ func ShiftParamPositions(sqlWhere string, fromIndex int) string

+ func StructPluralName(v any) string

+ func TableWithSeqSuffix(tablename string) string

+ func ToPluralName(s string) string

+ func ToSnakeCase(attr, tag string) string

+ type ArgFormatter func(i int) string

+ type Column struct

+ Name string

+ Path []int

+ Tag reflectx.TagPairs

+ ValueGenerationMethod ColumnValueGenMethod

+ ValueGenerator string

+ func (c *Column) IsSystem() bool

+ func (c *Column) IsValueGeneratedByDB() bool

+ type ColumnValueGenMethod string

+ const CustomSequece

+ const FriendlySequence

+ const NoSequence

+ const SerialFieleType

+ const UuidFileType

+ type Command struct

+ func (c *Command[T]) Exec(ctx context.Context, q Executer, row *T, args ...any) (Result, error)

+ type CommandContanier struct

+ func NewCommandContainer[T any](t *Table[T], sfpe StructFieldPtrExtractor[T], sc map[scopeKey]clause, ...) *CommandContanier[T]

+ func (cc *CommandContanier[T]) Delete(clauses string) Command[T]

+ func (cc *CommandContanier[T]) DeleteReturning(retScope Scope, clauses string) ReturningCommand[T]

+ func (cc *CommandContanier[T]) Func(typ FunctionalCommandEnum, clauses string) FunctionalCommand[T]

+ func (cc *CommandContanier[T]) Insert(scope Scope) Command[T]

+ func (cc *CommandContanier[T]) InsertReturning(argScope, retScope Scope) ReturningCommand[T]

+ func (cc *CommandContanier[T]) Select(scope Scope, clauses string) SelectCommand[T]

+ func (cc *CommandContanier[T]) Update(scope Scope, condition UpdateByOption) Command[T]

+ func (cc *CommandContanier[T]) UpdateReturning(argScope, retScope Scope, condition UpdateByOption) ReturningCommand[T]

+ type CommandTypeEnum int

+ const CommandTypeEnumMax_

+ const Delete

+ const Insert

+ const Update

+ type DoubleScopeKey struct

+ type Executer interface

+ ExecContext func(ctx context.Context, sql string, args ...any) (Result, error)

+ type FuncCommandKey struct

+ type FunctionalCommand struct

+ func (c *FunctionalCommand[T]) Call(ctx context.Context, q QueryRowExecuter, dst any, args ...any) error

+ type FunctionalCommandEnum int

+ const Count

+ const Exist

+ const ExistByPK

+ type IsolationLevel int

+ const LevelDefault

+ const LevelLinearizable

+ const LevelReadCommitted

+ const LevelReadUncommitted

+ const LevelRepeatableRead

+ const LevelSerializable

+ const LevelSnapshot

+ const LevelWriteCommitted

+ type QueryExecuter interface

+ QueryContext func(ctx context.Context, sql string, args ...any) (Rows, error)

+ type QueryRowExecuter interface

+ QueryRowContext func(ctx context.Context, sql string, args ...any) Row

+ type Result interface

+ RowsAffected func() (int64, error)

+ type ReturningCommand struct

+ func (c *ReturningCommand[T]) Query(ctx context.Context, q QueryExecuter, args ...any) ([]T, error)

+ func (c *ReturningCommand[T]) QueryRow(ctx context.Context, q QueryRowExecuter, str *T, args ...any) (*T, error)

+ type Row interface

+ Err func() error

+ Scan func(args ...any) error

+ type Rows interface

+ Close func() error

+ Err func() error

+ Next func() bool

+ Scan func(dest ...any) error

+ type Scope string

+ const EmptyScope

+ const FullScope

+ type SelectCommand Command[T]

+ func (c *SelectCommand[T]) Get(ctx context.Context, q QueryRowExecuter, args ...any) (*T, error)

+ func (c *SelectCommand[T]) GetMany(ctx context.Context, q QueryExecuter, args ...any) ([]T, error)

+ func (c *SelectCommand[T]) GetToPtr(ctx context.Context, q QueryRowExecuter, dst []any, args ...any) error

+ type SingleScopeKey struct

+ type StructFieldPtrExtractor interface

+ Release func(*[]any)

+ StructFieldPtrs func(v *T, fieldPositions []int) *[]any

+ type SystemColumn struct

+ Pos int

+ type Table struct

+ ObjPool *sync.Pool

+ func NewTable[T any](tablename string, opts ...TableOption) *Table[T]

+ func (t *Table[T]) ArgNumerator() ArgFormatter

+ func (t *Table[T]) Columns() []Column

+ func (t *Table[T]) CommandContainer() *CommandContanier[T]

+ func (t *Table[T]) Count(ctx context.Context, q QueryRowExecuter, clauses string, args ...any) (int, error)

+ func (t *Table[T]) Created() []SystemColumn

+ func (t *Table[T]) Delete(ctx context.Context, q Executer, clauses string, args ...any) (Result, error)

+ func (t *Table[T]) DeleteByPK(ctx context.Context, q Executer, pk any) (Result, error)

+ func (t *Table[T]) DeleteReturning(ctx context.Context, q QueryRowExecuter, row *T, clauses string) (*T, error)

+ func (t *Table[T]) DeleteReturningByPK(ctx context.Context, q QueryRowExecuter, row *T) (*T, error)

+ func (t *Table[T]) Deleted() []SystemColumn

+ func (t *Table[T]) Exist(ctx context.Context, q QueryRowExecuter, clauses string, args ...any) (bool, error)

+ func (t *Table[T]) ExistByPK(ctx context.Context, q QueryRowExecuter, pk any) (bool, error)

+ func (t *Table[T]) FormatArg(pos int) string

+ func (t *Table[T]) FriendlySequence() string

+ func (t *Table[T]) Get(ctx context.Context, q QueryRowExecuter, scope Scope, clauses string, ...) (*T, error)

+ func (t *Table[T]) GetByPK(ctx context.Context, q QueryRowExecuter, pk any) (*T, error)

+ func (t *Table[T]) GetTo(ctx context.Context, q QueryRowExecuter, dst []any, pk any) error

+ func (t *Table[T]) Insert(ctx context.Context, q Executer, row *T, scope Scope) (Result, error)

+ func (t *Table[T]) InsertReturning(ctx context.Context, q QueryRowExecuter, row *T, scope, retScope Scope) (*T, error)

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

+ func (t *Table[T]) Object(scope Scope) (*T, *[]any)

+ func (t *Table[T]) ObjectPut(v *T, ptrs *[]any)

+ func (t *Table[T]) PK() *SystemColumn

+ func (t *Table[T]) Scope(s string) Scope

+ func (t *Table[T]) ScopeContainer() map[scopeKey]clause

+ func (t *Table[T]) Select(ctx context.Context, q QueryExecuter, scope Scope, clauses string, args ...any) ([]T, error)

+ func (t *Table[T]) SoftDeleteByPK(ctx context.Context, q Executer, row *T) (Result, error)

+ func (t *Table[T]) SoftDeleteReturningByPK(ctx context.Context, q QueryRowExecuter, row *T) (*T, error)

+ func (t *Table[T]) TouchByPK(ctx context.Context, q Executer, row *T) (Result, error)

+ func (t *Table[T]) Update(ctx context.Context, q Executer, row *T, scope Scope, clauses string) (Result, error)

+ func (t *Table[T]) UpdateByPK(ctx context.Context, q Executer, row *T, scope Scope) (Result, error)

+ func (t *Table[T]) UpdateReturning(ctx context.Context, q QueryRowExecuter, row *T, scope, retScope Scope, ...) (*T, error)

+ func (t *Table[T]) UpdateReturningByPK(ctx context.Context, q QueryRowExecuter, row *T, scope, retScope Scope) (*T, error)

+ func (t *Table[T]) Updated() []SystemColumn

+ func (t *Table[T]) Validate(ctx context.Context) error

+ func (t *Table[T]) Version() *SystemColumn

+ type TableConfig struct

+ type TableOption func(*TableConfig)

+ func WithArgFormatter(f ArgFormatter) TableOption

+ func WithColumnNameBuilder(f func(attr string, tag string) string) TableOption

+ func WithName(name string) TableOption

+ func WithSequenceNameBuilder(f func(string) string) TableOption

+ func WithTag(tag string) TableOption

+ type Tabler interface

+ Columns func() []Column

+ FormatArg func(int) string

+ Name func() string

+ PK func() *SystemColumn

+ type Transaction interface

+ Commit func(context.Context) error

+ Rollback func(context.Context) error

+ type TransactionManager interface

+ Begin func() (Transaction, error)

+ BeginTx func(context.Context, IsolationLevel) (Transaction, error)

+ InTx func(context.Context, func(context.Context, Transaction) error) error

+ type UpdateByOption func() string

+ func ByClauses(clauses string) UpdateByOption

+ func ByPK() UpdateByOption