dinosql

Documentation

Index

• func DoubleSlashComment(s string) string
• func Generate(r Generateable, settings config.CombinedSettings) (map[string]string, error)
• func HasStarRef(cf nodes.ColumnRef) bool
• func Imports(r Generateable, settings config.CombinedSettings) func(string) [][]string
• func LowerTitle(s string) string
• func ParseCatalog(schemas []string) (core.Catalog, error)
• func ParseMetadata(t string, commentStyle CommentSyntax) (string, string, error)
• func ReadSQLFiles(paths []string) ([]string, error)
• func StructName(name string, settings config.CombinedSettings) string
• func UsesArrays(r Generateable, settings config.CombinedSettings) bool
• func UsesType(r Generateable, typ string, settings config.CombinedSettings) bool
• type CommentSyntax
• type FileErr
• type Generateable
• type GoConstant
• type GoEnum
• type GoField
  • func (gf GoField) Tag() string
• type GoQuery
• type GoQueryValue
  • func (v GoQueryValue) EmitStruct() bool
  • func (v GoQueryValue) IsStruct() bool
  • func (v GoQueryValue) Pair() string
  • func (v GoQueryValue) Params() string
  • func (v GoQueryValue) Scan() string
  • func (v GoQueryValue) Type() string
• type GoStruct
• type Parameter
• type ParserErr
  • func NewParserErr() *ParserErr
  • func (e *ParserErr) Add(filename, source string, loc int, err error)
  • func (e *ParserErr) Error() string
• type ParserOpts
• type Query
• type QueryCatalog
  • func (qc QueryCatalog) GetTable(fqn core.FQN) (core.Table, *core.Error)
• type Result
  • func ParseQueries(c core.Catalog, queriesPaths []string, opts ParserOpts) (*Result, error)
  • func (r Result) Enums(settings config.CombinedSettings) []GoEnum
  • func (r Result) GoQueries(settings config.CombinedSettings) []GoQuery
  • func (r Result) Structs(settings config.CombinedSettings) []GoStruct

Functions

func DoubleSlashComment

func DoubleSlashComment(s string) string

func Generate

func Generate(r Generateable, settings config.CombinedSettings) (map[string]string, error)

func HasStarRef

func HasStarRef(cf nodes.ColumnRef) bool

func Imports

func Imports(r Generateable, settings config.CombinedSettings) func(string) [][]string

func LowerTitle

func LowerTitle(s string) string

func ParseCatalog

func ParseCatalog(schemas []string) (core.Catalog, error)

func ParseMetadata

func ParseMetadata(t string, commentStyle CommentSyntax) (string, string, error)

func ReadSQLFiles

func ReadSQLFiles(paths []string) ([]string, error)

func StructName

func StructName(name string, settings config.CombinedSettings) string

func UsesArrays

func UsesArrays(r Generateable, settings config.CombinedSettings) bool

func UsesType

func UsesType(r Generateable, typ string, settings config.CombinedSettings) bool

Types

type CommentSyntax

type CommentSyntax int

const (
	CommentSyntaxDash CommentSyntax = iota
	CommentSyntaxStar               // Note: this is the only style supported by the MySQL sqlparser
	CommentSyntaxHash
)

type FileErr

type FileErr struct {
	Filename string
	Line     int
	Column   int
	Err      error
}

type Generateable

type Generateable interface {
	Structs(settings config.CombinedSettings) []GoStruct
	GoQueries(settings config.CombinedSettings) []GoQuery
	Enums(settings config.CombinedSettings) []GoEnum
}

type GoConstant

type GoConstant struct {
	Name  string
	Type  string
	Value string
}

type GoEnum

type GoEnum struct {
	Name      string
	Comment   string
	Constants []GoConstant
}

type GoField

type GoField struct {
	Name    string
	Type    string
	Tags    map[string]string
	Comment string
}

func (GoField) Tag

func (gf GoField) Tag() string

type GoQuery

type GoQuery struct {
	Cmd          string
	Comments     []string
	MethodName   string
	FieldName    string
	ConstantName string
	SQL          string
	SourceName   string
	Ret          GoQueryValue
	Arg          GoQueryValue
}

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

type GoQueryValue

type GoQueryValue struct {
	Emit   bool
	Name   string
	Struct *GoStruct
	Typ    string
}

func (GoQueryValue) EmitStruct

func (v GoQueryValue) EmitStruct() bool

func (GoQueryValue) IsStruct

func (v GoQueryValue) IsStruct() bool

func (GoQueryValue) Pair

func (v GoQueryValue) Pair() string

func (GoQueryValue) Params

func (v GoQueryValue) Params() string

func (GoQueryValue) Scan

func (v GoQueryValue) Scan() string

func (GoQueryValue) Type

func (v GoQueryValue) Type() string

type GoStruct

type GoStruct struct {
	Table   core.FQN
	Name    string
	Fields  []GoField
	Comment string
}

type Parameter

type Parameter struct {
	Number int
	Column core.Column
}

type ParserErr

type ParserErr struct {
	Errs []FileErr
}

func NewParserErr

func NewParserErr() *ParserErr

func (*ParserErr) Add

func (e *ParserErr) Add(filename, source string, loc int, err error)

func (*ParserErr) Error

func (e *ParserErr) Error() string

type ParserOpts

type ParserOpts struct {
	UsePositionalParameters bool
}

type Query

type Query struct {
	SQL      string
	Columns  []core.Column
	Params   []Parameter
	Name     string
	Cmd      string // TODO: Pick a better name. One of: one, many, exec, execrows
	Comments []string

	// XXX: Hack
	Filename string
}

Name and Cmd may be empty Maybe I don't need the SQL string if I have the raw Stmt?

type QueryCatalog

type QueryCatalog struct {
	// contains filtered or unexported fields
}

func (QueryCatalog) GetTable

func (qc QueryCatalog) GetTable(fqn core.FQN) (core.Table, *core.Error)

type Result

type Result struct {
	Queries []*Query
	Catalog core.Catalog
}

func ParseQueries

func ParseQueries(c core.Catalog, queriesPaths []string, opts ParserOpts) (*Result, error)

func (Result) Enums

func (r Result) Enums(settings config.CombinedSettings) []GoEnum

func (Result) GoQueries

func (r Result) GoQueries(settings config.CombinedSettings) []GoQuery

func (Result) Structs

func (r Result) Structs(settings config.CombinedSettings) []GoStruct