python

Documentation

Index

• func Generate(_ context.Context, req *plugin.GenerateRequest) (*plugin.GenerateResponse, error)
• func HashComment(s string) string
• type Config
• type Constant
• type Enum
• type Field
• type Query
  • func (q Query) AddArgs(args *pyast.Arguments)
  • func (q Query) ArgDictNode() *pyast.Node
• type QueryValue
  • func (v QueryValue) Annotation() *pyast.Node
  • func (v QueryValue) EmitStruct() bool
  • func (v QueryValue) IsStruct() bool
  • func (v QueryValue) RowNode(rowVar string) *pyast.Node
• type Struct

Functions

func Generate

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

func HashComment

func HashComment(s string) string

Types

type Config

type Config struct {
	EmitExactTableNames         bool     `json:"emit_exact_table_names"`
	EmitSyncQuerier             bool     `json:"emit_sync_querier"`
	EmitAsyncQuerier            bool     `json:"emit_async_querier"`
	Package                     string   `json:"package"`
	Out                         string   `json:"out"`
	EmitPydanticModels          bool     `json:"emit_pydantic_models"`
	EmitStrEnum                 bool     `json:"emit_str_enum"`
	QueryParameterLimit         *int32   `json:"query_parameter_limit"`
	InflectionExcludeTableNames []string `json:"inflection_exclude_table_names"`
}

type Constant

type Constant struct {
	Name  string
	Type  string
	Value string
}

type Enum

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

type Field

type Field struct {
	Name    string
	Type    pyType
	Comment string
}

type Query

type Query struct {
	Cmd          string
	Comments     []string
	MethodName   string
	FieldName    string
	ConstantName string
	SQL          string
	SourceName   string
	Ret          QueryValue
	Args         []QueryValue
}

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

func (Query) AddArgs

func (q Query) AddArgs(args *pyast.Arguments)

func (Query) ArgDictNode

func (q Query) ArgDictNode() *pyast.Node

type QueryValue

type QueryValue struct {
	Emit   bool
	Name   string
	Struct *Struct
	Typ    pyType
}

func (QueryValue) Annotation

func (v QueryValue) Annotation() *pyast.Node

func (QueryValue) EmitStruct

func (v QueryValue) EmitStruct() bool

func (QueryValue) IsStruct

func (v QueryValue) IsStruct() bool

func (QueryValue) RowNode

func (v QueryValue) RowNode(rowVar string) *pyast.Node

type Struct

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