zig

Documentation

Index

• func Generate(_ context.Context, req *plugin.GenerateRequest) (*plugin.GenerateResponse, error)
• type Backend
  • func (b Backend) ImportName() string
  • func (b Backend) IsValidFor(req *plugin.GenerateRequest) bool
• type Config
  • func (c *Config) Default(req *plugin.GenerateRequest)
  • func (c *Config) Validate(req *plugin.GenerateRequest) error
• type Enum
• type Field
  • func (f Field) ZigID() string
• type Identifier
• type Query
  • func (q *Query) ArgNames() []string
  • func (q *Query) RequiresAllocations() bool
• type QueryValue
• type Struct

Functions

func Generate

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

Types

type Backend

type Backend string

const (
	PGZigBackend  Backend = "pg.zig"
	ZqliteBackend Backend = "zqlite.zig"
)

func (Backend) ImportName

func (b Backend) ImportName() string

func (Backend) IsValidFor

func (b Backend) IsValidFor(req *plugin.GenerateRequest) bool

type Config

type Config struct {
	Backend                     Backend  `json:"backend"`
	EmitExactTableNames         bool     `json:"emit_exact_table_names"`
	InflectionExcludeTableNames []string `json:"inflection_exclude_table_names"`
	QueryParameterLimit         int      `json:"query_parameter_limit"`
	PublicQueryStings           bool     `json:"public_query_strings"`
	UnmanagedAllocations        bool     `json:"unmanaged_allocations"`
	UseContext                  bool     `json:"use_context"`
	PGErrorUnions               bool     `json:"pg_error_unions"`
}

func (*Config) Default

func (c *Config) Default(req *plugin.GenerateRequest)

func (*Config) Validate

func (c *Config) Validate(req *plugin.GenerateRequest) error

type Enum

type Enum struct {
	Name    string
	ZigName string
	Comment string
	Values  []string
}

type Field

type Field struct {
	Name     string
	Comment  string
	ZigType  string
	Nullable bool
	Array    bool
	Index    int
	Enum     bool
}

func (Field) ZigID

func (f Field) ZigID() string

type Identifier

type Identifier struct {
	Schema string
	Name   string
}

type Query

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

func (*Query) ArgNames

func (q *Query) ArgNames() []string

func (*Query) RequiresAllocations

func (q *Query) RequiresAllocations() bool

type QueryValue

type QueryValue struct {
	Emit   bool
	Name   string
	Struct *Struct
	Field  *Field
}

type Struct

type Struct struct {
	ID         Identifier
	TableName  string
	StructName string
	Comment    string
	Fields     []Field
}