generator

package
v0.89.0 Latest Latest
Warning

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

 Go to latest Published: Apr 18, 2024 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DtoDeclTemplate, _ = template.New("dtoTemplate").Parse(`
type {{ .DtoDecl }} struct {
	{{- range .Fields }}
		{{- if .ShouldBeInDto }}
		{{ .Name }} {{ .DtoKind }} {{ if .Required }}// required{{ end }}
		{{- end }}
	{{- end }}
}
`)
View Source 
var DtoTemplate, _ = template.New("dtoTemplate").Parse(`
//go:generate go run ./dto-builder-generator/main.go

var (
	{{- range .Operations }}
	{{- if .OptsField }}
	_ optionsProvider[{{ .OptsField.KindNoPtr }}] = new({{ .OptsField.DtoDecl }})
	{{- end }}
	{{- end }}
)
`)
View Source 
var ImplementationTemplate, _ = template.New("implementationTemplate").
	Funcs(template.FuncMap{
		"deref": func(p *DescriptionMappingKind) string { return string(*p) },
	}).
	Parse(`
{{ define "MAPPING" -}}
	&{{ .KindNoPtr }}{
		{{- range .Fields }}
			{{- if .ShouldBeInDto }}
			{{ if .IsStruct }}{{ else }}{{ .Name }}: r{{ .Path }},{{ end -}}
			{{- end -}}
		{{- end }}
	}
	{{- range .Fields }}
		{{- if .ShouldBeInDto }}
			{{- if .IsStruct }}
				if r{{ .Path }} != nil {
					{{- if not .IsSlice }}
						opts{{ .Path }} = {{ template "MAPPING" . -}}
					{{- else }}
						s := make({{ .Kind }}, len(r{{ .Path }}))
						for i, v := range r{{ .Path }} {
							s[i] = {{ .KindNoSlice }}{
							  {{- range .Fields }}
								   {{ .Name }}: v.{{ .Name }},
							  {{- end }}
							}
						}
						opts{{ .Path }} = s
					{{ end -}}
				}
			{{- end -}}
		{{ end -}}
	{{ end }}
{{ end }}
{{ define "MAPPING_FUNC" }}
	func (r {{ .From.Name }}) {{ .MappingFuncName }}() *{{ .To.KindNoPtr }} {
		// TODO: Mapping
		return &{{ .To.KindNoPtr }}{}
	}
{{ end }}
import (
"context"

"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk/internal/collections"
)

{{ $impl := .NameLowerCased }}
var _ {{ .Name }} = (*{{ $impl }})(nil)

type {{ $impl }} struct {
	client *Client
}
{{ range .Operations }}
	{{ if and (eq .Name "Show") .ShowMapping }}
		func (v *{{ $impl }}) Show(ctx context.Context, request *{{ .OptsField.DtoDecl }}) ([]{{ .ShowMapping.To.Name }}, error) {
			opts := request.toOpts()
			dbRows, err := validateAndQuery[{{ .ShowMapping.From.Name }}](v.client, ctx, opts)
			if err != nil {
				return nil, err
			}
			resultList := convertRows[{{ .ShowMapping.From.Name }}, {{ .ShowMapping.To.Name }}](dbRows)
			return resultList, nil
		}
	{{ else if eq .Name "ShowByID" }}
		func (v *{{ $impl }}) ShowByID(ctx context.Context, id {{ .ObjectInterface.IdentifierKind }}) (*{{ .ObjectInterface.NameSingular }}, error) {
			// TODO: adjust request if e.g. LIKE is supported for the resource
			{{ $impl }}, err := v.Show(ctx, NewShow{{ .ObjectInterface.NameSingular }}Request())
			if err != nil {
				return nil, err
			}
			return collections.FindOne({{ $impl }}, func(r {{ .ObjectInterface.NameSingular }}) bool { return r.Name == id.Name() })
		}
	{{ else if and (eq .Name "Describe") .DescribeMapping }}
		{{ if .DescribeKind }}
			{{ if eq (deref .DescribeKind) "single_value" }}
				func (v *{{ $impl }}) Describe(ctx context.Context, id {{ .ObjectInterface.IdentifierKind }}) (*{{ .DescribeMapping.To.Name }}, error) {
					opts := &{{ .OptsField.Name }}{
						 name: id,
					}
					result, err := validateAndQueryOne[{{ .DescribeMapping.From.Name }}](v.client, ctx, opts)
					if err != nil {
						 return nil, err
					}
					return result.convert(), nil
				}
			{{ else if eq (deref .DescribeKind) "slice" }}
				func (v *{{ $impl }}) Describe(ctx context.Context, id {{ .ObjectInterface.IdentifierKind }}) ([]{{ .DescribeMapping.To.Name }}, error) {
					opts := &{{ .OptsField.Name }}{
						 name: id,
					}
					rows, err := validateAndQuery[{{ .DescribeMapping.From.Name}}](v.client, ctx, opts)
					if err != nil {
						 return nil, err
					}
					return convertRows[{{ .DescribeMapping.From.Name }}, {{ .DescribeMapping.To.Name }}](rows), nil
				}
			{{ end }}
		{{ end }}
	{{ else }}
		func (v *{{ $impl }}) {{ .Name }}(ctx context.Context, request *{{ .OptsField.DtoDecl }}) error {
			opts := request.toOpts()
			return validateAndExec(v.client, ctx, opts)
		}
	{{ end }}
{{ end }}

{{ range .Operations }}
	{{- if .OptsField }}
	func (r *{{ .OptsField.DtoDecl }}) toOpts() *{{ .OptsField.KindNoPtr }} {
		opts := {{ template "MAPPING" .OptsField -}}
		return opts
	}
	{{ if .ShowMapping }}
		{{ template "MAPPING_FUNC" .ShowMapping }}
	{{ end }}
	{{ if .DescribeMapping }}
		{{ template "MAPPING_FUNC" .DescribeMapping }}
	{{ end }}
	{{- end}}
{{ end }}
`)
View Source 
var IntegrationTestsTemplate, _ = template.New("integrationTestsTemplate").Parse(`
import "testing"

func TestInt_{{ .Name }}(t *testing.T) {
	// TODO: prepare common resources

	{{ range .Operations }}
	t.Run("{{ .Name }}", func(t *testing.T) {
		// TODO: fill me
	})
	{{ end -}}
}
`)
View Source 
var InterfaceTemplate, _ = template.New("interfaceTemplate").
	Funcs(template.FuncMap{
		"deref": func(p *DescriptionMappingKind) string { return string(*p) },
	}).
	Parse(`
import "context"

type {{ .Name }} interface {
	{{- range .Operations }}
		{{- if and (eq .Name "Show") .ShowMapping }}
			{{ .Name }}(ctx context.Context, request *{{ .OptsField.DtoDecl }}) ([]{{ .ShowMapping.To.Name }}, error)
		{{- else if eq .Name "ShowByID" }}
			{{ .Name }}(ctx context.Context, id {{ .ObjectInterface.IdentifierKind }}) (*{{ .ObjectInterface.NameSingular }}, error)
		{{- else if and (eq .Name "Describe") .DescribeMapping }}
			{{- if .DescribeKind }}
				{{- if eq (deref .DescribeKind) "single_value" }}
					{{ .Name }}(ctx context.Context, id {{ .ObjectInterface.IdentifierKind }}) (*{{ .DescribeMapping.To.Name }}, error)
				{{- else if eq (deref .DescribeKind) "slice" }}
					{{ .Name }}(ctx context.Context, id {{ .ObjectInterface.IdentifierKind }}) ([]{{ .DescribeMapping.To.Name }}, error)
				{{- end }}
			{{- end }}
		{{- else }}
			{{ .Name }}(ctx context.Context, request *{{ .OptsField.DtoDecl }}) error
		{{- end -}}
	{{ end }}
}
`)
View Source 
var OptionsTemplate, _ = template.New("optionsTemplate").Parse(`
// {{ .OptsField.KindNoPtr }} is based on {{ .Doc }}.
type {{ .OptsField.KindNoPtr }} struct {
	{{- range .OptsField.Fields }}
			{{ .Name }} {{ .Kind }} {{ .TagsPrintable }}
	{{- end }}
}
`)
View Source 
var PackageTemplate, _ = template.New("packageTemplate").Parse(`
package {{ . }}
`)
View Source 
var StructTemplate, _ = template.New("structTemplate").Parse(`
type {{ .KindNoPtr }} struct {
	{{- range .Fields }}
			{{ .Name }} {{ .Kind }} {{ .TagsPrintable }}
	{{- end }}
}
`)

TODO: merge with template above? (requires moving Doc to field)

View Source 
var TestFuncTemplate, _ = template.New("testFuncTemplate").Parse(`
{{ define "VALIDATION_TEST" }}
	{{ $field := . }}
	{{- range .Validations }}
		t.Run("{{ .TodoComment $field }}", func(t *testing.T) {
			opts := defaultOpts()
			// TODO: fill me
			assertOptsInvalidJoinedErrors(t, opts, {{ .ReturnedError $field }})
		})
	{{ end -}}
{{ end }}

{{ define "VALIDATIONS" }}
	{{- template "VALIDATION_TEST" . -}}
	{{ range .Fields }}
		{{- if .HasAnyValidationInSubtree }}
			{{- template "VALIDATIONS" . -}}
		{{ end -}}
	{{- end -}}
{{ end }}

import "testing"

{{ range .Operations }}
	{{- if .OptsField }}
	func Test{{ .ObjectInterface.Name }}_{{ .Name }}(t *testing.T) {
		id := Random{{ .ObjectInterface.IdentifierKind }}()

		// Minimal valid {{ .OptsField.KindNoPtr }}
		defaultOpts := func() *{{ .OptsField.KindNoPtr }} {
			return &{{ .OptsField.KindNoPtr }}{
				name: id,
			}
		}

		t.Run("validation: nil options", func(t *testing.T) {
			var opts *{{ .OptsField.KindNoPtr }} = nil
			assertOptsInvalidJoinedErrors(t, opts, ErrNilOptions)
		})

		{{- template "VALIDATIONS" .OptsField }}

		t.Run("basic", func(t *testing.T) {
			opts := defaultOpts()
			// TODO: fill me
			assertOptsValidAndSQLEquals(t, opts, "TODO: fill me")
		})

		t.Run("all options", func(t *testing.T) {
			opts := defaultOpts()
			// TODO: fill me
			assertOptsValidAndSQLEquals(t, opts, "TODO: fill me")
		})
	}
	{{- end }}
{{ end }}
`)
View Source 
var ValidationsImplTemplate, _ = template.New("validationsImplTemplate").Parse(`
{{ define "VALIDATIONS" }}
	{{- $field := . -}}
	{{- range .Validations }}
		if {{ .Condition $field }} {
			errs = append(errs, {{ .ReturnedError $field }})
		}
	{{- end -}}
	{{- range .Fields }}
		{{- if .HasAnyValidationInSubtree }}
			if valueSet(opts{{ .Path }}) {
				{{- template "VALIDATIONS" . }}
			}
		{{- end -}}
	{{- end -}}
{{ end }}

var (
{{- range .Operations }}
	{{- if .OptsField }}
	_ validatable = new({{ .OptsField.KindNoPtr }})
	{{- end }}
{{- end }}
)
{{ range .Operations }}
	{{- if .OptsField }}
	func (opts *{{ .OptsField.KindNoPtr }}) validate() error {
		if opts == nil {
			return ErrNilOptions
		}
		var errs []error
		{{- template "VALIDATIONS" .OptsField }}
		return JoinErrors(errs...)
	}
	{{- end }}
{{ end }}
`)

Functions

func DbStruct added in v0.72.0 

func DbStruct(name string) *dbStruct

func GenerateDtos 

func GenerateDtos(writer io.Writer, def *Interface)

func GenerateImplementation 

func GenerateImplementation(writer io.Writer, def *Interface)

func GenerateIntegrationTests 

func GenerateIntegrationTests(writer io.Writer, def *Interface)

func GenerateInterface 

func GenerateInterface(writer io.Writer, def *Interface)

func GenerateUnitTests 

func GenerateUnitTests(writer io.Writer, def *Interface)

func GenerateValidations 

func GenerateValidations(writer io.Writer, def *Interface)

func IsNil added in v0.72.0 

func IsNil(val any) bool

IsNil is used for special cases where x != nil might not work (e.g. passing nil instead of interface implementation)

func KindOfPointer added in v0.72.0 

func KindOfPointer(kind string) string

func KindOfSlice added in v0.72.0 

func KindOfSlice(kind string) string

func KindOfT added in v0.72.0 

func KindOfT[T any]() string

func KindOfTPointer added in v0.72.0 

func KindOfTPointer[T any]() string

func KindOfTSlice added in v0.72.0 

func KindOfTSlice[T any]() string

func PlainStruct added in v0.72.0 

func PlainStruct(name string) *plainStruct

func WriteCodeToFile 

func WriteCodeToFile(buffer *bytes.Buffer, fileName string)

Types

type DescriptionMappingKind added in v0.72.0 

type DescriptionMappingKind string
const (
	DescriptionMappingKindSingleValue DescriptionMappingKind = "single_value"
	DescriptionMappingKindSlice       DescriptionMappingKind = "slice"
)

type Field 

type Field struct {
	// Parent allows to traverse fields hierarchy more easily, nil for root
	Parent *Field
	// Fields defines children, use for struct fields
	Fields []*Field
	// Validations defines validations on given field level (e.g. oneOf for children)
	Validations []*Validation
	// Name is how field is called in parent struct
	Name string
	// Kind is fields type (e.g. string, *bool)
	Kind string
	// Tags should contain ddl and sql tags used for SQL generation
	Tags map[string][]string
	// Required is used to mark fields which are essential (it's used e.g. for DTO builders generation)
	Required bool
}

Field defines properties of a single field or struct (by defining Fields)

func NewField 

func NewField(name string, kind string, tagBuilder *TagBuilder, transformer FieldTransformer) *Field

func (*Field) DtoDecl 

func (f *Field) DtoDecl() string

DtoDecl returns how struct should be declared in generated DTO (e.g. definition is without a pointer)

func (*Field) DtoKind 

func (f *Field) DtoKind() string

DtoKind returns what should be fields kind in generated DTO, because it may differ from Kind

func (*Field) HasAnyValidationInSubtree 

func (f *Field) HasAnyValidationInSubtree() bool

HasAnyValidationInSubtree checks if any validations are present from current field level downwards

func (*Field) IsPointer added in v0.72.0 

func (f *Field) IsPointer() bool

func (*Field) IsRoot 

func (f *Field) IsRoot() bool

IsRoot checks if field is at the top of field hierarchy, basically it is true for Option structs

func (*Field) IsSlice added in v0.72.0 

func (f *Field) IsSlice() bool

func (*Field) IsStruct 

func (f *Field) IsStruct() bool

IsStruct checks if field is a struct

func (*Field) KindNoPtr 

func (f *Field) KindNoPtr() string

KindNoPtr return field's Kind but without pointer and array

func (*Field) KindNoSlice added in v0.72.0 

func (f *Field) KindNoSlice() string

KindNoSlice return field's Kind but without array

func (*Field) Path 

func (f *Field) Path() string

Path returns the way through the tree to the top, with dot separator (e.g. .SomeField.SomeChild)

func (*Field) PathWithRoot added in v0.75.0 

func (f *Field) PathWithRoot() string

PathWithRoot returns the way through the tree to the top, with dot separator and root included (e.g. Struct.SomeField.SomeChild)

func (*Field) ShouldBeInDto 

func (f *Field) ShouldBeInDto() bool

ShouldBeInDto checks if field is not some static SQL field which should not be interacted with by SDK user TODO: this is a very naive implementation, consider fixing it with DSL builder connection

func (*Field) TagsPrintable 

func (f *Field) TagsPrintable() string

TagsPrintable defines how tags are printed in options structs, it ensures the same order of tags for every field

type FieldTransformer added in v0.72.0 

type FieldTransformer interface {
	Transform(f *Field) *Field
}

type IdentifierTransformer added in v0.72.0 

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

func IdentifierOptions added in v0.72.0 

func IdentifierOptions() *IdentifierTransformer

func (*IdentifierTransformer) DoubleQuotes added in v0.72.0 

func (v *IdentifierTransformer) DoubleQuotes() *IdentifierTransformer

func (*IdentifierTransformer) Equals added in v0.73.0 

func (v *IdentifierTransformer) Equals() *IdentifierTransformer

func (*IdentifierTransformer) NoEquals added in v0.73.0 

func (v *IdentifierTransformer) NoEquals() *IdentifierTransformer

func (*IdentifierTransformer) Required added in v0.72.0 

func (v *IdentifierTransformer) Required() *IdentifierTransformer

func (*IdentifierTransformer) SQL added in v0.72.0 

func (v *IdentifierTransformer) SQL(sqlPrefix string) *IdentifierTransformer

func (*IdentifierTransformer) SingleQuotes added in v0.72.0 

func (v *IdentifierTransformer) SingleQuotes() *IdentifierTransformer

func (*IdentifierTransformer) Transform added in v0.72.0 

func (v *IdentifierTransformer) Transform(f *Field) *Field

type Interface 

type Interface struct {
	// Name is the interface's name, e.g. "DatabaseRoles"
	Name string
	// NameSingular is the prefix/suffix which can be used to create other structs and methods, e.g. "DatabaseRole"
	NameSingular string
	// Operations contains all operations for given interface
	Operations []*Operation
	// IdentifierKind keeps identifier of the underlying object (e.g. DatabaseObjectIdentifier)
	IdentifierKind string
}

Interface groups operations for particular object or objects family (e.g. DATABASE ROLE)

func NewInterface 

func NewInterface(name string, nameSingular string, identifierKind string, operations ...*Operation) *Interface

func (*Interface) AlterOperation added in v0.72.0 

func (i *Interface) AlterOperation(doc string, queryStruct *QueryStruct) *Interface

func (*Interface) CreateOperation added in v0.72.0 

func (i *Interface) CreateOperation(doc string, queryStruct *QueryStruct, helperStructs ...IntoField) *Interface

func (*Interface) CustomOperation added in v0.73.0 

func (i *Interface) CustomOperation(kind string, doc string, queryStruct *QueryStruct) *Interface

func (*Interface) DescribeOperation added in v0.72.0 

func (i *Interface) DescribeOperation(describeKind DescriptionMappingKind, doc string, dbRepresentation *dbStruct, resourceRepresentation *plainStruct, queryStruct *QueryStruct) *Interface

func (*Interface) DropOperation added in v0.72.0 

func (i *Interface) DropOperation(doc string, queryStruct *QueryStruct) *Interface

func (*Interface) GrantOperation added in v0.76.0 

func (i *Interface) GrantOperation(doc string, queryStruct *QueryStruct) *Interface

func (*Interface) NameLowerCased 

func (i *Interface) NameLowerCased() string

NameLowerCased returns interface name starting with a lower case letter

func (*Interface) RevokeOperation added in v0.76.0 

func (i *Interface) RevokeOperation(doc string, queryStruct *QueryStruct) *Interface

func (*Interface) ShowByIdOperation added in v0.73.0 

func (i *Interface) ShowByIdOperation() *Interface

func (*Interface) ShowOperation added in v0.72.0 

func (i *Interface) ShowOperation(doc string, dbRepresentation *dbStruct, resourceRepresentation *plainStruct, queryStruct *QueryStruct) *Interface

type IntoField added in v0.72.0 

type IntoField interface {
	IntoField() *Field
}

type KeywordTransformer added in v0.72.0 

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

func KeywordOptions added in v0.72.0 

func KeywordOptions() *KeywordTransformer

func (*KeywordTransformer) DoubleQuotes added in v0.72.0 

func (v *KeywordTransformer) DoubleQuotes() *KeywordTransformer

func (*KeywordTransformer) MustParentheses added in v0.82.0 

func (v *KeywordTransformer) MustParentheses() *KeywordTransformer

func (*KeywordTransformer) NoQuotes added in v0.73.0 

func (v *KeywordTransformer) NoQuotes() *KeywordTransformer

func (*KeywordTransformer) Parentheses added in v0.76.0 

func (v *KeywordTransformer) Parentheses() *KeywordTransformer

func (*KeywordTransformer) Required added in v0.72.0 

func (v *KeywordTransformer) Required() *KeywordTransformer

func (*KeywordTransformer) SQL added in v0.72.0 

func (v *KeywordTransformer) SQL(sqlPrefix string) *KeywordTransformer

func (*KeywordTransformer) SingleQuotes added in v0.72.0 

func (v *KeywordTransformer) SingleQuotes() *KeywordTransformer

func (*KeywordTransformer) Transform added in v0.72.0 

func (v *KeywordTransformer) Transform(f *Field) *Field

type ListTransformer added in v0.72.0 

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

func ListOptions added in v0.72.0 

func ListOptions() *ListTransformer

func (*ListTransformer) MustParentheses added in v0.79.0 

func (v *ListTransformer) MustParentheses() *ListTransformer

func (*ListTransformer) NoComma added in v0.76.0 

func (v *ListTransformer) NoComma() *ListTransformer

func (*ListTransformer) NoEquals added in v0.73.0 

func (v *ListTransformer) NoEquals() *ListTransformer

func (*ListTransformer) NoParentheses added in v0.74.0 

func (v *ListTransformer) NoParentheses() *ListTransformer

func (*ListTransformer) Parentheses added in v0.74.0 

func (v *ListTransformer) Parentheses() *ListTransformer

func (*ListTransformer) Required added in v0.72.0 

func (v *ListTransformer) Required() *ListTransformer

func (*ListTransformer) SQL added in v0.72.0 

func (v *ListTransformer) SQL(sqlPrefix string) *ListTransformer

func (*ListTransformer) Transform added in v0.72.0 

func (v *ListTransformer) Transform(f *Field) *Field

type Mapping added in v0.72.0 

type Mapping struct {
	MappingFuncName string
	From            *Field
	To              *Field
}

type Operation 

type Operation struct {
	// Name is the operation's name, e.g. "Create"
	Name string
	// ObjectInterface points to the containing interface
	ObjectInterface *Interface
	// Doc is the URL for the doc used to create given operation, e.g. https://docs.snowflake.com/en/sql-reference/sql/create-database-role
	Doc string
	// OptsField defines opts used to create SQL for given operation
	OptsField *Field
	// HelperStructs are struct definitions that are not tied to OptsField, but tied to the Operation itself, e.g. Show() return type
	HelperStructs []*Field
	// ShowMapping is a definition of mapping needed by Operation kind of OperationKindShow
	ShowMapping *Mapping
	// DescribeKind defines a kind of mapping that needs to be performed in particular case of Describe implementation
	DescribeKind *DescriptionMappingKind
	// DescribeMapping is a definition of mapping needed by Operation kind of OperationKindDescribe
	DescribeMapping *Mapping
}

Operation defines a single operation for given object or objects family (e.g. CREATE DATABASE ROLE)

type OperationKind added in v0.72.0 

type OperationKind string
const (
	OperationKindCreate   OperationKind = "Create"
	OperationKindAlter    OperationKind = "Alter"
	OperationKindDrop     OperationKind = "Drop"
	OperationKindShow     OperationKind = "Show"
	OperationKindShowByID OperationKind = "ShowByID"
	OperationKindDescribe OperationKind = "Describe"
	OperationKindGrant    OperationKind = "Grant"
	OperationKindRevoke   OperationKind = "Revoke"
)

type ParameterTransformer added in v0.72.0 

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

func ParameterOptions added in v0.72.0 

func ParameterOptions() *ParameterTransformer

func (*ParameterTransformer) ArrowEquals added in v0.74.0 

func (v *ParameterTransformer) ArrowEquals() *ParameterTransformer

func (*ParameterTransformer) DoubleQuotes added in v0.72.0 

func (v *ParameterTransformer) DoubleQuotes() *ParameterTransformer

func (*ParameterTransformer) MustParentheses added in v0.84.0 

func (v *ParameterTransformer) MustParentheses() *ParameterTransformer

func (*ParameterTransformer) NoEquals added in v0.73.0 

func (v *ParameterTransformer) NoEquals() *ParameterTransformer

func (*ParameterTransformer) NoParentheses added in v0.73.0 

func (v *ParameterTransformer) NoParentheses() *ParameterTransformer

func (*ParameterTransformer) NoQuotes added in v0.72.0 

func (v *ParameterTransformer) NoQuotes() *ParameterTransformer

func (*ParameterTransformer) Parentheses added in v0.72.0 

func (v *ParameterTransformer) Parentheses() *ParameterTransformer

func (*ParameterTransformer) Required added in v0.72.0 

func (v *ParameterTransformer) Required() *ParameterTransformer

func (*ParameterTransformer) SQL added in v0.72.0 

func (v *ParameterTransformer) SQL(sqlPrefix string) *ParameterTransformer

func (*ParameterTransformer) SingleQuotes added in v0.72.0 

func (v *ParameterTransformer) SingleQuotes() *ParameterTransformer

func (*ParameterTransformer) Transform added in v0.72.0 

func (v *ParameterTransformer) Transform(f *Field) *Field

type QueryStruct added in v0.72.0 

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

TODO For Field abstractions use internal Field representation instead of copying only needed fields, e.g. 

type QueryStruct struct {
	internalRepresentation *Field
	...additional fields that are not present in the Field
}

func NewQueryStruct added in v0.76.0 

func NewQueryStruct(name string) *QueryStruct

func (*QueryStruct) Alter added in v0.76.0 

func (v *QueryStruct) Alter() *QueryStruct

func (*QueryStruct) Assignment added in v0.76.0 

func (v *QueryStruct) Assignment(sqlPrefix string, kind string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) BodyWithPrecedingArrow added in v0.84.0 

func (v *QueryStruct) BodyWithPrecedingArrow() *QueryStruct

func (*QueryStruct) BooleanAssignment added in v0.76.0 

func (v *QueryStruct) BooleanAssignment(sqlPrefix string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) Create added in v0.76.0 

func (v *QueryStruct) Create() *QueryStruct

func (*QueryStruct) Describe added in v0.76.0 

func (v *QueryStruct) Describe() *QueryStruct

func (*QueryStruct) Drop added in v0.76.0 

func (v *QueryStruct) Drop() *QueryStruct

func (*QueryStruct) Grant added in v0.76.0 

func (v *QueryStruct) Grant() *QueryStruct

func (*QueryStruct) Identifier added in v0.76.0 

func (v *QueryStruct) Identifier(fieldName string, kind string, transformer *IdentifierTransformer) *QueryStruct

func (*QueryStruct) IfExists added in v0.76.0 

func (v *QueryStruct) IfExists() *QueryStruct

func (*QueryStruct) IfNotExists added in v0.76.0 

func (v *QueryStruct) IfNotExists() *QueryStruct

func (*QueryStruct) IntoField added in v0.76.0 

func (v *QueryStruct) IntoField() *Field

func (*QueryStruct) List added in v0.76.0 

func (v *QueryStruct) List(name string, itemKind string, transformer *ListTransformer) *QueryStruct

func (*QueryStruct) ListAssignment added in v0.76.0 

func (v *QueryStruct) ListAssignment(sqlPrefix string, listItemKind string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) ListQueryStructField added in v0.76.0 

func (v *QueryStruct) ListQueryStructField(name string, queryStruct *QueryStruct, transformer FieldTransformer) *QueryStruct

func (*QueryStruct) Name added in v0.76.0 

func (v *QueryStruct) Name() *QueryStruct

Name adds identifier with field name "name" and type will be inferred from interface definition

func (*QueryStruct) NamedList added in v0.76.0 

func (v *QueryStruct) NamedList(sql string, itemKind string) *QueryStruct

func (*QueryStruct) NamedListWithParens added in v0.76.0 

func (v *QueryStruct) NamedListWithParens(sqlPrefix string, listItemKind string, transformer *KeywordTransformer) *QueryStruct

func (*QueryStruct) Number added in v0.76.0 

func (v *QueryStruct) Number(name string, transformer *KeywordTransformer) *QueryStruct

func (*QueryStruct) NumberAssignment added in v0.76.0 

func (v *QueryStruct) NumberAssignment(sqlPrefix string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) OptionalAssignment added in v0.76.0 

func (v *QueryStruct) OptionalAssignment(sqlPrefix string, kind string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) OptionalBooleanAssignment added in v0.76.0 

func (v *QueryStruct) OptionalBooleanAssignment(sqlPrefix string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) OptionalComment added in v0.76.0 

func (v *QueryStruct) OptionalComment() *QueryStruct

func (*QueryStruct) OptionalCopyGrants added in v0.76.0 

func (v *QueryStruct) OptionalCopyGrants() *QueryStruct

func (*QueryStruct) OptionalIdentifier added in v0.76.0 

func (v *QueryStruct) OptionalIdentifier(name string, kind string, transformer *IdentifierTransformer) *QueryStruct

func (*QueryStruct) OptionalIdentifierAssignment added in v0.76.0 

func (v *QueryStruct) OptionalIdentifierAssignment(sqlPrefix string, identifierKind string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) OptionalIn added in v0.76.0 

func (v *QueryStruct) OptionalIn() *QueryStruct

func (*QueryStruct) OptionalLike added in v0.76.0 

func (v *QueryStruct) OptionalLike() *QueryStruct

func (*QueryStruct) OptionalLimit added in v0.76.0 

func (v *QueryStruct) OptionalLimit() *QueryStruct

func (*QueryStruct) OptionalLimitFrom added in v0.76.0 

func (v *QueryStruct) OptionalLimitFrom() *QueryStruct

func (*QueryStruct) OptionalNumber added in v0.76.0 

func (v *QueryStruct) OptionalNumber(name string, transformer *KeywordTransformer) *QueryStruct

func (*QueryStruct) OptionalNumberAssignment added in v0.76.0 

func (v *QueryStruct) OptionalNumberAssignment(sqlPrefix string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) OptionalQueryStructField added in v0.76.0 

func (v *QueryStruct) OptionalQueryStructField(name string, queryStruct *QueryStruct, transformer FieldTransformer) *QueryStruct

func (*QueryStruct) OptionalSQL added in v0.76.0 

func (v *QueryStruct) OptionalSQL(sql string) *QueryStruct

func (*QueryStruct) OptionalSessionParameters added in v0.76.0 

func (v *QueryStruct) OptionalSessionParameters() *QueryStruct

func (*QueryStruct) OptionalSessionParametersUnset added in v0.76.0 

func (v *QueryStruct) OptionalSessionParametersUnset() *QueryStruct

func (*QueryStruct) OptionalSetBodyWithPrecedingArrow added in v0.84.0 

func (v *QueryStruct) OptionalSetBodyWithPrecedingArrow() *QueryStruct

func (*QueryStruct) OptionalSetTags added in v0.76.0 

func (v *QueryStruct) OptionalSetTags() *QueryStruct

func (*QueryStruct) OptionalStartsWith added in v0.76.0 

func (v *QueryStruct) OptionalStartsWith() *QueryStruct

func (*QueryStruct) OptionalTags added in v0.76.0 

func (v *QueryStruct) OptionalTags() *QueryStruct

func (*QueryStruct) OptionalText added in v0.76.0 

func (v *QueryStruct) OptionalText(name string, transformer *KeywordTransformer) *QueryStruct

func (*QueryStruct) OptionalTextAssignment added in v0.76.0 

func (v *QueryStruct) OptionalTextAssignment(sqlPrefix string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) OptionalUnsetTags added in v0.76.0 

func (v *QueryStruct) OptionalUnsetTags() *QueryStruct

func (*QueryStruct) OrReplace added in v0.76.0 

func (v *QueryStruct) OrReplace() *QueryStruct

func (*QueryStruct) PredefinedQueryStructField added in v0.76.0 

func (v *QueryStruct) PredefinedQueryStructField(name string, kind string, transformer FieldTransformer) *QueryStruct

func (*QueryStruct) QueryStructField added in v0.76.0 

func (v *QueryStruct) QueryStructField(name string, queryStruct *QueryStruct, transformer FieldTransformer) *QueryStruct

func (*QueryStruct) Revoke added in v0.76.0 

func (v *QueryStruct) Revoke() *QueryStruct

func (*QueryStruct) SQL added in v0.76.0 

func (v *QueryStruct) SQL(sql string) *QueryStruct

func (*QueryStruct) SetComment added in v0.76.0 

func (v *QueryStruct) SetComment() *QueryStruct

func (*QueryStruct) SetTags added in v0.76.0 

func (v *QueryStruct) SetTags() *QueryStruct

func (*QueryStruct) Show added in v0.76.0 

func (v *QueryStruct) Show() *QueryStruct

func (*QueryStruct) Terse added in v0.76.0 

func (v *QueryStruct) Terse() *QueryStruct

func (*QueryStruct) Text added in v0.76.0 

func (v *QueryStruct) Text(name string, transformer *KeywordTransformer) *QueryStruct

func (*QueryStruct) TextAssignment added in v0.76.0 

func (v *QueryStruct) TextAssignment(sqlPrefix string, transformer *ParameterTransformer) *QueryStruct

func (*QueryStruct) UnsetTags added in v0.76.0 

func (v *QueryStruct) UnsetTags() *QueryStruct

func (*QueryStruct) WithValidation added in v0.76.0 

func (v *QueryStruct) WithValidation(validationType ValidationType, fieldNames ...string) *QueryStruct

type StaticTransformer added in v0.84.0 

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

func StaticOptions added in v0.84.0 

func StaticOptions() *StaticTransformer

func (*StaticTransformer) SQL added in v0.84.0 

func (v *StaticTransformer) SQL(sqlPrefix string) *StaticTransformer

func (*StaticTransformer) Transform added in v0.84.0 

func (v *StaticTransformer) Transform(f *Field) *Field

type TagBuilder added in v0.72.0 

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

func Tags added in v0.72.0 

func Tags() *TagBuilder

func (*TagBuilder) Build added in v0.72.0 

func (v *TagBuilder) Build() map[string][]string

func (*TagBuilder) DB added in v0.72.0 

func (v *TagBuilder) DB(db ...string) *TagBuilder

func (*TagBuilder) DDL added in v0.72.0 

func (v *TagBuilder) DDL(ddl ...string) *TagBuilder

func (*TagBuilder) Identifier added in v0.72.0 

func (v *TagBuilder) Identifier() *TagBuilder

func (*TagBuilder) Keyword added in v0.72.0 

func (v *TagBuilder) Keyword() *TagBuilder

func (*TagBuilder) List added in v0.72.0 

func (v *TagBuilder) List() *TagBuilder

func (*TagBuilder) NoEquals added in v0.73.0 

func (v *TagBuilder) NoEquals() *TagBuilder

func (*TagBuilder) NoParentheses added in v0.72.0 

func (v *TagBuilder) NoParentheses() *TagBuilder

func (*TagBuilder) Parameter added in v0.72.0 

func (v *TagBuilder) Parameter() *TagBuilder

func (*TagBuilder) Parentheses added in v0.73.0 

func (v *TagBuilder) Parentheses() *TagBuilder

func (*TagBuilder) SQL added in v0.72.0 

func (v *TagBuilder) SQL(sql ...string) *TagBuilder

func (*TagBuilder) SingleQuotes added in v0.73.0 

func (v *TagBuilder) SingleQuotes() *TagBuilder

func (*TagBuilder) Static added in v0.72.0 

func (v *TagBuilder) Static() *TagBuilder

type Validation 

type Validation struct {
	Type       ValidationType
	FieldNames []string
}

func NewValidation 

func NewValidation(validationType ValidationType, fieldNames ...string) *Validation

func (*Validation) Condition 

func (v *Validation) Condition(field *Field) string

func (*Validation) ReturnedError added in v0.72.0 

func (v *Validation) ReturnedError(field *Field) string

func (*Validation) TodoComment 

func (v *Validation) TodoComment(field *Field) string

type ValidationType 

type ValidationType int64

ValidationType contains all handled validation types. Below validations are marked to be contained here or not: - opts not nil - not present here, handled on template level - valid identifier - present here, for now put on level containing given field - conflicting fields - present here, put on level containing given fields - exactly one value set - present here, put on level containing given fields - at least one value set - present here, put on level containing given fields - validate nested field - present here, used for common structs which have their own validate() methods specified - nested validation conditionally - not present here, handled by putting validations on lower level fields 

const (
	ValidIdentifier ValidationType = iota
	ValidIdentifierIfSet
	ConflictingFields
	ExactlyOneValueSet
	AtLeastOneValueSet
	ValidateValue
	ValidateValueSet
)

Source Files

View all Source files

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.