package clause

Import Path
	gorm.io/gorm/clause (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 6 packages

Involved Source Files

	    clause.go
	    delete.go
	    expression.go
	    from.go
	    group_by.go
	    insert.go
	    joins.go
	    limit.go
	    locking.go
	    on_conflict.go
	    order_by.go
	    returning.go
	    select.go
	    set.go
	    update.go
	    values.go
	    where.go
	    with.go
Package-Level Type Names (total 42)

	/* sort by: alphabet | popularity */
	 type AndConditions (struct)

		Fields (only one)
			Exprs []Expression
		Methods (only one)
			( AndConditions) Build(builder Builder)
		Implements (at least one exported)
			 AndConditions : Expression

	 type Assignment (struct)

		Fields (total 2)
			Column Column
			Value interface{}

	 type Builder (interface)
		Builder builder interface

		Methods (total 5)
			( Builder) AddError(error) error
			( Builder) AddVar(Writer, ...interface{})
			( Builder) WriteByte(byte) error
			( Builder) WriteQuoted(field interface{})
			( Builder) WriteString(string) (int, error)
		Implemented By (at least one exported)
			*gorm.io/gorm.Statement
		Implements (at least 3)
			 Builder : Writer
			 Builder : io.ByteWriter
			 Builder : io.StringWriter
		As Inputs Of (at least 44)
			func AndConditions.Build(builder Builder)
			func Clause.Build(builder Builder)
			func CommaExpression.Build(builder Builder)
			func Delete.Build(builder Builder)
			func Eq.Build(builder Builder)
			func Eq.NegationBuild(builder Builder)
			func Expr.Build(builder Builder)
			func Expression.Build(builder Builder)
			func From.Build(builder Builder)
			func GroupBy.Build(builder Builder)
			func Gt.Build(builder Builder)
			func Gt.NegationBuild(builder Builder)
			func Gte.Build(builder Builder)
			func Gte.NegationBuild(builder Builder)
			func IN.Build(builder Builder)
			func IN.NegationBuild(builder Builder)
			func Insert.Build(builder Builder)
			func Interface.Build(Builder)
			func Join.Build(builder Builder)
			func Like.Build(builder Builder)
			func Like.NegationBuild(builder Builder)
			func Limit.Build(builder Builder)
			func Locking.Build(builder Builder)
			func Lt.Build(builder Builder)
			func Lt.NegationBuild(builder Builder)
			func Lte.Build(builder Builder)
			func Lte.NegationBuild(builder Builder)
			func NamedExpr.Build(builder Builder)
			func NegationExpressionBuilder.NegationBuild(builder Builder)
			func Neq.Build(builder Builder)
			func Neq.NegationBuild(builder Builder)
			func NotConditions.Build(builder Builder)
			func OnConflict.Build(builder Builder)
			func OrConditions.Build(builder Builder)
			func OrderBy.Build(builder Builder)
			func Returning.Build(builder Builder)
			func Select.Build(builder Builder)
			func Set.Build(builder Builder)
			func Update.Build(builder Builder)
			func Values.Build(builder Builder)
			func Where.Build(builder Builder)
			func gorm.io/gorm.SoftDeleteDeleteClause.Build(Builder)
			func gorm.io/gorm.SoftDeleteQueryClause.Build(Builder)
			func gorm.io/gorm.SoftDeleteUpdateClause.Build(Builder)

	 type Clause (struct)
		Clause

		Fields (total 6)
			AfterExpression Expression
			AfterNameExpression Expression
			BeforeExpression Expression
			Builder ClauseBuilder
			Expression Expression
			Name string
				// WHERE

		Methods (only one)
			( Clause) Build(builder Builder)
				Build build clause

		Implements (at least one exported)
			 Clause : Expression
		As Inputs Of (at least 18)
			func Delete.MergeClause(clause *Clause)
			func From.MergeClause(clause *Clause)
			func GroupBy.MergeClause(clause *Clause)
			func Insert.MergeClause(clause *Clause)
			func Interface.MergeClause(*Clause)
			func Limit.MergeClause(clause *Clause)
			func Locking.MergeClause(clause *Clause)
			func OnConflict.MergeClause(clause *Clause)
			func OrderBy.MergeClause(clause *Clause)
			func Returning.MergeClause(clause *Clause)
			func Select.MergeClause(clause *Clause)
			func Set.MergeClause(clause *Clause)
			func Update.MergeClause(clause *Clause)
			func Values.MergeClause(clause *Clause)
			func Where.MergeClause(clause *Clause)
			func gorm.io/gorm.SoftDeleteDeleteClause.MergeClause(*Clause)
			func gorm.io/gorm.SoftDeleteQueryClause.MergeClause(*Clause)
			func gorm.io/gorm.SoftDeleteUpdateClause.MergeClause(*Clause)

	 type ClauseBuilder (func)
		ClauseBuilder clause builder, allows to customize how to build clause

		As Outputs Of (at least one exported)
			func gorm.io/driver/mysql.Dialector.ClauseBuilders() map[string]ClauseBuilder

	 type Column (struct)
		Column quote with name

		Fields (total 4)
			Alias string
			Name string
			Raw bool
			Table string
		As Types Of (only one)
			  var PrimaryColumn

	 type CommaExpression (struct)
		CommaExpression represents a group of expressions separated by commas.

		Fields (only one)
			Exprs []Expression
		Methods (only one)
			( CommaExpression) Build(builder Builder)
		Implements (at least one exported)
			 CommaExpression : Expression

	 type Delete (struct)

		Fields (only one)
			Modifier string
		Methods (total 3)
			( Delete) Build(builder Builder)
			( Delete) MergeClause(clause *Clause)
			( Delete) Name() string
		Implements (at least 2)
			 Delete : Expression
			 Delete : Interface

	 type Eq (struct)
		Eq equal to for where

		Fields (total 2)
			Column interface{}
			Value interface{}
		Methods (total 2)
			( Eq) Build(builder Builder)
			( Eq) NegationBuild(builder Builder)
		Implements (at least 2)
			 Eq : Expression
			 Eq : NegationExpressionBuilder

	 type Expr (struct)
		Expr raw expression

		Fields (total 3)
			SQL string
			Vars []interface{}
			WithoutParentheses bool
		Methods (only one)
			( Expr) Build(builder Builder)
				Build build raw expression

		Implements (at least one exported)
			 Expr : Expression
		As Outputs Of (at least 5)
			func gorm.io/gorm.Expr(expr string, args ...interface{}) Expr
			func gorm.io/gorm.Migrator.FullDataTypeOf(*schema.Field) Expr
			func gorm.io/gorm.Valuer.GormValue(context.Context, *gorm.DB) Expr
			func gorm.io/gorm/migrator.Migrator.FullDataTypeOf(field *schema.Field) (expr Expr)
			func gorm.io/driver/mysql.Migrator.FullDataTypeOf(field *schema.Field) Expr
		As Inputs Of (at least one exported)
			func gorm.io/driver/postgres.Migrator.DeleteSequence(tx *gorm.DB, stmt *gorm.Statement, field *schema.Field, fileType Expr) (err error)

	 type Expression (interface)
		Expression expression interface

		Methods (only one)
			( Expression) Build(builder Builder)
		Implemented By (at least 34)
			 AndConditions
			 Clause
			 CommaExpression
			 Delete
			 Eq
			 Expr
			 From
			 GroupBy
			 Gt
			 Gte
			 IN
			 Insert
			 Interface (interface)
			 Join
			 Like
			 Limit
			 Locking
			 Lt
			 Lte
			 NamedExpr
			 Neq
			 NotConditions
			 OnConflict
			 OrConditions
			 OrderBy
			 Returning
			 Select
			 Set
			 Update
			 Values
			 Where
			 gorm.io/gorm.SoftDeleteDeleteClause
			 gorm.io/gorm.SoftDeleteQueryClause
			 gorm.io/gorm.SoftDeleteUpdateClause
		As Outputs Of (at least 8)
			func And(exprs ...Expression) Expression
			func Not(exprs ...Expression) Expression
			func Or(exprs ...Expression) Expression
			func gorm.io/gorm.Dialector.DefaultValueOf(*schema.Field) Expression
			func gorm.io/gorm.(*Statement).BuildCondition(query interface{}, args ...interface{}) []Expression
			func gorm.io/gorm/schema.(*Relationship).ToQueryConditions(ctx context.Context, reflectValue reflect.Value) (conds []Expression)
			func gorm.io/driver/mysql.Dialector.DefaultValueOf(field *schema.Field) Expression
			func gorm.io/driver/postgres.Dialector.DefaultValueOf(field *schema.Field) Expression
		As Inputs Of (at least 4)
			func And(exprs ...Expression) Expression
			func Not(exprs ...Expression) Expression
			func Or(exprs ...Expression) Expression
			func gorm.io/gorm.(*DB).Clauses(conds ...Expression) (tx *gorm.DB)

	 type From (struct)
		From from clause

		Fields (total 2)
			Joins []Join
			Tables []Table
		Methods (total 3)
			( From) Build(builder Builder)
				Build build from clause

			( From) MergeClause(clause *Clause)
				MergeClause merge from clause

			( From) Name() string
				Name from clause name

		Implements (at least 2)
			 From : Expression
			 From : Interface

	 type GroupBy (struct)
		GroupBy group by clause

		Fields (total 2)
			Columns []Column
			Having []Expression
		Methods (total 3)
			( GroupBy) Build(builder Builder)
				Build build group by clause

			( GroupBy) MergeClause(clause *Clause)
				MergeClause merge group by clause

			( GroupBy) Name() string
				Name from clause name

		Implements (at least 2)
			 GroupBy : Expression
			 GroupBy : Interface

	 type Gt Eq (struct)
		Gt greater than for where

		Fields (total 2)
			Column interface{}
			Value interface{}
		Methods (total 2)
			( Gt) Build(builder Builder)
			( Gt) NegationBuild(builder Builder)
		Implements (at least 2)
			 Gt : Expression
			 Gt : NegationExpressionBuilder

	 type Gte Eq (struct)
		Gte greater than or equal to for where

		Fields (total 2)
			Column interface{}
			Value interface{}
		Methods (total 2)
			( Gte) Build(builder Builder)
			( Gte) NegationBuild(builder Builder)
		Implements (at least 2)
			 Gte : Expression
			 Gte : NegationExpressionBuilder

	 type IN (struct)
		IN Whether a value is within a set of values

		Fields (total 2)
			Column interface{}
			Values []interface{}
		Methods (total 2)
			( IN) Build(builder Builder)
			( IN) NegationBuild(builder Builder)
		Implements (at least 2)
			 IN : Expression
			 IN : NegationExpressionBuilder

	 type Insert (struct)

		Fields (total 2)
			Modifier string
			Table Table
		Methods (total 3)
			( Insert) Build(builder Builder)
				Build build insert clause

			( Insert) MergeClause(clause *Clause)
				MergeClause merge insert clause

			( Insert) Name() string
				Name insert clause name

		Implements (at least 2)
			 Insert : Expression
			 Insert : Interface

	 type Interface (interface)
		Interface clause interface

		Methods (total 3)
			( Interface) Build(Builder)
			( Interface) MergeClause(*Clause)
			( Interface) Name() string
		Implemented By (at least 17)
			 Delete
			 From
			 GroupBy
			 Insert
			 Limit
			 Locking
			 OnConflict
			 OrderBy
			 Returning
			 Select
			 Set
			 Update
			 Values
			 Where
			 gorm.io/gorm.SoftDeleteDeleteClause
			 gorm.io/gorm.SoftDeleteQueryClause
			 gorm.io/gorm.SoftDeleteUpdateClause
		Implements (at least one exported)
			 Interface : Expression
		As Outputs Of (at least 7)
			func gorm.io/gorm.DeletedAt.DeleteClauses(f *schema.Field) []Interface
			func gorm.io/gorm.DeletedAt.QueryClauses(f *schema.Field) []Interface
			func gorm.io/gorm.DeletedAt.UpdateClauses(f *schema.Field) []Interface
			func gorm.io/gorm/schema.CreateClausesInterface.CreateClauses(*schema.Field) []Interface
			func gorm.io/gorm/schema.DeleteClausesInterface.DeleteClauses(*schema.Field) []Interface
			func gorm.io/gorm/schema.QueryClausesInterface.QueryClauses(*schema.Field) []Interface
			func gorm.io/gorm/schema.UpdateClausesInterface.UpdateClauses(*schema.Field) []Interface
		As Inputs Of (at least 2)
			func gorm.io/gorm.(*Statement).AddClause(v Interface)
			func gorm.io/gorm.(*Statement).AddClauseIfNotExists(v Interface)

	 type Join (struct)
		Join clause for from

		Fields (total 5)
			Expression Expression
			ON Where
			Table Table
			Type JoinType
			Using []string
		Methods (only one)
			( Join) Build(builder Builder)
		Implements (at least one exported)
			 Join : Expression

	 type JoinType string (basic type)

		As Types Of (total 4)
			const CrossJoin
			const InnerJoin
			const LeftJoin
			const RightJoin

	 type Like Eq (struct)
		Like whether string matches regular expression

		Fields (total 2)
			Column interface{}
			Value interface{}
		Methods (total 2)
			( Like) Build(builder Builder)
			( Like) NegationBuild(builder Builder)
		Implements (at least 2)
			 Like : Expression
			 Like : NegationExpressionBuilder

	 type Limit (struct)
		Limit limit clause

		Fields (total 2)
			Limit *int
			Offset int
		Methods (total 3)
			( Limit) Build(builder Builder)
				Build build where clause

			( Limit) MergeClause(clause *Clause)
				MergeClause merge order by clauses

			( Limit) Name() string
				Name where clause name

		Implements (at least 2)
			 Limit : Expression
			 Limit : Interface

	 type Locking (struct)

		Fields (total 3)
			Options string
			Strength string
			Table Table
		Methods (total 3)
			( Locking) Build(builder Builder)
				Build build where clause

			( Locking) MergeClause(clause *Clause)
				MergeClause merge order by clauses

			( Locking) Name() string
				Name where clause name

		Implements (at least 2)
			 Locking : Expression
			 Locking : Interface

	 type Lt Eq (struct)
		Lt less than for where

		Fields (total 2)
			Column interface{}
			Value interface{}
		Methods (total 2)
			( Lt) Build(builder Builder)
			( Lt) NegationBuild(builder Builder)
		Implements (at least 2)
			 Lt : Expression
			 Lt : NegationExpressionBuilder

	 type Lte Eq (struct)
		Lte less than or equal to for where

		Fields (total 2)
			Column interface{}
			Value interface{}
		Methods (total 2)
			( Lte) Build(builder Builder)
			( Lte) NegationBuild(builder Builder)
		Implements (at least 2)
			 Lte : Expression
			 Lte : NegationExpressionBuilder

	 type NamedExpr (struct)
		NamedExpr raw expression for named expr

		Fields (total 2)
			SQL string
			Vars []interface{}
		Methods (only one)
			( NamedExpr) Build(builder Builder)
				Build build raw expression

		Implements (at least one exported)
			 NamedExpr : Expression

	 type NegationExpressionBuilder (interface)
		NegationExpressionBuilder negation expression builder

		Methods (only one)
			( NegationExpressionBuilder) NegationBuild(builder Builder)
		Implemented By (at least 8)
			 Eq
			 Gt
			 Gte
			 IN
			 Like
			 Lt
			 Lte
			 Neq

	 type Neq Eq (struct)
		Neq not equal to for where

		Fields (total 2)
			Column interface{}
			Value interface{}
		Methods (total 2)
			( Neq) Build(builder Builder)
			( Neq) NegationBuild(builder Builder)
		Implements (at least 2)
			 Neq : Expression
			 Neq : NegationExpressionBuilder

	 type NotConditions (struct)

		Fields (only one)
			Exprs []Expression
		Methods (only one)
			( NotConditions) Build(builder Builder)
		Implements (at least one exported)
			 NotConditions : Expression

	 type OnConflict (struct)

		Fields (total 7)
			Columns []Column
			DoNothing bool
			DoUpdates Set
			OnConstraint string
			TargetWhere Where
			UpdateAll bool
			Where Where
		Methods (total 3)
			( OnConflict) Build(builder Builder)
				Build build onConflict clause

			( OnConflict) MergeClause(clause *Clause)
				MergeClause merge onConflict clauses

			( OnConflict) Name() string
		Implements (at least 2)
			 OnConflict : Expression
			 OnConflict : Interface

	 type OrConditions (struct)

		Fields (only one)
			Exprs []Expression
		Methods (only one)
			( OrConditions) Build(builder Builder)
		Implements (at least one exported)
			 OrConditions : Expression

	 type OrderBy (struct)

		Fields (total 2)
			Columns []OrderByColumn
			Expression Expression
		Methods (total 3)
			( OrderBy) Build(builder Builder)
				Build build where clause

			( OrderBy) MergeClause(clause *Clause)
				MergeClause merge order by clauses

			( OrderBy) Name() string
				Name where clause name

		Implements (at least 2)
			 OrderBy : Expression
			 OrderBy : Interface

	 type OrderByColumn (struct)

		Fields (total 3)
			Column Column
			Desc bool
			Reorder bool

	 type Returning (struct)

		Fields (only one)
			Columns []Column
		Methods (total 3)
			( Returning) Build(builder Builder)
				Build build where clause

			( Returning) MergeClause(clause *Clause)
				MergeClause merge order by clauses

			( Returning) Name() string
				Name where clause name

		Implements (at least 2)
			 Returning : Expression
			 Returning : Interface

	 type Select (struct)
		Select select attrs when querying, updating, creating

		Fields (total 3)
			Columns []Column
			Distinct bool
			Expression Expression
		Methods (total 3)
			( Select) Build(builder Builder)
			( Select) MergeClause(clause *Clause)
			( Select) Name() string
		Implements (at least 2)
			 Select : Expression
			 Select : Interface

	 type Set ([])

		Methods (total 3)
			( Set) Build(builder Builder)
			( Set) MergeClause(clause *Clause)
				MergeClause merge assignments clauses

			( Set) Name() string
		Implements (at least 2)
			 Set : Expression
			 Set : Interface
		As Outputs Of (at least 3)
			func AssignmentColumns(values []string) Set
			func Assignments(values map[string]interface{}) Set
			func gorm.io/gorm/callbacks.ConvertToAssignments(stmt *gorm.Statement) (set Set)

	 type Table (struct)
		Table quote with name

		Fields (total 3)
			Alias string
			Name string
			Raw bool

	 type Update (struct)

		Fields (total 2)
			Modifier string
			Table Table
		Methods (total 3)
			( Update) Build(builder Builder)
				Build build update clause

			( Update) MergeClause(clause *Clause)
				MergeClause merge update clause

			( Update) Name() string
				Name update clause name

		Implements (at least 2)
			 Update : Expression
			 Update : Interface

	 type Values (struct)

		Fields (total 2)
			Columns []Column
			Values [][]interface{}
		Methods (total 3)
			( Values) Build(builder Builder)
				Build build from clause

			( Values) MergeClause(clause *Clause)
				MergeClause merge values clauses

			( Values) Name() string
				Name from clause name

		Implements (at least 2)
			 Values : Expression
			 Values : Interface
		As Outputs Of (at least 3)
			func gorm.io/gorm/callbacks.ConvertMapToValuesForCreate(stmt *gorm.Statement, mapValue map[string]interface{}) (values Values)
			func gorm.io/gorm/callbacks.ConvertSliceOfMapToValuesForCreate(stmt *gorm.Statement, mapValues []map[string]interface{}) (values Values)
			func gorm.io/gorm/callbacks.ConvertToCreateValues(stmt *gorm.Statement) (values Values)

	 type Where (struct)
		Where where clause

		Fields (only one)
			Exprs []Expression
		Methods (total 3)
			( Where) Build(builder Builder)
				Build build where clause

			( Where) MergeClause(clause *Clause)
				MergeClause merge where clauses

			( Where) Name() string
				Name where clause name

		Implements (at least 2)
			 Where : Expression
			 Where : Interface

	 type With (struct)
	 type Writer (interface)

		Methods (total 2)
			( Writer) WriteByte(byte) error
			( Writer) WriteString(string) (int, error)
		Implemented By (at least 9)
			 Builder (interface)
			*gorm.io/gorm.Statement
			 bufio.ReadWriter
			*bufio.Writer
			*bytes.Buffer
			*github.com/valyala/bytebufferpool.ByteBuffer
			*go.uber.org/zap/buffer.Buffer
			 net/http/internal.FlushAfterChunkWriter
			*strings.Builder
		Implements (at least 2)
			 Writer : io.ByteWriter
			 Writer : io.StringWriter
		As Inputs Of (at least 9)
			func Builder.AddVar(Writer, ...interface{})
			func gorm.io/gorm.Dialector.BindVarTo(writer Writer, stmt *gorm.Statement, v interface{})
			func gorm.io/gorm.Dialector.QuoteTo(Writer, string)
			func gorm.io/gorm.(*Statement).AddVar(writer Writer, vars ...interface{})
			func gorm.io/gorm.(*Statement).QuoteTo(writer Writer, field interface{})
			func gorm.io/driver/mysql.Dialector.BindVarTo(writer Writer, stmt *gorm.Statement, v interface{})
			func gorm.io/driver/mysql.Dialector.QuoteTo(writer Writer, str string)
			func gorm.io/driver/postgres.Dialector.BindVarTo(writer Writer, stmt *gorm.Statement, v interface{})
			func gorm.io/driver/postgres.Dialector.QuoteTo(writer Writer, str string)


Package-Level Functions (total 5)

	 func And(exprs ...Expression) Expression
	 func AssignmentColumns(values []string) Set
	 func Assignments(values map[string]interface{}) Set
	 func Not(exprs ...Expression) Expression
	 func Or(exprs ...Expression) Expression
Package-Level Variables (only one)

	  var PrimaryColumn Column
Package-Level Constants (total 9)

	const AndWithSpace = " AND "
	const Associations string = "~~~as~~~" // associations
	const CrossJoin JoinType = "CROSS"
	const CurrentTable string = "~~~ct~~~" // current table
	const InnerJoin JoinType = "INNER"
	const LeftJoin JoinType = "LEFT"
	const OrWithSpace = " OR "
	const PrimaryKey string = "~~~py~~~" // primary key
	const RightJoin JoinType = "RIGHT"

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.