pqtgo

Documentation

Index

• Variables
• func WriteCompositionQueryInt64(i *qtypes.Int64, sel string, com *Composer, opt *CompositionOpts) (err error)
• func WriteCompositionQueryString(s *qtypes.String, sel string, com *Composer, opt *CompositionOpts) (err error)
• type BuiltinType
  • func (bt BuiltinType) Fingerprint() string
  • func (bt BuiltinType) String() string
• type Composer
  • func NewComposer(size int64) *Composer
  • func (c *Composer) Add(arg interface{})
  • func (c *Composer) Args() []interface{}
  • func (c *Composer) Len() int
  • func (c *Composer) Read(b []byte) (int, error)
  • func (c *Composer) ResetBuf()
  • func (c *Composer) String() string
  • func (c *Composer) Write(b []byte) (int, error)
  • func (c *Composer) WritePlaceholder() error
  • func (c *Composer) WriteString(s string) (int, error)
• type CompositionOpts
• type CompositionWriter
• type CustomType
  • func TypeCustom(m, o, c interface{}) CustomType
  • func TypeMapOfStrings() CustomType
  • func (ct CustomType) Fingerprint() string
  • func (ct CustomType) String() string
• type Generator
  • func NewGenerator() *Generator
  • func (g *Generator) AddImport(i string) *Generator
  • func (g *Generator) Generate(s *pqt.Schema) ([]byte, error)
  • func (g *Generator) GenerateTo(s *pqt.Schema, w io.Writer) error
  • func (g *Generator) SetAcronyms(acronyms map[string]string) *Generator
  • func (g *Generator) SetImports(imports ...string) *Generator
  • func (g *Generator) SetPackage(pkg string) *Generator
  • func (g *Generator) SetPostgresVersion(ver float32) *Generator
  • func (g *Generator) SetVisibility(v Visibility) *Generator
• type Visibility

Examples

• Composer.Read

Variables

var (
	// Space is a shorthand composition option that holds space.
	Space = &CompositionOpts{
		Joint: " ",
	}
	// And is a shorthand composition option that holds AND operator.
	And = &CompositionOpts{
		Joint: " AND ",
	}
	// Or is a shorthand composition option that holds OR operator.
	Or = &CompositionOpts{
		Joint: " OR ",
	}
	// Comma is a shorthand composition option that holds comma.
	Comma = &CompositionOpts{
		Joint: ", ",
	}
)

Functions

func WriteCompositionQueryInt64

func WriteCompositionQueryInt64(i *qtypes.Int64, sel string, com *Composer, opt *CompositionOpts) (err error)

WriteCompositionQueryInt64 ...

func WriteCompositionQueryString

func WriteCompositionQueryString(s *qtypes.String, sel string, com *Composer, opt *CompositionOpts) (err error)

WriteCompositionQueryString ...

Types

type BuiltinType

type BuiltinType types.BasicKind

BuiltinType ...

func (BuiltinType) Fingerprint

func (bt BuiltinType) Fingerprint() string

Fingerprint implements Type interface.

func (BuiltinType) String

func (bt BuiltinType) String() string

type Composer

type Composer struct {
	Dirty bool
	// contains filtered or unexported fields
}

Composer holds buffer, arguments and placeholders count. In combination with external buffet can be also used to also generate sub-queries. To do that simply write buffer to the parent buffer, composer will hold all arguments and remember number of last placeholder.

func NewComposer

func NewComposer(size int64) *Composer

NewComposer allocates new Composer with inner slice of arguments of given size.

func (*Composer) Add

func (c *Composer) Add(arg interface{})

Add appends list with new element.

func (*Composer) Args

func (c *Composer) Args() []interface{}

Args returns all arguments stored as a slice.

func (*Composer) Len

func (c *Composer) Len() int

Len returns number of arguments.

func (*Composer) Read

func (c *Composer) Read(b []byte) (int, error)

Read implements io Reader interface.

Example

com := NewComposer(0)
buf := bytes.NewBufferString("SELECT * FROM user")
arg := 1

// lets imagine that not always argument is present
if arg > 0 {
	_, _ = com.WriteString("age = ")
	_ = com.WritePlaceholder()
	com.Add(arg)
	com.Dirty = true // something was written, lets mark composer as dirty
}

if com.Dirty {
	buf.WriteString(" WHERE ")
	buf.ReadFrom(com)
}

fmt.Println(strings.TrimSpace(
	buf.String(),
))
fmt.Print(com.Args())

Output:

SELECT * FROM user WHERE age = $1
[1]

func (*Composer) ResetBuf

func (c *Composer) ResetBuf()

ResetBuf resets internal buffer.

func (*Composer) String

func (c *Composer) String() string

String implements fmt Stringer interface.

func (*Composer) Write

func (c *Composer) Write(b []byte) (int, error)

Write implements io Writer interface.

func (*Composer) WritePlaceholder

func (c *Composer) WritePlaceholder() error

WritePlaceholder writes appropriate placeholder to the query buffer based on current state of the composer.

func (*Composer) WriteString

func (c *Composer) WriteString(s string) (int, error)

WriteString appends the contents of s to the query buffer, growing the buffer as needed. The return value n is the length of s; err is always nil. If the buffer becomes too large, WriteString will panic with bytes ErrTooLarge.

type CompositionOpts

type CompositionOpts struct {
	Joint                         string
	PlaceholderFunc, SelectorFunc string
	Cast                          string
}

CompositionOpts is a container for modification that can be applied.

type CompositionWriter

type CompositionWriter interface {
	// WriteComposition is a function that allow custom struct type to be used as a part of criteria.
	// It gives possibility to write custom query based on object that implements this interface.
	WriteComposition(string, *Composer, *CompositionOpts) error
}

CompositionWriter is a simple wrapper for WriteComposition function.

type CustomType

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

CustomType ...

func TypeCustom

func TypeCustom(m, o, c interface{}) CustomType

TypeCustom ...

func TypeMapOfStrings

func TypeMapOfStrings() CustomType

TypeMapOfStrings ....

func (CustomType) Fingerprint

func (ct CustomType) Fingerprint() string

Fingerprint implements Type interface.

func (CustomType) String

func (ct CustomType) String() string

String implements Stringer interface.

type Generator

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

Generator ...

func NewGenerator

func NewGenerator() *Generator

NewGenerator allocates new Generator.

func (*Generator) AddImport

func (g *Generator) AddImport(i string) *Generator

AddImport ...

func (*Generator) Generate

func (g *Generator) Generate(s *pqt.Schema) ([]byte, error)

Generate ...

func (*Generator) GenerateTo

func (g *Generator) GenerateTo(s *pqt.Schema, w io.Writer) error

GenerateTo ...

func (*Generator) SetAcronyms

func (g *Generator) SetAcronyms(acronyms map[string]string) *Generator

SetAcronyms ...

func (*Generator) SetImports

func (g *Generator) SetImports(imports ...string) *Generator

SetImports ...

func (*Generator) SetPackage

func (g *Generator) SetPackage(pkg string) *Generator

SetPackage ...

func (*Generator) SetPostgresVersion

func (g *Generator) SetPostgresVersion(ver float32) *Generator

SetPostgresVersion sets version of postgres for which code will be generated.

func (*Generator) SetVisibility

func (g *Generator) SetVisibility(v Visibility) *Generator

SetVisibility sets visibility that each struct, function, method or property will get.

type Visibility

type Visibility string

const (
	Public  Visibility = "public"
	Private Visibility = "private"
)