analysis

type AllDirective struct {
}

type BetweenColumnDirective struct {
	// The column identifier parsed from the field's `sql` tag.
	ColIdent ColIdent
}

type BetweenStructField struct {
	// The name of the field.
	Name string
	// The information on the type of the field.
	Type TypeInfo
}

type Boolean uint8

type ColIdent struct {
	// The name of the column.
	Name string
	// The table or table alias qualifier of the column, or empty.
	Qualifier string
}

type ColIdentList struct {
	// The individual column identifiers parsed from the `sql` tag.
	Items []ColIdent
	// If set to `true`, indicates that "*" was used in the `sql` tag.
	All bool
}

type ColumnDirective struct {
	// The list of column identifiers as parsed from the `sql` tag of the directive.
	ColIdents []ColIdent
}

type ConstraintDirective struct {
	// The name of the constraint as parsed from the `sql` tag of the directive.
	Name string
}

type ContextField struct {
	// Name of the field (case preserved).
	Name string
}

type DefaultDirective struct {
	// The list of column identifiers as parsed from the `sql` tag of the directive.
	ColIdentList
}

type ErrorHandlerField struct {
	// Name of the field (case preserved).
	Name string
	// Indicates whether or not the field's type implements
	// the gosql.ErrorInfoHandler interface.
	IsInfo bool
}

type FieldInfo struct {
	// Name of the struct field.
	Name string
	// Info about the field's type.
	Type TypeInfo
	// If the field is nested, selector will hold the parent fields' information.
	Selector []*FieldSelectorNode
	// Indicates whether or not the field is embedded.
	IsEmbedded bool
	// Indicates whether or not the field is exported.
	IsExported bool
	// The field's parsed tag.
	Tag tagutil.Tag
	// The column identifier parsed from the field's `sql` tag.
	ColIdent ColIdent
	// If set, holds key to be used in the filter-column-key map
	// that's produced by the generator.
	FilterColumnKey string
	// TODO documentation
	Mode FieldMode
	// If set, indicates that the "nullempty" option was used in the field's `sql` tag.
	NullEmpty bool
	// If set, indicates that the "default" option was used in the field's `sql` tag.
	UseDefault bool
	// If set, indicates that the "add" option was used in the field's `sql` tag.
	UseAdd bool
	// If set, indicates that the "coalesce" option was used in the field's `sql` tag.
	UseCoalesce bool
	// Will hold the "alternative" value as parsed from the "coalesce" option of the field's `sql` tag.
	CoalesceValue string
}

type FieldMode uint

type FieldPtr interface{}

type FieldSelectorNode struct {
	// The name of the field.
	Name string
	// The tag of the field.
	Tag tagutil.Tag
	// The name of the field's type. Empty if the type is unnamed.
	TypeName string
	// The package import path for the field's type. Empty if the type is unnamed.
	TypePkgPath string
	// The name of the package of the field's type. Empty if the type is unnamed.
	TypePkgName string
	// The local name of the imported package of the field's type (including ".").
	// Empty if the type is unnamed.
	TypePkgLocal string
	// Indicates whether or not the type is imported.
	IsImported bool
	// Indicates whether or not the field is embedded.
	IsEmbedded bool
	// Indicates whether or not the field is exported.
	IsExported bool
	// Indicates whether or not the field type is a pointer type.
	IsPointer bool
	// TODO documentation
	Mode FieldMode
}

type FieldVar struct {
	// types.Var representation of the struct field.
	Var *types.Var
	// The raw string value of the field's tag.
	Tag string
}

type FilterConstructorField struct {
	// Name of the field (case preserved).
	Name string
	// IsV2 indicates that the field has a `filter:"v2"` struct tag.
	IsV2 bool
}

type FilterField struct {
	// Name of the field (case preserved).
	Name string
}

type FilterStruct struct {
	// Name of the filter struct type.
	TypeName string
	// The primary, `rel`-tagged field of the filter struct type.
	Rel *RelField
	// Info on the gosql.TextSearch directive field of the filter struct type, or nil.
	TextSearch *TextSearchDirective
	// Info on the field that implements the gosql.FilterConstructor interface.
	FilterConstructor *FilterConstructorField
}

type ForceDirective struct {
	// The list of column identifiers as parsed from the `sql` tag of the directive.
	ColIdentList
}

type FuncName string

type Identifier struct {
	// The name of a declared object.
	Name string
	// The import path of the package in which the object is declared.
	PkgPath string
}

type IgnoreDirective struct {
}

type IndexDirective struct {
	// The name of the index as parsed from the `sql` tag of the directive.
	Name string
}

type Info struct {
	// The FileSet associated with the analyzed TargetStruct.
	FileSet *token.FileSet
	// The package path of the analyzed TargetStruct.
	PkgPath string
	// The type name of the analyzed TargetStruct.
	TypeName string
	// The soruce position of the TargetStruct's type name.
	TypeNamePos token.Pos
	// FieldMap maintains a map of pointers of arbitrary type that represent
	// the result of analyzed fields, to the fields' related go/types specific
	// information. Intended for error reporting by the backend type-checker.
	FieldMap map[FieldPtr]FieldVar
	// RelSpace maintains a set of *unique* relation names or aliases that map
	// onto their respective RelIdent values that were parsed from struct tags.
	RelSpace map[string]RelIdent
	// The analyzed struct.
	Struct TargetStruct
}

type JoinBoolTagItem WhereBoolTag

type JoinConditionTagItem WhereColumnDirective

type JoinDirective struct {
	// The type of the join.
	JoinType JoinType
	// The relation identifier parsed from the `sql` tag.
	RelIdent RelIdent
	// List of items parsed from the `sql` tag.
	TagItems []JoinTagItem
}

type JoinStruct struct {
	// Name of the field (case preserved).
	FieldName string
	// Info on the gosql.Relation directive of the "from" and "using"
	// JoinStruct variation, nil for the "join" variation.
	Relation *RelationDirective
	// The list of gosql.JoinXxx directives declared in the JoinStruct.
	Directives []*JoinDirective
}

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

type JoinType uint8

type LimitField struct {
	// The name of the field (case preserved), or empty if it's a gosql.Limit directive.
	Name string
	// The value provided in the limit field's / directive's `sql` tag.
	// If the LimitField was produced from a directive the value will be
	// used as a constant.
	//
	// If the LimitField was produced from a normal field the value should *only*
	// be used if the field's actual value is empty, at runtime during the query's
	// execution, essentially acting as a default fallback.
	Value uint64
}

type LiteralType string

type NullsPosition uint8

type OffsetField struct {
	// The name of the field (case preserved), or empty if it's a gosql.Offset directive.
	Name string
	// The value provided in the offset field's / directive's `sql` tag.
	// If the OffsetField was produced from a directive the value will be
	// used as a constant.
	//
	// If the OffsetField was produced from a normal field the value should *only*
	// be used if the field's actual value is empty, at runtime during the query's
	// execution, essentially acting as a default fallback.
	Value uint64
}

type OnConflictStruct struct {
	// Name of the field (case preserved).
	FieldName string
	// If set, indicates that the gosql.Column "conflict_target" directive was used.
	Column *ColumnDirective
	// If set, indicates that the gosql.Index "conflict_target" directive was used.
	Index *IndexDirective
	// If set, indicates that the gosql.Constraint "conflict_target" directive was used.
	Constraint *ConstraintDirective
	// If set, indicates that the gosql.Ignore "conflict_action" directive was used.
	Ignore *IgnoreDirective
	// If set, indicates that the gosql.Update "conflict_action" directive was used.
	Update *UpdateDirective
}

type OptionalDirective struct {
	// The list of column identifiers as parsed from the `sql` tag of the directive.
	ColIdentList
}

type OrderByDirective struct {
	// The list of ORDER BY items as parsed from the `sql` tag of the directive.
	Items []OrderByTagItem
}

type OrderByTagItem struct {
	// The column identifier parsed from the `sql` tag.
	ColIdent ColIdent
	// The ordering direction parsed from the `sql` tag.
	Direction OrderDirection
	// The NULL position parsed from the `sql` tag.
	Nulls NullsPosition
}

type OrderDirection uint8

type OverrideDirective struct {
	// The OVERRIDING value as parsed from the `sql` tag of the directive.
	Kind OverridingKind
}

type OverridingKind uint8

type Predicate uint

type Quantifier uint8

type QueryKind uint8

type QueryStruct struct {
	// Name of the query struct type.
	TypeName string
	// The queryKind analyzed from query struct's type name.
	Kind QueryKind
	// The primary, `rel`-tagged field of the query struct.
	Rel *RelField
	// Info on the "result" field of the query struct type, or nil.
	Result *ResultField
	// Info on the "where" struct field of the query struct type, or nil.
	Where *WhereStruct
	// Info on the "join", "using", or "from" struct field of the query struct type, or nil.
	Join *JoinStruct
	// Info on the "onConflict" struct field of the query struct type, or nil.
	OnConflict *OnConflictStruct
	// Info on the gosql.OrderBy directive field of the query struct type, or nil.
	OrderBy *OrderByDirective
	// Info on the "limit" field or the gosql.Limit directive of the query struct type, or nil.
	Limit *LimitField
	// Info on the "offset" field or the gosql.Offset directive of the query struct type, or nil.
	Offset *OffsetField
	// Info on the "rowsaffected" field of the query struct type, or nil.
	RowsAffected *RowsAffectedField
	// Info on the gosql.Force directive field of the query struct type, or nil.
	Force *ForceDirective
	// Info on the gosql.Optional directive field of the query struct type, or nil.
	Optional *OptionalDirective
	// Info on the gosql.Default directive field of the query struct type, or nil.
	Default *DefaultDirective
	// Info on the gosql.Return directive field of the query struct type, or nil.
	Return *ReturnDirective
	// Info on the gosql.Override directive field of the query struct type, or nil.
	Override *OverrideDirective
	// Info on the gosql.ErrorHandler or gosql.ErrorInfoHandler field of the query struct type, or nil.
	ErrorHandler *ErrorHandlerField
	// Info on the gosql.Filter field of the query struct type, or nil.
	Filter *FilterField
	// Info on the context.Context field of the query struct type, or nil.
	Context *ContextField
	// Info on the gosql.All directive field of the query struct type, or nil.
	All *AllDirective
}

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

type RelField struct {
	// Name of the field.
	FieldName string
	// The relation identifier parsed from the field's `rel` tag.
	Id RelIdent
	// The type information of the field.
	Type RelType
	// Indicates whether or not the gosql.Relation directive was used.
	IsDirective bool
}

type RelIdent struct {
	// The name of the relation.
	Name string
	// The alias of the relation, or empty.
	Alias string
	// The schema qualifier of the relation, or empty.
	Qualifier string
}

type RelType struct {
	// Information on the "rel" field's base type.
	Base TypeInfo
	// Indicates whether or not the base type's a pointer type.
	IsPointer bool
	// Indicates whether or not the base type's a slice type.
	IsSlice bool
	// Indicates whether or not the base type's an array type.
	IsArray bool
	// If the base type's an array type, this field will hold the array's length.
	ArrayLen int64
	// If set, indicates that the type is handled by an iterator.
	IsIter bool
	// If set the value will hold the method name of the iterator interface.
	IterMethod string
	// Indicates whether or not the type implements the gosql.AfterScanner interface.
	IsAfterScanner bool
	// fields holds the information on the type's struct fields.
	Fields []*FieldInfo

	// A map of FieldInfo pointers to source code information about the field.
	// Used only for error reporting, after analysis of the RelType instance
	// this map is merged into the fieldMap of the targetInfo instance.
	//
	// Use `cmp:"-"` to ignore the map's contents during testing since
	// the map as an intermediary container is of secondary importance,
	// plus initializing it for the comparison to succeed would be too
	// much work with little to no return.
	FieldMap map[FieldPtr]FieldVar `cmp:"-"`
}

type RelationDirective struct {
	// The relation identifier as parsed from the `rel` tag of the directive.
	RelIdent RelIdent
}

type ResultField struct {
	// Name of the field (case preserved).
	FieldName string
	// The type information of the field.
	Type RelType
}

type ReturnDirective struct {
	// The list of column identifiers as parsed from the `sql` tag of the directive.
	ColIdentList
}

type RowsAffectedField struct {
	// Name of the field (case preserved).
	Name string
	// The kind of the field's type.
	TypeKind TypeKind
}

type TargetStruct interface {

	// GetRelField should return the RelField of the target relation.
	GetRelField() *RelField
	// GetRelIdent should return the RelIdent of the target relation.
	GetRelIdent() RelIdent
	// contains filtered or unexported methods
}

type TextSearchDirective struct {
	// The column identifier as parsed from the `sql` tag of the directive.
	ColIdent
}

type TypeInfo struct {
	// The name of a named type or empty string for unnamed types
	Name string
	// The kind of the go type.
	Kind TypeKind
	// The package import path.
	PkgPath string
	// The package's name.
	PkgName string
	// The local package name (including ".").
	PkgLocal string
	// Indicates whether or not the package is imported.
	IsImported bool
	// Indicates whether or not the type implements the sql.Scanner interface.
	IsScanner bool
	// Indicates whether or not the type implements the driver.Valuer interface.
	IsValuer bool
	// Indicates whether or not the type implements the json.Marshaler interface.
	IsJSONMarshaler bool
	// Indicates whether or not the type implements the json.Unmarshaler interface.
	IsJSONUnmarshaler bool
	// Indicates whether or not the type implements the xml.Marshaler interface.
	IsXMLMarshaler bool
	// Indicates whether or not the type implements the xml.Unmarshaler interface.
	IsXMLUnmarshaler bool
	// Indicates whether or not the type is an empty interface type.
	IsEmptyInterface bool
	// Indicates whether or not the type is the "byte" alias type.
	IsByte bool
	// Indicates whether or not the type is the "rune" alias type.
	IsRune bool
	// If kind is array, ArrayLen will hold the array's length.
	ArrayLen int64
	// If kind is map, key will hold the info on the map's key type.
	Key *TypeInfo
	// If kind is map, elem will hold the info on the map's value type.
	// If kind is ptr, elem will hold the info on pointed-to type.
	// If kind is slice/array, elem will hold the info on slice/array element type.
	Elem *TypeInfo
}

type TypeKind uint

type UpdateDirective struct {
	// The list of column identifiers as parsed from the `sql` tag of the directive.
	ColIdentList
}

type WhereBetweenStruct struct {
	// The name of the field with the "between" tag.
	FieldName string
	// The column identifier as extracted from the "between" field. The ColIdent
	// identifies the column to be used as the primary predicand of the BETWEEN predicate.
	ColIdent ColIdent
	// The type of the "between" predicate extracted from the field's tag.
	Predicate Predicate
	// The lower-bound range predicand of the "between" predicate as extracted
	// from the BetweenStruct's sub-field tagged with "lower", or "x".
	LowerBound RangeBound
	// The upper-bound range predicand of the "between" predicate as extracted
	// from the BetweenStruct's sub-field tagged with "upper", or "y".
	UpperBound RangeBound
}

type WhereBoolTag struct {
	// The boolean value.
	Value Boolean
}

type WhereColumnDirective struct {
	// The LHS column identifier parsed from the `sql` tag.
	LHSColIdent ColIdent
	// The RHS column identifier parsed from the `sql` tag, or empty.
	RHSColIdent ColIdent
	// The RHS literal value parsed from the `sql` tag, or empty.
	RHSLiteral string
	// The predicate type parsed from the `sql` tag, or 0.
	Predicate Predicate
	// The quantifier parsed from the `sql` tag, or 0.
	Quantifier Quantifier
}

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

type WhereStruct struct {
	// Name of the field (case preserved).
	FieldName string
	// List of different items specified by the WhereStruct.
	Items []WhereItem
}

type WhereStructField struct {
	// The name of the field.
	Name string
	// The field's type information.
	Type TypeInfo
	// The column identifier parsed from the `sql` tag.
	ColIdent ColIdent
	// The predicate type parsed from the `sql` tag, or 0.
	Predicate Predicate
	// The quantifier parsed from the `sql` tag, or 0.
	Quantifier Quantifier
	// The name of the function parsed from the `sql` tag, or empty.
	FuncName FuncName
}