parser

Documentation

Index

• func FormatExecuteStmt(es *ExecuteStmt) string
• func FormatExecuteStmtWithNote(es *ExecuteStmt, note string) string
• type ExecuteStmt
• type ParseResult
  • func ParseSQLFilesWithSchema(paths []string, defaultSchema string) (*ParseResult, error)

Functions

func FormatExecuteStmt

func FormatExecuteStmt(es *ExecuteStmt) string

FormatExecuteStmt formats an ExecuteStmt as SQL with the directive comment.

func FormatExecuteStmtWithNote

func FormatExecuteStmtWithNote(es *ExecuteStmt, note string) string

FormatExecuteStmtWithNote formats an ExecuteStmt with an extra comment line between the directive and the SQL. note is used by plan to record that the check SQL could not be evaluated, so the statement is shown without a verdict. Newlines in note are folded to keep the comment on one line.

Types

type ExecuteStmt

type ExecuteStmt struct {
	SQL      string // The SQL statement to execute
	CheckSQL string // Optional condition check SQL (empty = always execute)
	// First reports whether the statement came from -- pista:execute-first,
	// which runs before the managed DDL instead of after it. Its check SQL is
	// therefore evaluated against the pre-change schema.
	First bool
}

ExecuteStmt represents an arbitrary SQL statement marked with -- pista:execute or -- pista:execute-first.

type ParseResult

type ParseResult struct {
	Tables         *orderedmap.Map[string, *model.Table]
	Views          *orderedmap.Map[string, *model.View]
	Enums          *orderedmap.Map[string, *model.Enum]
	Domains        *orderedmap.Map[string, *model.Domain]
	CompositeTypes *orderedmap.Map[string, *model.CompositeType]
	Sequences      *orderedmap.Map[string, *model.Sequence]
	ExecuteStmts   []*ExecuteStmt
}

func ParseSQLFilesWithSchema

func ParseSQLFilesWithSchema(paths []string, defaultSchema string) (*ParseResult, error)