\n\n sql.Named(name string, value any) | \n database/sql's named parameter type | \n
\n\n sq.Param(name string, value any) | \n same as sql.Named, but satisfies the Field interface | \n
\n\n sq.BinaryParam(name string, b []byte) | \n same as sql.Named, but satisfies the Binary interface | \n
\n\n sq.BooleanParam(name string, b bool) | \n same as sql.Named, but satisfies the Boolean interface | \n
\n\n sq.IntParam(name string, num int) | \n same as sql.Named, but satisfies the Number interface | \n
\n\n sq.Int64Param(name string, num int64) | \n same as sql.Named, but satisfies the Number interface | \n
\n\n sq.Float64Param(name string, num float64) | \n same as sql.Named, but satisfies the Number interface | \n
\n\n sq.StringParam(name string, s string) | \n same as sql.Named, but satisfies the String interface | \n
\n\n sq.TimeParam(name string, t time.Time) | \n same as sql.Named, but satisfies the Time interface | \n
\n\n![\"code](\"https://raw.githubusercontent.com/bokwoon95/sq/main/header.png\" "\\"code")
\n\n# sq (Structured Query)\n\n[one-page documentation](https://bokwoon.neocities.org/sq.html)\n\nsq is a type-safe data mapper and query builder for Go. Its concept is simple: you provide a callback function that maps a row to a struct, generics ensure that you get back a slice of structs at the end. Additionally, mentioning a column in the callback function automatically adds it to the SELECT clause so you don't even have to explicitly mention what columns you want to select: the [act of mapping a column is the same as selecting it](#select-example-raw-sql). This eliminates a source of errors where you have specify the columns twice (once in the query itself, once to the call to rows.Scan) and end up missing a column, getting the column order wrong or mistyping a column name.\n\nNotable features:\n\n- Works across SQLite, Postgres, MySQL and SQL Server. [[more info](https://bokwoon.neocities.org/sq.html#set-query-dialect)]\n- Each dialect has its own query builder, allowing you to use dialect-specific features. [[more info](https://bokwoon.neocities.org/sq.html#dialect-specific-features)]\n- Declarative schema migrations. [[more info](https://bokwoon.neocities.org/sq.html#declarative-schema)]\n- Supports arrays, enums, JSON and UUID. [[more info](https://bokwoon.neocities.org/sq.html#arrays-enums-json-uuid)]\n- Query logging. [[more info](https://bokwoon.neocities.org/sq.html#logging)]\n\n# Installation\n\nThis package only supports Go 1.19 and above.\n\n```shell\n$ go get github.com/bokwoon95/sq\n$ go install -tags=fts5 github.com/bokwoon95/sqddl@latest\n```\n\n# Features\n\n- IN\n - [In Slice](https://bokwoon.neocities.org/sq.html#in-slice) - `a IN (1, 2, 3)`\n - [In RowValues](https://bokwoon.neocities.org/sq.html#in-rowvalues) - `(a, b, c) IN ((1, 2, 3), (4, 5, 6), (7, 8, 9))`\n - [In Subquery](https://bokwoon.neocities.org/sq.html#in-subquery) - `(a, b) IN (SELECT a, b FROM tbl WHERE condition)`\n- CASE\n - [Predicate Case](https://bokwoon.neocities.org/sq.html#predicate-case) - `CASE WHEN a THEN b WHEN c THEN d ELSE e END`\n - [Simple case](https://bokwoon.neocities.org/sq.html#simple-case) - `CASE expr WHEN a THEN b WHEN c THEN d ELSE e END`\n- EXISTS\n - [Where Exists](https://bokwoon.neocities.org/sq.html#where-exists)\n - [Where Not Exists](https://bokwoon.neocities.org/sq.html#where-not-exists)\n - [Select Exists](https://bokwoon.neocities.org/sq.html#querybuilder-fetch-exists)\n- [Subqueries](https://bokwoon.neocities.org/sq.html#subqueries)\n- [WITH (Common Table Expressions)](https://bokwoon.neocities.org/sq.html#common-table-expressions)\n- [Aggregate functions](https://bokwoon.neocities.org/sq.html#aggregate-functions)\n- [Window functions](https://bokwoon.neocities.org/sq.html#window-functions)\n- [UNION, INTERSECT, EXCEPT](https://bokwoon.neocities.org/sq.html#union-intersect-except)\n- [INSERT from SELECT](https://bokwoon.neocities.org/sq.html#querybuilder-insert-from-select)\n- RETURNING\n - [SQLite RETURNING](https://bokwoon.neocities.org/sq.html#sqlite-returning)\n - [Postgres RETURNING](https://bokwoon.neocities.org/sq.html#postgres-returning)\n- LastInsertId\n - [SQLite LastInsertId](https://bokwoon.neocities.org/sq.html#sqlite-last-insert-id)\n - [MySQL LastInsertId](https://bokwoon.neocities.org/sq.html#mysql-last-insert-id)\n- Insert ignore duplicates\n - [SQLite Insert ignore duplicates](https://bokwoon.neocities.org/sq.html#sqlite-insert-ignore-duplicates)\n - [Postgres Insert ignore duplicates](https://bokwoon.neocities.org/sq.html#postgres-insert-ignore-duplicates)\n - [MySQL Insert ignore duplicates](https://bokwoon.neocities.org/sq.html#mysql-insert-ignore-duplicates)\n - [SQL Server Insert ignore duplicates](https://bokwoon.neocities.org/sq.html#sqlserver-insert-ignore-duplicates)\n- Upsert\n - [SQLite Upsert](https://bokwoon.neocities.org/sq.html#sqlite-upsert)\n - [Postgres Upsert](https://bokwoon.neocities.org/sq.html#postgres-upsert)\n - [MySQL Upsert](https://bokwoon.neocities.org/sq.html#mysql-upsert)\n - [SQL Server Upsert](https://bokwoon.neocities.org/sq.html#sqlserver-upsert)\n- Update with Join\n - [SQLite Update with Join](https://bokwoon.neocities.org/sq.html#sqlite-update-with-join)\n - [Postgres Update with Join](https://bokwoon.neocities.org/sq.html#postgres-update-with-join)\n - [MySQL Update with Join](https://bokwoon.neocities.org/sq.html#mysql-update-with-join)\n - [SQL Server Update with Join](https://bokwoon.neocities.org/sq.html#sqlserver-update-with-join)\n- Delete with Join\n - [SQLite Delete with Join](https://bokwoon.neocities.org/sq.html#sqlite-delete-with-join)\n - [Postgres Delete with Join](https://bokwoon.neocities.org/sq.html#postgres-delete-with-join)\n - [MySQL Delete with Join](https://bokwoon.neocities.org/sq.html#mysql-delete-with-join)\n - [SQL Server Delete with Join](https://bokwoon.neocities.org/sq.html#sqlserver-delete-with-join)\n- Bulk Update\n - [SQLite Bulk Update](https://bokwoon.neocities.org/sq.html#sqlite-bulk-update)\n - [Postgres Bulk Update](https://bokwoon.neocities.org/sq.html#postgres-bulk-update)\n - [MySQL Bulk Update](https://bokwoon.neocities.org/sq.html#mysql-bulk-update)\n - [SQL Server Bulk Update](https://bokwoon.neocities.org/sq.html#sqlserver-bulk-update)\n\n## SELECT example (Raw SQL)\n\n```go\ndb, err := sql.Open(\"postgres\", \"postgres://username:password@localhost:5432/sakila?sslmode=disable\")\n\nactors, err := sq.FetchAll(db, sq.\n Queryf(\"SELECT {*} FROM actor AS a WHERE a.actor_id IN ({})\",\n []int{1, 2, 3, 4, 5},\n ).\n SetDialect(sq.DialectPostgres),\n func(row *sq.Row) Actor {\n return Actor{\n ActorID: row.Int(\"a.actor_id\"),\n FirstName: row.String(\"a.first_name\"),\n LastName: row.String(\"a.last_name\"),\n LastUpdate: row.Time(\"a.last_update\"),\n }\n },\n)\n```\n\n## SELECT example (Query Builder)\n\nTo use the query builder, you must first [define your table structs](https://bokwoon.neocities.org/sq.html#table-structs).\n\n```go\ntype ACTOR struct {\n sq.TableStruct\n ACTOR_ID sq.NumberField\n FIRST_NAME sq.StringField\n LAST_NAME sq.StringField\n LAST_UPDATE sq.TimeField\n}\n\ndb, err := sql.Open(\"postgres\", \"postgres://username:password@localhost:5432/sakila?sslmode=disable\")\n\na := sq.New[ACTOR](\"a\")\nactors, err := sq.FetchAll(db, sq.\n From(a).\n Where(a.ACTOR_ID.In([]int{1, 2, 3, 4, 5})).\n SetDialect(sq.DialectPostgres),\n func(row *sq.Row) Actor {\n return Actor{\n ActorID: row.IntField(a.ACTOR_ID),\n FirstName: row.StringField(a.FIRST_NAME),\n LastName: row.StringField(a.LAST_NAME),\n LastUpdate: row.TimeField(a.LAST_UPDATE),\n }\n },\n)\n```\n\n## INSERT example (Raw SQL)\n\n```go\ndb, err := sql.Open(\"postgres\", \"postgres://username:password@localhost:5432/sakila?sslmode=disable\")\n\n_, err := sq.Exec(db, sq.\n Queryf(\"INSERT INTO actor (actor_id, first_name, last_name) VALUES {}\", sq.RowValues{\n {18, \"DAN\", \"TORN\"},\n {56, \"DAN\", \"HARRIS\"},\n {166, \"DAN\", \"STREEP\"},\n }).\n SetDialect(sq.DialectPostgres),\n)\n```\n\n## INSERT example (Query Builder)\n\nTo use the query builder, you must first [define your table structs](https://bokwoon.neocities.org/sq.html#table-structs).\n\n```go\ntype ACTOR struct {\n sq.TableStruct\n ACTOR_ID sq.NumberField\n FIRST_NAME sq.StringField\n LAST_NAME sq.StringField\n LAST_UPDATE sq.TimeField\n}\n\ndb, err := sql.Open(\"postgres\", \"postgres://username:password@localhost:5432/sakila?sslmode=disable\")\n\na := sq.New[ACTOR](\"a\")\n_, err := sq.Exec(db, sq.\n InsertInto(a).\n Columns(a.ACTOR_ID, a.FIRST_NAME, a.LAST_NAME).\n Values(18, \"DAN\", \"TORN\").\n Values(56, \"DAN\", \"HARRIS\").\n Values(166, \"DAN\", \"STREEP\").\n SetDialect(sq.DialectPostgres),\n)\n```\n\nFor a more detailed overview, look at the [Quickstart](https://bokwoon.neocities.org/sq.html#quickstart).\n\n## Project Status\n\nsq is done for my use case (hence it may seem inactive, but it's just complete). At this point I'm just waiting for people to ask questions or file feature requests under [discussions](https://github.com/bokwoon95/sq/discussions).\n\n## Contributing\n\nSee [START\\_HERE.md](https://github.com/bokwoon95/sq/blob/main/START_HERE.md).\n"
},
{
"path": "START_HERE.md",
"content": "This document describes how the codebase is organized. It is meant for people who are contributing to the codebase (or are just casually browsing).\n\nFiles are written in such a way that **each successive file in the list below only depends on files that come before it**. This self-enforced restriction makes deep architectural changes trivial because you can essentially blow away the entire codebase and rewrite it from scratch file-by-file, complete with working tests every step of the way. Please adhere to this file order when submitting pull requests.\n\n- [**sq.go**](https://github.com/bokwoon95/sq/blob/main/sq.go)\n - Core interfaces: SQLWriter, DB, Query, Table, PolicyTable, Window, Field, Predicate, Assignment, Any, Array, Binary, Boolean, Enum, JSON, Number, String, UUID, Time, Enumeration, DialectValuer,\n - Data types: Result, TableStruct, ViewStruct.\n - Misc utility functions.\n- [**fmt.go**](https://github.com/bokwoon95/sq/blob/main/fmt.go)\n - Two important string building functions that everything else is built on: [Writef](https://pkg.go.dev/github.com/bokwoon95/sq#Writef) and [WriteValue](https://pkg.go.dev/github.com/bokwoon95/sq#WriteValue).\n - Data types: Parameter, BinaryParameter, BooleanParameter, NumberParameter, StringParameter, TimeParameter.\n - Utility functions: QuoteIdentifier, EscapeQuote, Sprintf, Sprint.\n- [**builtins.go**](https://github.com/bokwoon95/sq/blob/main/builtins.go)\n - Builtin data types that are built on top of Writef and WriteValue: Expression (Expr), CustomQuery (Queryf), VariadicPredicate, assignment, RowValue, RowValues, Fields.\n - Builtin functions that are built on top of Writef and WriteValue: Eq, Ne, Lt, Le, Gt, Ge, Exists, NotExists, In.\n- [**fields.go**](https://github.com/bokwoon95/sq/blob/main/fields.go)\n - All of the field types: AnyField, ArrayField, BinaryField, BooleanField, EnumField, JSONField, NumberField, StringField, UUIDField, TimeField.\n - Data types: Identifier, Timestamp.\n - Functions: [New](https://pkg.go.dev/github.com/bokwoon95/sq#New), ArrayValue, EnumValue, JSONValue, UUIDValue.\n- [**cte.go**](https://github.com/bokwoon95/sq/blob/main/cte.go)\n - CTE represents an SQL common table expression (CTE).\n - UNION, INTERSECT, EXCEPT.\n- [**joins.go**](https://github.com/bokwoon95/sq/blob/main/joins.go)\n - The various SQL joins.\n- [**row_column.go**](https://github.com/bokwoon95/sq/blob/main/row_column.go)\n - Row and Column methods.\n- [**window.go**](https://github.com/bokwoon95/sq/blob/main/window.go)\n - SQL windows and window functions.\n- [**select_query.go**](https://github.com/bokwoon95/sq/blob/main/select_query.go)\n - SQL SELECT query builder.\n- [**insert_query.go**](https://github.com/bokwoon95/sq/blob/main/insert_query.go)\n - SQL INSERT query builder.\n- [**update_query.go**](https://github.com/bokwoon95/sq/blob/main/update_query.go)\n - SQL UPDATE query builder.\n- [**delete_query.go**](https://github.com/bokwoon95/sq/blob/main/delete_query.go)\n - SQL DELETE query builder.\n- [**logger.go**](https://github.com/bokwoon95/sq/blob/main/logger.go)\n - sq.Log and sq.VerboseLog.\n- [**fetch_exec.go**](https://github.com/bokwoon95/sq/blob/main/fetch_exec.go)\n - FetchCursor, FetchOne, FetchAll, Exec.\n - CompiledFetch, CompiledExec.\n - PreparedFetch, PreparedExec.\n- [**misc.go**](https://github.com/bokwoon95/sq/blob/main/misc.go)\n - Misc SQL constructs.\n - ValueExpression, LiteralValue, DialectExpression, CaseExpression, SimpleCaseExpression.\n - SelectValues (`SELECT ... UNION ALL SELECT ... UNION ALL SELECT ...`)\n - TableValues (`VALUES (...), (...), (...)`).\n- [**integration_test.go**](https://github.com/bokwoon95/sq/blob/main/integration_test.go)\n - Tests that interact with a live database i.e. SQLite, Postgres, MySQL and SQL Server.\n\n## Testing\n\nAdd tests if you add code.\n\nTo run tests, use:\n\n```shell\n$ go test . # -failfast -shuffle=on -coverprofile=coverage\n```\n\nThere are tests that require a live database connection. They will only run if you provide the corresponding database URL in the test flags:\n\n```shell\n$ go test . -postgres $POSTGRES_URL -mysql $MYSQL_URL -sqlserver $SQLSERVER_URL # -failfast -shuffle=on -coverprofile=coverage\n```\n\nYou can consider using the [docker-compose.yml defined in the sqddl repo](https://github.com/bokwoon95/sqddl/blob/main/docker-compose.yml) to spin up Postgres, MySQL and SQL Server databases that are reachable at the following URLs:\n\n```shell\n# docker-compose up -d\nPOSTGRES_URL='postgres://user1:Hunter2!@localhost:5456/sakila?sslmode=disable'\nMYSQL_URL='root:Hunter2!@tcp(localhost:3330)/sakila?multiStatements=true&parseTime=true'\nMARIADB_URL='root:Hunter2!@tcp(localhost:3340)/sakila?multiStatements=true&parseTime=true'\nSQLSERVER_URL='sqlserver://sa:Hunter2!@localhost:1447'\n```\n\n## Documentation\n\nDocumentation is contained entirely within [sq.md](https://github.com/bokwoon95/sq/blob/main/sq.md) in the project root directory. You can view the output at [https://bokwoon.neocities.org/sq.html](https://bokwoon.neocities.org/sq.html). The documentation is regenerated everytime a new commit is pushed to the main branch, so to change the documentation just change sq.md and submit a pull request.\n\nYou can preview the output of sq.md locally by installing [github.com/bokwoon95/mddocs](https://github.com/bokwoon95/mddocs) and running it with sq.md as the argument.\n\n```shell\n$ go install github/bokwoon95/mddocs@latest\n$ mddocs\nUsage:\nmddocs project.md # serves project.md on a localhost connection\nmddocs project.md project.html # render project.md into project.html\n\n$ mddocs sq.md\nserving sq.md at localhost:6060\n```\n\nTo add a new section and register it in the table of contents, append a `#headerID` to the end of a header (replace `headerID` with the actual header ID). The header ID should only contain unicode letters, digits, hyphen `-` and underscore `_`.\n\n```text\n## This is a header.\n\n## This is a header with a headerID. #header-id <-- added to table of contents\n```\n"
},
{
"path": "builtins.go",
"content": "package sq\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"strings\"\n)\n\n// Expression is an SQL expression that satisfies the Table, Field, Predicate,\n// Binary, Boolean, Number, String and Time interfaces.\ntype Expression struct {\n\tformat string\n\tvalues []any\n\talias string\n}\n\nvar _ interface {\n\tTable\n\tField\n\tPredicate\n\tAny\n\tAssignment\n} = (*Expression)(nil)\n\n// Expr creates a new Expression using Writef syntax.\nfunc Expr(format string, values ...any) Expression {\n\treturn Expression{format: format, values: values}\n}\n\n// WriteSQL implements the SQLWriter interface.\nfunc (expr Expression) WriteSQL(ctx context.Context, dialect string, buf *bytes.Buffer, args *[]any, params map[string][]int) error {\n\terr := Writef(ctx, dialect, buf, args, params, expr.format, expr.values)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\n// As returns a new Expression with the given alias.\nfunc (expr Expression) As(alias string) Expression {\n\texpr.alias = alias\n\treturn expr\n}\n\n// In returns an 'expr IN (value)' Predicate.\nfunc (expr Expression) In(value any) Predicate { return In(expr, value) }\n\n// In returns an 'expr NOT IN (value)' Predicate.\nfunc (expr Expression) NotIn(value any) Predicate { return NotIn(expr, value) }\n\n// Eq returns an 'expr = value' Predicate.\nfunc (expr Expression) Eq(value any) Predicate { return cmp(\"=\", expr, value) }\n\n// Ne returns an 'expr <> value' Predicate.\nfunc (expr Expression) Ne(value any) Predicate { return cmp(\"<>\", expr, value) }\n\n// Lt returns an 'expr < value' Predicate.\nfunc (expr Expression) Lt(value any) Predicate { return cmp(\"<\", expr, value) }\n\n// Le returns an 'expr <= value' Predicate.\nfunc (expr Expression) Le(value any) Predicate { return cmp(\"<=\", expr, value) }\n\n// Gt returns an 'expr > value' Predicate.\nfunc (expr Expression) Gt(value any) Predicate { return cmp(\">\", expr, value) }\n\n// Ge returns an 'expr >= value' Predicate.\nfunc (expr Expression) Ge(value any) Predicate { return cmp(\">=\", expr, value) }\n\n// GetAlias returns the alias of the Expression.\nfunc (expr Expression) GetAlias() string { return expr.alias }\n\n// IsTable implements the Table interface.\nfunc (expr Expression) IsTable() {}\n\n// IsField implements the Field interface.\nfunc (expr Expression) IsField() {}\n\n// IsArray implements the Array interface.\nfunc (expr Expression) IsArray() {}\n\n// IsBinary implements the Binary interface.\nfunc (expr Expression) IsBinary() {}\n\n// IsBoolean implements the Boolean interface.\nfunc (expr Expression) IsBoolean() {}\n\n// IsEnum implements the Enum interface.\nfunc (expr Expression) IsEnum() {}\n\n// IsJSON implements the JSON interface.\nfunc (expr Expression) IsJSON() {}\n\n// IsNumber implements the Number interface.\nfunc (expr Expression) IsNumber() {}\n\n// IsString implements the String interface.\nfunc (expr Expression) IsString() {}\n\n// IsTime implements the Time interface.\nfunc (expr Expression) IsTime() {}\n\n// IsUUID implements the UUID interface.\nfunc (expr Expression) IsUUID() {}\n\nfunc (e Expression) IsAssignment() {}\n\n// CustomQuery represents a user-defined query.\ntype CustomQuery struct {\n\tDialect string\n\tFormat string\n\tValues []any\n\tfields []Field\n}\n\nvar _ Query = (*CustomQuery)(nil)\n\n// Queryf creates a new query using Writef syntax.\nfunc Queryf(format string, values ...any) CustomQuery {\n\treturn CustomQuery{Format: format, Values: values}\n}\n\n// Queryf creates a new SQLite query using Writef syntax.\nfunc (b sqliteQueryBuilder) Queryf(format string, values ...any) CustomQuery {\n\treturn CustomQuery{Dialect: DialectSQLite, Format: format, Values: values}\n}\n\n// Queryf creates a new Postgres query using Writef syntax.\nfunc (b postgresQueryBuilder) Queryf(format string, values ...any) CustomQuery {\n\treturn CustomQuery{Dialect: DialectPostgres, Format: format, Values: values}\n}\n\n// Queryf creates a new MySQL query using Writef syntax.\nfunc (b mysqlQueryBuilder) Queryf(format string, values ...any) CustomQuery {\n\treturn CustomQuery{Dialect: DialectMySQL, Format: format, Values: values}\n}\n\n// Queryf creates a new SQL Server query using Writef syntax.\nfunc (b sqlserverQueryBuilder) Queryf(format string, values ...any) CustomQuery {\n\treturn CustomQuery{Dialect: DialectSQLServer, Format: format, Values: values}\n}\n\n// Append returns a new CustomQuery with the format string and values slice\n// appended to the current CustomQuery.\nfunc (q CustomQuery) Append(format string, values ...any) CustomQuery {\n\tq.Format += \" \" + format\n\tq.Values = append(q.Values, values...)\n\treturn q\n}\n\n// WriteSQL implements the SQLWriter interface.\nfunc (q CustomQuery) WriteSQL(ctx context.Context, dialect string, buf *bytes.Buffer, args *[]any, params map[string][]int) error {\n\tvar err error\n\tformat := q.Format\n\tsplitAt := -1\n\tfor i := strings.IndexByte(format, '{'); i >= 0; i = strings.IndexByte(format, '{') {\n\t\tif i+2 <= len(format) && format[i:i+2] == \"{{\" {\n\t\t\tformat = format[i+2:]\n\t\t\tcontinue\n\t\t}\n\t\tif i+3 <= len(format) && format[i:i+3] == \"{*}\" {\n\t\t\tsplitAt = len(q.Format) - len(format[i:])\n\t\t\tbreak\n\t\t}\n\t\tformat = format[i+1:]\n\t}\n\tif splitAt < 0 {\n\t\treturn Writef(ctx, dialect, buf, args, params, q.Format, q.Values)\n\t}\n\trunningValuesIndex := 0\n\tordinalIndices := make(map[int]int)\n\terr = writef(ctx, dialect, buf, args, params, q.Format[:splitAt], q.Values, &runningValuesIndex, ordinalIndices)\n\tif err != nil {\n\t\treturn err\n\t}\n\terr = writeFields(ctx, dialect, buf, args, params, q.fields, true)\n\tif err != nil {\n\t\treturn err\n\t}\n\terr = writef(ctx, dialect, buf, args, params, q.Format[splitAt+3:], q.Values, &runningValuesIndex, ordinalIndices)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\n// SetFetchableFields sets the fetchable fields of the query.\nfunc (q CustomQuery) SetFetchableFields(fields []Field) (query Query, ok bool) {\n\tformat := q.Format\n\tfor i := strings.IndexByte(format, '{'); i >= 0; i = strings.IndexByte(format, '{') {\n\t\tif i+2 <= len(format) && format[i:i+2] == \"{{\" {\n\t\t\tformat = format[i+2:]\n\t\t\tcontinue\n\t\t}\n\t\tif i+3 <= len(format) && format[i:i+3] == \"{*}\" {\n\t\t\tq.fields = fields\n\t\t\treturn q, true\n\t\t}\n\t\tformat = format[i+1:]\n\t}\n\treturn q, false\n}\n\n// GetFetchableFields gets the fetchable fields of the query.\nfunc (q CustomQuery) GetFetchableFields() []Field {\n\treturn q.fields\n}\n\n// GetDialect gets the dialect of the query.\nfunc (q CustomQuery) GetDialect() string { return q.Dialect }\n\n// SetDialect sets the dialect of the query.\nfunc (q CustomQuery) SetDialect(dialect string) CustomQuery {\n\tq.Dialect = dialect\n\treturn q\n}\n\n// VariadicPredicate represents the 'x AND y AND z...' or 'x OR Y OR z...' SQL\n// construct.\ntype VariadicPredicate struct {\n\t// Toplevel indicates if the VariadicPredicate can skip writing the\n\t// (surrounding brackets).\n\tToplevel bool\n\talias string\n\t// If IsDisjunction is true, the Predicates are joined using OR. If false,\n\t// the Predicates are joined using AND. The default is AND.\n\tIsDisjunction bool\n\t// Predicates holds the predicates inside the VariadicPredicate\n\tPredicates []Predicate\n}\n\nvar _ Predicate = (*VariadicPredicate)(nil)\n\n// And joins the predicates together with the AND operator.\nfunc And(predicates ...Predicate) VariadicPredicate {\n\treturn VariadicPredicate{IsDisjunction: false, Predicates: predicates}\n}\n\n// Or joins the predicates together with the OR operator.\nfunc Or(predicates ...Predicate) VariadicPredicate {\n\treturn VariadicPredicate{IsDisjunction: true, Predicates: predicates}\n}\n\n// WriteSQL implements the SQLWriter interface.\nfunc (p VariadicPredicate) WriteSQL(ctx context.Context, dialect string, buf *bytes.Buffer, args *[]any, params map[string][]int) error {\n\tvar err error\n\tif len(p.Predicates) == 0 {\n\t\treturn fmt.Errorf(\"VariadicPredicate empty\")\n\t}\n\n\tif len(p.Predicates) == 1 {\n\t\tswitch p1 := p.Predicates[0].(type) {\n\t\tcase nil:\n\t\t\treturn fmt.Errorf(\"predicate #1 is nil\")\n\t\tcase VariadicPredicate:\n\t\t\tp1.Toplevel = p.Toplevel\n\t\t\terr = p1.WriteSQL(ctx, dialect, buf, args, params)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\tdefault:\n\t\t\terr = p.Predicates[0].WriteSQL(ctx, dialect, buf, args, params)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\treturn nil\n\t}\n\n\tif !p.Toplevel {\n\t\tbuf.WriteString(\"(\")\n\t}\n\tfor i, predicate := range p.Predicates {\n\t\tif i > 0 {\n\t\t\tif p.IsDisjunction {\n\t\t\t\tbuf.WriteString(\" OR \")\n\t\t\t} else {\n\t\t\t\tbuf.WriteString(\" AND \")\n\t\t\t}\n\t\t}\n\t\tswitch predicate := predicate.(type) {\n\t\tcase nil:\n\t\t\treturn fmt.Errorf(\"predicate #%d is nil\", i+1)\n\t\tcase VariadicPredicate:\n\t\t\tpredicate.Toplevel = false\n\t\t\terr = predicate.WriteSQL(ctx, dialect, buf, args, params)\n\t\t\tif err != nil {\n\t\t\t\treturn fmt.Errorf(\"predicate #%d: %w\", i+1, err)\n\t\t\t}\n\t\tdefault:\n\t\t\terr = predicate.WriteSQL(ctx, dialect, buf, args, params)\n\t\t\tif err != nil {\n\t\t\t\treturn fmt.Errorf(\"predicate #%d: %w\", i+1, err)\n\t\t\t}\n\t\t}\n\t}\n\tif !p.Toplevel {\n\t\tbuf.WriteString(\")\")\n\t}\n\treturn nil\n}\n\n// As returns a new VariadicPredicate with the given alias.\nfunc (p VariadicPredicate) As(alias string) VariadicPredicate {\n\tp.alias = alias\n\treturn p\n}\n\n// GetAlias returns the alias of the VariadicPredicate.\nfunc (p VariadicPredicate) GetAlias() string { return p.alias }\n\n// IsField implements the Field interface.\nfunc (p VariadicPredicate) IsField() {}\n\n// IsBooleanType implements the Predicate interface.\nfunc (p VariadicPredicate) IsBoolean() {}\n\n// assignment represents assigning a value to a Field.\ntype assignment struct {\n\tfield Field\n\tvalue any\n}\n\nvar _ Assignment = (*assignment)(nil)\n\n// Set creates a new Assignment assigning the value to a field.\nfunc Set(field Field, value any) Assignment {\n\treturn assignment{field: field, value: value}\n}\n\n// Setf creates a new Assignment assigning a custom expression to a Field.\nfunc Setf(field Field, format string, values ...any) Assignment {\n\treturn assignment{field: field, value: Expr(format, values...)}\n}\n\n// WriteSQL implements the SQLWriter interface.\nfunc (a assignment) WriteSQL(ctx context.Context, dialect string, buf *bytes.Buffer, args *[]any, params map[string][]int) error {\n\tif a.field == nil {\n\t\treturn fmt.Errorf(\"field is nil\")\n\t}\n\tvar err error\n\tif dialect == DialectMySQL {\n\t\terr = a.field.WriteSQL(ctx, dialect, buf, args, params)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t} else {\n\t\terr = withPrefix(a.field, \"\").WriteSQL(ctx, dialect, buf, args, params)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tbuf.WriteString(\" = \")\n\t_, isQuery := a.value.(Query)\n\tif isQuery {\n\t\tbuf.WriteString(\"(\")\n\t}\n\terr = WriteValue(ctx, dialect, buf, args, params, a.value)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif isQuery {\n\t\tbuf.WriteString(\")\")\n\t}\n\treturn nil\n}\n\n// IsAssignment implements the Assignment interface.\nfunc (a assignment) IsAssignment() {}\n\n// Assignments represents a list of Assignments e.g. x = 1, y = 2, z = 3.\ntype Assignments []Assignment\n\n// WriteSQL implements the SQLWriter interface.\nfunc (as Assignments) WriteSQL(ctx context.Context, dialect string, buf *bytes.Buffer, args *[]any, params map[string][]int) error {\n\tvar err error\n\tfor i, assignment := range as {\n\t\tif assignment == nil {\n\t\t\treturn fmt.Errorf(\"assignment #%d is nil\", i+1)\n\t\t}\n\t\tif i > 0 {\n\t\t\tbuf.WriteString(\", \")\n\t\t}\n\t\terr = assignment.WriteSQL(ctx, dialect, buf, args, params)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"assignment #%d: %w\", i+1, err)\n\t\t}\n\t}\n\treturn nil\n}\n\n// RowValue represents an SQL row value expression e.g. (x, y, z).\ntype RowValue []any\n\n// WriteSQL implements the SQLWriter interface.\nfunc (r RowValue) WriteSQL(ctx context.Context, dialect string, buf *bytes.Buffer, args *[]any, params map[string][]int) error {\n\tbuf.WriteString(\"(\")\n\tvar err error\n\tfor i, value := range r {\n\t\tif i > 0 {\n\t\t\tbuf.WriteString(\", \")\n\t\t}\n\t\t_, isQuery := value.(Query)\n\t\tif isQuery {\n\t\t\tbuf.WriteString(\"(\")\n\t\t}\n\t\terr = WriteValue(ctx, dialect, buf, args, params, value)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"rowvalue #%d: %w\", i+1, err)\n\t\t}\n\t\tif isQuery {\n\t\t\tbuf.WriteString(\")\")\n\t\t}\n\t}\n\tbuf.WriteString(\")\")\n\treturn nil\n}\n\n// In returns an 'rowvalue IN (value)' Predicate.\nfunc (r RowValue) In(v any) Predicate { return In(r, v) }\n\n// NotIn returns an 'rowvalue NOT IN (value)' Predicate.\nfunc (r RowValue) NotIn(v any) Predicate { return NotIn(r, v) }\n\n// Eq returns an 'rowvalue = value' Predicate.\nfunc (r RowValue) Eq(v any) Predicate { return cmp(\"=\", r, v) }\n\n// RowValues represents a list of RowValues e.g. (x, y, z), (a, b, c).\ntype RowValues []RowValue\n\n// WriteSQL implements the SQLWriter interface.\nfunc (rs RowValues) WriteSQL(ctx context.Context, dialect string, buf *bytes.Buffer, args *[]any, params map[string][]int) error {\n\tvar err error\n\tfor i, r := range rs {\n\t\tif i > 0 {\n\t\t\tbuf.WriteString(\", \")\n\t\t}\n\t\terr = r.WriteSQL(ctx, dialect, buf, args, params)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"rowvalues #%d: %w\", i+1, err)\n\t\t}\n\t}\n\treturn nil\n}\n\n// Fields represents a list of Fields e.g. tbl.field1, tbl.field2, tbl.field3.\ntype Fields []Field\n\n// WriteSQL implements the SQLWriter interface.\nfunc (fs Fields) WriteSQL(ctx context.Context, dialect string, buf *bytes.Buffer, args *[]any, params map[string][]int) error {\n\tvar err error\n\tfor i, field := range fs {\n\t\tif field == nil {\n\t\t\treturn fmt.Errorf(\"field #%d is nil\", i+1)\n\t\t}\n\t\tif i > 0 {\n\t\t\tbuf.WriteString(\", \")\n\t\t}\n\t\t_, isQuery := field.(Query)\n\t\tif isQuery {\n\t\t\tbuf.WriteString(\"(\")\n\t\t}\n\t\terr = field.WriteSQL(ctx, dialect, buf, args, params)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"field #%d: %w\", i+1, err)\n\t\t}\n\t\tif isQuery {\n\t\t\tbuf.WriteString(\")\")\n\t\t}\n\t}\n\treturn nil\n}\n\ntype (\n\tsqliteQueryBuilder struct{ ctes []CTE }\n\tpostgresQueryBuilder struct{ ctes []CTE }\n\tmysqlQueryBuilder struct{ ctes []CTE }\n\tsqlserverQueryBuilder struct{ ctes []CTE }\n)\n\n// Dialect-specific query builder variables.\nvar (\n\tSQLite sqliteQueryBuilder\n\tPostgres postgresQueryBuilder\n\tMySQL mysqlQueryBuilder\n\tSQLServer sqlserverQueryBuilder\n)\n\n// With sets the CTEs in the SQLiteQueryBuilder.\nfunc (b sqliteQueryBuilder) With(ctes ...CTE) sqliteQueryBuilder {\n\tb.ctes = ctes\n\treturn b\n}\n\n// With sets the CTEs in the PostgresQueryBuilder.\nfunc (b postgresQueryBuilder) With(ctes ...CTE) postgresQueryBuilder {\n\tb.ctes = ctes\n\treturn b\n}\n\n// With sets the CTEs in the MySQLQueryBuilder.\nfunc (b mysqlQueryBuilder) With(ctes ...CTE) mysqlQueryBuilder {\n\tb.ctes = ctes\n\treturn b\n}\n\n// With sets the CTEs in the SQLServerQueryBuilder.\nfunc (b sqlserverQueryBuilder) With(ctes ...CTE) sqlserverQueryBuilder {\n\tb.ctes = ctes\n\treturn b\n}\n\n// ToSQL converts an SQLWriter into a query string and args slice.\n//\n// The params map is used to hold the mappings between named parameters in the\n// query to the corresponding index in the args slice and is used for rebinding\n// args by their parameter name. If you don't need to track this, you can pass\n// in a nil map.\nfunc ToSQL(dialect string, w SQLWriter, params map[string][]int) (query string, args []any, err error) {\n\treturn ToSQLContext(context.Background(), dialect, w, params)\n}\n\n// ToSQLContext is like ToSQL but additionally requires a context.Context.\nfunc ToSQLContext(ctx context.Context, dialect string, w SQLWriter, params map[string][]int) (query string, args []any, err error) {\n\tif w == nil {\n\t\treturn \"\", nil, fmt.Errorf(\"SQLWriter is nil\")\n\t}\n\tif dialect == \"\" {\n\t\tif q, ok := w.(Query); ok {\n\t\t\tdialect = q.GetDialect()\n\t\t}\n\t}\n\tbuf := bufpool.Get().(*bytes.Buffer)\n\tbuf.Reset()\n\tdefer bufpool.Put(buf)\n\terr = w.WriteSQL(ctx, dialect, buf, &args, params)\n\tquery = buf.String()\n\tif err != nil {\n\t\treturn query, args, err\n\t}\n\treturn query, args, nil\n}\n\n// Eq returns an 'x = y' Predicate.\nfunc Eq(x, y any) Predicate { return cmp(\"=\", x, y) }\n\n// Ne returns an 'x <> y' Predicate.\nfunc Ne(x, y any) Predicate { return cmp(\"<>\", x, y) }\n\n// Lt returns an 'x < y' Predicate.\nfunc Lt(x, y any) Predicate { return cmp(\"<\", x, y) }\n\n// Le returns an 'x <= y' Predicate.\nfunc Le(x, y any) Predicate { return cmp(\"<=\", x, y) }\n\n// Gt returns an 'x > y' Predicate.\nfunc Gt(x, y any) Predicate { return cmp(\">\", x, y) }\n\n// Ge returns an 'x >= y' Predicate.\nfunc Ge(x, y any) Predicate { return cmp(\">=\", x, y) }\n\n// Exists returns an 'EXISTS (query)' Predicate.\nfunc Exists(query Query) Predicate { return Expr(\"EXISTS ({})\", query) }\n\n// NotExists returns a 'NOT EXISTS (query)' Predicate.\nfunc NotExists(query Query) Predicate { return Expr(\"NOT EXISTS ({})\", query) }\n\n// In returns an 'x IN (y)' Predicate.\nfunc In(x, y any) Predicate {\n\t_, isQueryA := x.(Query)\n\t_, isRowValueB := y.(RowValue)\n\tif !isQueryA && !isRowValueB {\n\t\treturn Expr(\"{} IN ({})\", x, y)\n\t} else if !isQueryA && isRowValueB {\n\t\treturn Expr(\"{} IN {}\", x, y)\n\t} else if isQueryA && !isRowValueB {\n\t\treturn Expr(\"({}) IN ({})\", x, y)\n\t} else {\n\t\treturn Expr(\"({}) IN {}\", x, y)\n\t}\n}\n\n// NotIn returns an 'x NOT IN (y)' Predicate.\nfunc NotIn(x, y any) Predicate {\n\t_, isQueryA := x.(Query)\n\t_, isRowValueB := y.(RowValue)\n\tif !isQueryA && !isRowValueB {\n\t\treturn Expr(\"{} NOT IN ({})\", x, y)\n\t} else if !isQueryA && isRowValueB {\n\t\treturn Expr(\"{} NOT IN {}\", x, y)\n\t} else if isQueryA && !isRowValueB {\n\t\treturn Expr(\"({}) NOT IN ({})\", x, y)\n\t} else {\n\t\treturn Expr(\"({}) NOT IN {}\", x, y)\n\t}\n}\n\n// cmp returns an 'x ![\"code](\"https://i.imgur.com/GAxInSb.png\" "\\"code")
\n