pluginv1

type AnnotationCardinality int32

type AnnotationDef struct {
	Name        string                    `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`       // e.g. "name", "cache"
	Aliases     []string                  `protobuf:"bytes,2,rep,name=aliases,proto3" json:"aliases,omitempty"` // alternate spellings
	Doc         string                    `protobuf:"bytes,3,opt,name=doc,proto3" json:"doc,omitempty"`
	Targets     []ir.AnnotationTargetKind `protobuf:"varint,4,rep,packed,name=targets,proto3,enum=sqld.v1.ir.AnnotationTargetKind" json:"targets,omitempty"` // where it may attach
	Cardinality AnnotationCardinality     `protobuf:"varint,5,opt,name=cardinality,proto3,enum=sqld.v1.plugin.AnnotationCardinality" json:"cardinality,omitempty"`
	Placement   CommentPlacement          `protobuf:"varint,6,opt,name=placement,proto3,enum=sqld.v1.plugin.CommentPlacement" json:"placement,omitempty"`
	Required    bool                      `protobuf:"varint,7,opt,name=required,proto3" json:"required,omitempty"` // must be present on target
	Value       *AnnotationValueSpec      `protobuf:"bytes,8,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type AnnotationForm int32

type AnnotationSchema struct {
	Sigil           string           `protobuf:"bytes,1,opt,name=sigil,proto3" json:"sigil,omitempty"`                                             // marker before the name, e.g. "@"; empty = bare key
	CaseInsensitive bool             `protobuf:"varint,2,opt,name=case_insensitive,json=caseInsensitive,proto3" json:"case_insensitive,omitempty"` // match names ignoring case
	CommentStyles   []string         `protobuf:"bytes,3,rep,name=comment_styles,json=commentStyles,proto3" json:"comment_styles,omitempty"`        // comment syntaxes to scan: "--", "/* */", "#"
	Annotations     []*AnnotationDef `protobuf:"bytes,4,rep,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

type AnnotationValueSpec struct {
	Form AnnotationForm `protobuf:"varint,1,opt,name=form,proto3,enum=sqld.v1.plugin.AnnotationForm" json:"form,omitempty"`
	// POSITIONAL / KEYED: the expected fields. For KEYED, `name` is the key; for
	// POSITIONAL, order matters and `name` labels the produced arg.
	Fields []*FieldSpec `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty"`
	// SCALAR: the single value's type.
	ScalarType ir.AnnotationArgType `` /* 126-byte string literal not displayed */
	// LIST: the element type (its `name` is ignored).
	Element *FieldSpec `protobuf:"bytes,4,opt,name=element,proto3" json:"element,omitempty"`
	// Separators (sensible defaults applied by the host when empty).
	ItemSeparator string `protobuf:"bytes,5,opt,name=item_separator,json=itemSeparator,proto3" json:"item_separator,omitempty"` // LIST items; default ","
	PairSeparator string `protobuf:"bytes,6,opt,name=pair_separator,json=pairSeparator,proto3" json:"pair_separator,omitempty"` // KEYED pairs; default whitespace
	KvSeparator   string `protobuf:"bytes,7,opt,name=kv_separator,json=kvSeparator,proto3" json:"kv_separator,omitempty"`       // KEYED key/value; default "="
	// contains filtered or unexported fields
}

type CommentPlacement int32

type Diagnostic struct {
	Severity DiagnosticSeverity `protobuf:"varint,1,opt,name=severity,proto3,enum=sqld.v1.plugin.DiagnosticSeverity" json:"severity,omitempty"`
	Message  string             `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	Source   *ir.SourceSpan     `protobuf:"bytes,3,opt,name=source,proto3" json:"source,omitempty"` // where it originated, when known
	Code     string             `protobuf:"bytes,4,opt,name=code,proto3" json:"code,omitempty"`     // stable diagnostic code
	// contains filtered or unexported fields
}

type DiagnosticSeverity int32

type FieldSpec struct {
	Name       string               `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`                                    // key name / positional label
	Type       ir.AnnotationArgType `protobuf:"varint,2,opt,name=type,proto3,enum=sqld.v1.ir.AnnotationArgType" json:"type,omitempty"` // how to coerce the token
	Required   bool                 `protobuf:"varint,3,opt,name=required,proto3" json:"required,omitempty"`
	EnumValues []string             `protobuf:"bytes,4,rep,name=enum_values,json=enumValues,proto3" json:"enum_values,omitempty"` // allowed values when type == ENUM
	Default    string               `protobuf:"bytes,5,opt,name=default,proto3" json:"default,omitempty"`                         // raw default when omitted
	Variadic   bool                 `protobuf:"varint,6,opt,name=variadic,proto3" json:"variadic,omitempty"`                      // last positional captures remainder
	Doc        string               `protobuf:"bytes,7,opt,name=doc,proto3" json:"doc,omitempty"`
	// contains filtered or unexported fields
}

type GenerateRequest struct {

	// Schema IR derived from DDL and applied migrations.
	Catalog *ir.Catalog `protobuf:"bytes,1,opt,name=catalog,proto3" json:"catalog,omitempty"`
	// Named DML queries parsed from query sources.
	Queries []*Query `protobuf:"bytes,2,rep,name=queries,proto3" json:"queries,omitempty"`
	// Ordered migrations (raw + parsed), for migration-aware generators.
	Migrations []*Migration `protobuf:"bytes,3,rep,name=migrations,proto3" json:"migrations,omitempty"`
	// Plugin-specific settings, opaque to the host. The plugin decodes these
	// bytes into its own options message (see PluginConfig.options).
	Options []byte `protobuf:"bytes,4,opt,name=options,proto3" json:"options,omitempty"`
	// Output directory the plugin should target (host resolves/cleans it).
	OutDir  string         `protobuf:"bytes,5,opt,name=out_dir,json=outDir,proto3" json:"out_dir,omitempty"`
	Context *PluginContext `protobuf:"bytes,6,opt,name=context,proto3" json:"context,omitempty"`
	// All annotations parsed from the SQL sources, per the plugin's declared
	// AnnotationSchema. A flat, global list keyed by target; also mirrored onto
	// each object's Metadata.annotations.
	Annotations []*ir.AnnotationValue `protobuf:"bytes,7,rep,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

type GenerateResponse struct {
	Files       []*GeneratedFile `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
	Diagnostics []*Diagnostic    `protobuf:"bytes,2,rep,name=diagnostics,proto3" json:"diagnostics,omitempty"`
	// contains filtered or unexported fields
}

type GeneratedFile struct {
	Path       string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` // relative to GenerateRequest.out_dir
	Contents   []byte `protobuf:"bytes,2,opt,name=contents,proto3" json:"contents,omitempty"`
	Executable bool   `protobuf:"varint,3,opt,name=executable,proto3" json:"executable,omitempty"` // set the executable bit
	// contains filtered or unexported fields
}

type GeneratorClient interface {
	// GetInfo reports plugin identity and capabilities so the host can validate
	// it before running. Cheap; no IR is sent.
	GetInfo(ctx context.Context, in *GetInfoRequest, opts ...grpc.CallOption) (*GetInfoResponse, error)
	// Generate turns the IR (schema + queries + migrations) into output files.
	Generate(ctx context.Context, in *GenerateRequest, opts ...grpc.CallOption) (*GenerateResponse, error)
}

type GeneratorServer interface {
	// GetInfo reports plugin identity and capabilities so the host can validate
	// it before running. Cheap; no IR is sent.
	GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
	// Generate turns the IR (schema + queries + migrations) into output files.
	Generate(context.Context, *GenerateRequest) (*GenerateResponse, error)
	// contains filtered or unexported methods
}

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

type GetInfoResponse struct {
	Name             string      `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Version          string      `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	SupportedEngines []ir.Engine `` /* 140-byte string literal not displayed */
	// Human/tooling-readable description of accepted options (e.g. a JSON schema
	// or a proto descriptor name). Informational; options on the wire are bytes.
	OptionsSchema string   `protobuf:"bytes,4,opt,name=options_schema,json=optionsSchema,proto3" json:"options_schema,omitempty"`
	Capabilities  []string `protobuf:"bytes,5,rep,name=capabilities,proto3" json:"capabilities,omitempty"` // free-form feature flags
	// Grammar of the SQL-comment annotations this plugin understands. The host
	// parses comments against this and returns sqld.v1.ir.AnnotationValue results.
	AnnotationSchema *AnnotationSchema `protobuf:"bytes,6,opt,name=annotation_schema,json=annotationSchema,proto3" json:"annotation_schema,omitempty"`
	// contains filtered or unexported fields
}

type Migration struct {
	Version    string          `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` // ordering key: "0001", timestamp, ...
	Name       string          `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	UpSql      string          `protobuf:"bytes,3,opt,name=up_sql,json=upSql,proto3" json:"up_sql,omitempty"`
	DownSql    string          `protobuf:"bytes,4,opt,name=down_sql,json=downSql,proto3" json:"down_sql,omitempty"`
	Up         []*ir.Statement `protobuf:"bytes,5,rep,name=up,proto3" json:"up,omitempty"`     // parsed up statements
	Down       []*ir.Statement `protobuf:"bytes,6,rep,name=down,proto3" json:"down,omitempty"` // parsed down statements
	SourceFile string          `protobuf:"bytes,7,opt,name=source_file,json=sourceFile,proto3" json:"source_file,omitempty"`
	// contains filtered or unexported fields
}

type PluginContext struct {
	HostVersion string            `protobuf:"bytes,1,opt,name=host_version,json=hostVersion,proto3" json:"host_version,omitempty"`
	WorkingDir  string            `protobuf:"bytes,2,opt,name=working_dir,json=workingDir,proto3" json:"working_dir,omitempty"`
	Engine      ir.Engine         `protobuf:"varint,3,opt,name=engine,proto3,enum=sqld.v1.ir.Engine" json:"engine,omitempty"`
	Env         map[string]string `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Query struct {
	Name       string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // from `-- name: Foo :one`
	Sql        string            `protobuf:"bytes,2,opt,name=sql,proto3" json:"sql,omitempty"`   // raw SQL text
	Command    QueryCommand      `protobuf:"varint,3,opt,name=command,proto3,enum=sqld.v1.plugin.QueryCommand" json:"command,omitempty"`
	Ast        *ir.Statement     `protobuf:"bytes,4,opt,name=ast,proto3" json:"ast,omitempty"` // parsed statement IR
	Parameters []*QueryParameter `protobuf:"bytes,5,rep,name=parameters,proto3" json:"parameters,omitempty"`
	Columns    []*QueryColumn    `protobuf:"bytes,6,rep,name=columns,proto3" json:"columns,omitempty"`
	SourceFile string            `protobuf:"bytes,7,opt,name=source_file,json=sourceFile,proto3" json:"source_file,omitempty"`
	Comment    string            `protobuf:"bytes,8,opt,name=comment,proto3" json:"comment,omitempty"` // leading doc comment, if any
	// contains filtered or unexported fields
}

type QueryColumn struct {
	Name         string        `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type         *ir.TypeRef   `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Nullable     bool          `protobuf:"varint,3,opt,name=nullable,proto3" json:"nullable,omitempty"`
	IsArray      bool          `protobuf:"varint,4,opt,name=is_array,json=isArray,proto3" json:"is_array,omitempty"`
	SourceColumn *ir.ObjectRef `protobuf:"bytes,5,opt,name=source_column,json=sourceColumn,proto3" json:"source_column,omitempty"` // origin column, when inferred
	TableAlias   string        `protobuf:"bytes,6,opt,name=table_alias,json=tableAlias,proto3" json:"table_alias,omitempty"`
	// contains filtered or unexported fields
}

type QueryCommand int32

type QueryParameter struct {
	Number   uint32        `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"` // 1-based position
	Name     string        `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`      // named param, when available
	Type     *ir.TypeRef   `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	Nullable bool          `protobuf:"varint,4,opt,name=nullable,proto3" json:"nullable,omitempty"`
	Column   *ir.ObjectRef `protobuf:"bytes,5,opt,name=column,proto3" json:"column,omitempty"` // originating column, when inferred
	// optional marks a dynamic-query parameter declared with the `@name?` suffix:
	// the WHERE condition using it is included only when the caller supplies it.
	Optional bool `protobuf:"varint,6,opt,name=optional,proto3" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedGeneratorServer struct{}

type UnsafeGeneratorServer interface {
	// contains filtered or unexported methods
}