Help us shape the future of Go! Take the 2026 Go Developer Survey

golang

package
v0.6.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 30, 2026 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func EnumReplace 

func EnumReplace(value string) string

EnumReplace removes all non ident symbols (all but letters, numbers and underscore) and returns valid ident name for provided name.

func EnumValueName 

func EnumValueName(value string) string

EnumValueName removes all non ident symbols (all but letters, numbers and underscore) and converts snake case ident to camel case.

func Generate 

func Generate(ctx context.Context, req *plugin.GenerateRequest) (*plugin.GenerateResponse, error)

func IsReserved 

func IsReserved(s string) bool

func JSONTagName 

func JSONTagName(name string, options *opts.Options) string

func SetCaseStyle 

func SetCaseStyle(name string, style string) string

func SetJSONCaseStyle 

func SetJSONCaseStyle(name string, style string, idUppercase bool) string

func StructName 

func StructName(name string, options *opts.Options) string

func TagsToString 

func TagsToString(tags map[string]string) string

Types

type Argument 

type Argument struct {
	Name string
	Type string
}

type BuilderFilter added in v0.3.0 

type BuilderFilter struct {
	Column   string
	SQLName  string
	Method   string
	Operator string
	GoType   string
}

type BuilderOrder added in v0.3.0 

type BuilderOrder struct {
	Column string
	SQL    string
	Method string
}

type Constant 

type Constant struct {
	Name  string
	Type  string
	Value string
}

type Enum 

type Enum struct {
	Name      string
	Comment   string
	Constants []Constant
	NameTags  map[string]string
	ValidTags map[string]string
}

func (Enum) NameTag 

func (e Enum) NameTag() string

func (Enum) ValidTag 

func (e Enum) ValidTag() string

type Field 

type Field struct {
	Name    string // CamelCased name for Go
	DBName  string // Name as used in the DB
	Type    string
	Tags    map[string]string
	Comment string
	Column  *plugin.Column
	// EmbedFields contains the embedded fields that require scanning.
	EmbedFields []Field
}

func (Field) HasSqlcSlice 

func (gf Field) HasSqlcSlice() bool

func (Field) Tag 

func (gf Field) Tag() string

type ImportSpec 

type ImportSpec struct {
	ID   string
	Path string
}

func (ImportSpec) String 

func (s ImportSpec) String() string

type Query 

type Query struct {
	Cmd          string
	Comments     []string
	MethodName   string
	FieldName    string
	ConstantName string
	SQL          string
	SourceName   string
	Ret          QueryValue
	Arg          QueryValue
	Builder      *QueryBuilder

	// Used for :copyfrom
	Table *plugin.Identifier
	// contains filtered or unexported fields
}

A struct used to generate methods and fields on the Queries struct

func (Query) AndurelGeneric 

func (q Query) AndurelGeneric() bool

AndurelGeneric reports whether this query should emit a generic method that scans into a caller-chosen struct via andurel tags.

func (Query) BuilderType added in v0.3.0 

func (q Query) BuilderType() string

func (Query) BuilderTypeDecl added in v0.3.0 

func (q Query) BuilderTypeDecl() string

func (Query) BuilderTypeRef added in v0.3.0 

func (q Query) BuilderTypeRef() string

func (Query) HasBuilder added in v0.3.0 

func (q Query) HasBuilder() bool

func (Query) TableIdentifierAsGoSlice 

func (q Query) TableIdentifierAsGoSlice() string

func (Query) TableIdentifierForMySQL 

func (q Query) TableIdentifierForMySQL() string

type QueryBuilder added in v0.3.0 

type QueryBuilder struct {
	Filters  []BuilderFilter
	Orders   []BuilderOrder
	HasWhere bool
	Dollar   bool
}

type QueryValue 

type QueryValue struct {
	Emit        bool
	EmitPointer bool
	Name        string
	DBName      string // The name of the field in the database. Only set if Struct==nil.
	Struct      *Struct
	Typ         string
	SQLDriver   opts.SQLDriver

	// ModelQualifier prefixes references to model types when the models file
	// lives in a different Go package (e.g. "model."). Empty otherwise.
	ModelQualifier string

	// Column is kept so late in the generation process around to differentiate
	// between mysql slices and pg arrays
	Column *plugin.Column
}

func (QueryValue) ColumnNames 

func (v QueryValue) ColumnNames() []string

func (QueryValue) ColumnNamesAsGoSlice 

func (v QueryValue) ColumnNamesAsGoSlice() string

func (QueryValue) CopyFromMySQLFields deprecated 

func (v QueryValue) CopyFromMySQLFields() []Field

Deprecated: This method does not respect the Emit field set on the QueryValue. It's used by the go-sql-driver-mysql/copyfromCopy.tmpl and should not be used other places.

func (*QueryValue) DefineType 

func (v *QueryValue) DefineType() string

func (QueryValue) EmitStruct 

func (v QueryValue) EmitStruct() bool

func (QueryValue) HasSqlcSlices 

func (v QueryValue) HasSqlcSlices() bool

When true, we have to build the arguments to q.db.QueryContext in addition to munging the SQL

func (QueryValue) IsPointer 

func (v QueryValue) IsPointer() bool

func (QueryValue) IsStruct 

func (v QueryValue) IsStruct() bool

func (QueryValue) Pair 

func (v QueryValue) Pair() string

func (QueryValue) Pairs 

func (v QueryValue) Pairs() []Argument

Return the argument name and type for query methods. Should only be used in the context of method arguments.

func (QueryValue) Params 

func (v QueryValue) Params() string

func (*QueryValue) ReturnName 

func (v *QueryValue) ReturnName() string

func (QueryValue) Scan 

func (v QueryValue) Scan() string

func (QueryValue) ScanColumnNamesAsGoSlice added in v0.6.3 

func (v QueryValue) ScanColumnNamesAsGoSlice() string

ScanColumnNamesAsGoSlice lists the result columns a generated row scan matches its andurel tags against. It uses the name the query gives the result (the AS alias when there is one), not the underlying table column.

func (QueryValue) SlicePair 

func (v QueryValue) SlicePair() string

func (QueryValue) Type 

func (v QueryValue) Type() string

func (QueryValue) UniqueFields 

func (v QueryValue) UniqueFields() []Field

func (QueryValue) VariableForField 

func (v QueryValue) VariableForField(f Field) string

type Struct 

type Struct struct {
	Table   *plugin.Identifier
	Name    string
	Fields  []Field
	Comment string
	// IsModel is true for table structs that live in the models file. When
	// the models file is generated into a different Go package, references
	// to these types from query files must be qualified.
	IsModel bool
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.