metadata

Documentation

Index

• Constants
• func ParseCommentFlags(comments []string) (map[string]string, map[string]bool, map[string]struct{}, error)
• func ParseQueryNameAndType(t string, commentStyle CommentSyntax) (string, string, error)
• type CommentSyntax
• type Metadata

Constants

const (
	CmdExec       = ":exec"
	CmdExecResult = ":execresult"
	CmdExecRows   = ":execrows"
	CmdExecLastId = ":execlastid"
	CmdMany       = ":many"
	CmdOne        = ":one"
	CmdCopyFrom   = ":copyfrom"
	CmdBatchExec  = ":batchexec"
	CmdBatchMany  = ":batchmany"
	CmdBatchOne   = ":batchone"
)

Functions

func ParseCommentFlags

func ParseCommentFlags(comments []string) (map[string]string, map[string]bool, map[string]struct{}, error)

ParseCommentFlags processes the comments provided with queries to determine the metadata params, flags and rules to skip. All flags in query comments are prefixed with `@`, e.g. @param, @@sqlc-vet-disable.

func ParseQueryNameAndType

func ParseQueryNameAndType(t string, commentStyle CommentSyntax) (string, string, error)

Types

type CommentSyntax

type CommentSyntax source.CommentSyntax

type Metadata

type Metadata struct {
	Name     string
	Cmd      string
	Comments []string
	Params   map[string]string
	Flags    map[string]bool

	// RuleSkiplist contains the names of rules to disable vetting for.
	// If the map is empty, but the disable vet flag is specified, then all rules are ignored.
	RuleSkiplist map[string]struct{}

	Filename string
}