golang

Documentation

Index

• Constants
• Variables
• func EnumReplace(value string) string
• func EnumValueName(value string) string
• func Generate(ctx context.Context, req *plugin.CodeGenRequest) (*plugin.CodeGenResponse, error)
• func JSONTagName(name string, settings *plugin.Settings) string
• func SetCaseStyle(name string, style string) string
• func SetJSONCaseStyle(name string, style string, idUppercase bool) string
• func StructName(name string, settings *plugin.Settings) string
• func TagsToString(tags map[string]string) string
• type Constant
• type Enum
  • func (e Enum) NameTag() string
  • func (e Enum) ValidTag() string
• type Field
  • func (gf Field) HasSqlcSlice() bool
  • func (gf Field) Tag() string
• type ImportSpec
  • func (s ImportSpec) String() string
• type Query
  • func (q Query) TableIdentifierAsGoSlice() string
  • func (q Query) TableIdentifierForMySQL() string
• type QueryValue
  • func (v QueryValue) ColumnNames() []string
  • func (v QueryValue) ColumnNamesAsGoSlice() string
  • func (v *QueryValue) DefineType() string
  • func (v QueryValue) EmitStruct() bool
  • func (v QueryValue) Fields() []Field
  • func (v QueryValue) HasSqlcSlices() bool
  • func (v QueryValue) IsPointer() bool
  • func (v QueryValue) IsStruct() bool
  • func (v QueryValue) Pair() string
  • func (v QueryValue) Params() string
  • func (v *QueryValue) ReturnName() string
  • func (v QueryValue) Scan() string
  • func (v QueryValue) SlicePair() string
  • func (v QueryValue) Type() string
  • func (v QueryValue) UniqueFields() []Field
  • func (v QueryValue) VariableForField(f Field) string
• type SQLDriver
  • func (d SQLDriver) IsGoSQLDriverMySQL() bool
  • func (d SQLDriver) IsPGX() bool
  • func (d SQLDriver) Package() string
• type Struct

Constants

const (
	SQLPackagePGXV4    string = "pgx/v4"
	SQLPackagePGXV5    string = "pgx/v5"
	SQLPackageStandard string = "database/sql"
)

const (
	SQLDriverPGXV4            SQLDriver = "github.com/jackc/pgx/v4"
	SQLDriverPGXV5                      = "github.com/jackc/pgx/v5"
	SQLDriverLibPQ                      = "github.com/lib/pq"
	SQLDriverGoSQLDriverMySQL           = "github.com/go-sql-driver/mysql"
)

Variables

var IdentPattern = regexp.MustCompile("[^a-zA-Z0-9_]+")

Functions

func EnumReplace

func EnumReplace(value string) string

func EnumValueName

func EnumValueName(value string) string

func Generate

func Generate(ctx context.Context, req *plugin.CodeGenRequest) (*plugin.CodeGenResponse, error)

func JSONTagName

func JSONTagName(name string, settings *plugin.Settings) 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, settings *plugin.Settings) string

func TagsToString

func TagsToString(tags map[string]string) string

Types

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
	// Used for :copyfrom
	Table *plugin.Identifier
}

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

func (Query) TableIdentifierAsGoSlice

func (q Query) TableIdentifierAsGoSlice() string

func (Query) TableIdentifierForMySQL

func (q Query) TableIdentifierForMySQL() string

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   SQLDriver

	// 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) DefineType

func (v *QueryValue) DefineType() string

func (QueryValue) EmitStruct

func (v QueryValue) EmitStruct() bool

func (QueryValue) Fields

func (v QueryValue) Fields() []Field

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) Params

func (v QueryValue) Params() string

func (*QueryValue) ReturnName

func (v *QueryValue) ReturnName() string

func (QueryValue) Scan

func (v QueryValue) Scan() string

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 SQLDriver

type SQLDriver string

func (SQLDriver) IsGoSQLDriverMySQL

func (d SQLDriver) IsGoSQLDriverMySQL() bool

func (SQLDriver) IsPGX

func (d SQLDriver) IsPGX() bool

func (SQLDriver) Package

func (d SQLDriver) Package() string

type Struct

type Struct struct {
	Table   *plugin.Identifier
	Name    string
	Fields  []Field
	Comment string
}