dbdoc

Documentation

Index

• func BuildSSA(ctx *Context, args []string) (*ssa.Program, []*packages.Package, error)
• func Run(conf Config) error
• func WriteMermaid(w io.StringWriter, nodes []*Node) error
• type Call
• type Config
• type Context
• type Edge
• type EdgeType
• type Function
  • func BuildFuncs(ctx *Context, pkgs []*packages.Package, ssaProgram *ssa.Program, ...) ([]Function, error)
• type InLoop
• type LoopRange
• type LoopRangeMap
  • func BuildLoopRangeMap(ctx *Context) (LoopRangeMap, error)
• type LoopRanges
  • func (lr LoopRanges) Search(fset *token.FileSet, pos token.Pos) bool
• type Node
  • func BuildGraph(funcs []Function, ignoreFuncs, ignoreFuncPrefixes []string, ...) []*Node
• type NodeType
• type Query
  • func AnalyzeSQL(ctx *Context, sql stringLiteral) []Query
• type QueryType
  • func (qt QueryType) String() string

Functions

func BuildSSA

func BuildSSA(ctx *Context, args []string) (*ssa.Program, []*packages.Package, error)

func Run

func Run(conf Config) error

func WriteMermaid

func WriteMermaid(w io.StringWriter, nodes []*Node) error

Types

type Call

type Call struct {
	FunctionID string
	Pos        token.Pos
}

type Config

type Config struct {
	WorkDir                      string
	BuildArgs                    []string
	IgnoreFuncs                  []string
	IgnoreFuncPrefixes           []string
	IgnoreMain, IgnoreInitialize bool
	DestinationFilePath          string
}

type Context

type Context struct {
	FileSet *token.FileSet
	WorkDir string
}

type Edge

type Edge struct {
	Label    string
	Node     *Node
	EdgeType EdgeType
	InLoop   bool
}

type EdgeType

type EdgeType uint8

const (
	EdgeTypeUnknown EdgeType = iota
	EdgeTypeInsert
	EdgeTypeUpdate
	EdgeTypeDelete
	EdgeTypeSelect
	EdgeTypeCall
)

type Function

type Function struct {
	ID      string
	Name    string
	Pos     token.Pos
	Queries []InLoop[Query]
	Calls   []InLoop[Call]
}

func BuildFuncs

func BuildFuncs(ctx *Context, pkgs []*packages.Package, ssaProgram *ssa.Program, loopRangeMap LoopRangeMap) ([]Function, error)

type InLoop

type InLoop[T any] struct {
	Value  T
	InLoop bool
}

type LoopRange

type LoopRange struct {
	Start token.Pos
	End   token.Pos
}

type LoopRangeMap

type LoopRangeMap map[string]LoopRanges

func BuildLoopRangeMap

func BuildLoopRangeMap(ctx *Context) (LoopRangeMap, error)

type LoopRanges

type LoopRanges []LoopRange

func (LoopRanges) Search

func (lr LoopRanges) Search(fset *token.FileSet, pos token.Pos) bool

type Node

type Node struct {
	ID       string
	Label    string
	NodeType NodeType
	Edges    []Edge
}

func BuildGraph

func BuildGraph(funcs []Function, ignoreFuncs, ignoreFuncPrefixes []string, ignoreMain, ignoreInitialize bool) []*Node

type NodeType

type NodeType uint8

const (
	NodeTypeUnknown NodeType = iota
	NodeTypeTable
	NodeTypeFunction
)

type Query

type Query struct {
	QueryType QueryType
	Table     string
	Pos       token.Pos
}

func AnalyzeSQL

func AnalyzeSQL(ctx *Context, sql stringLiteral) []Query

type QueryType

type QueryType uint8

const (
	QueryTypeSelect QueryType = iota + 1
	QueryTypeInsert
	QueryTypeUpdate
	QueryTypeDelete
)

func (QueryType) String

func (qt QueryType) String() string