Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var (
Dialect dialect
)
Functions ¶
This section is empty.
Types ¶
type DeleteModApply ¶
type DeleteModApply = sq.QueryModApply[tag.DeleteTag]
type DeleteQuery ¶
func Delete ¶
func Delete(mods ...DeleteMod) DeleteQuery
func DeleteRaw ¶ added in v0.8.1
func DeleteRaw(rawQuery string, args ...any) DeleteQuery
func DeleteRawExpr ¶ added in v0.8.1
func DeleteRawExpr(e litsql.Expression) DeleteQuery
type InsertModApply ¶
type InsertModApply = sq.QueryModApply[tag.InsertTag]
type InsertQuery ¶
func Insert ¶
func Insert(mods ...InsertMod) InsertQuery
func InsertRaw ¶ added in v0.8.1
func InsertRaw(rawQuery string, args ...any) InsertQuery
func InsertRawExpr ¶ added in v0.8.1
func InsertRawExpr(e litsql.Expression) InsertQuery
type SelectModApply ¶
type SelectModApply = sq.QueryModApply[tag.SelectTag]
type SelectQuery ¶
func Select ¶
func Select(mods ...SelectMod) SelectQuery
Example (LiteralJoin) ¶
package main
import (
"fmt"
"github.com/rrgmc/litsql/dialect/psql"
"github.com/rrgmc/litsql/dialect/psql/sm"
"github.com/rrgmc/litsql/expr"
)
func main() {
// SELECT
q := psql.Select(
// orders.id as order_id, orders.date
sm.Columns("orders.id AS order_id", "orders.date"),
// u.id AS user_id, u.name as user_name
sm.Columns("u.id AS user_id", "u.name AS user_name"),
// FROM orders
sm.From("orders"),
// INNER JOIN users AS u ON orders.user_id = u.id
sm.InnerJoin("users AS u").On("orders.user_id = u.id"),
// WHERE u.age > $1
sm.WhereClause("u.age ?",
// example to use either IS NULL or a comparison
expr.IfElse(true, // some condition
expr.Clause("> ?", 32),
expr.String("IS NULL"))),
// AND u.deleted_at IS NOT NULL
sm.Where("u.deleted_at IS NOT NULL"),
// ORDER BY order.date DESC, u.name ASC
sm.OrderBy("orders.date DESC", "u.name ASC"),
)
qs, args, err := q.Build()
if err != nil {
panic(err)
}
fmt.Println(qs)
fmt.Println("===")
fmt.Println(args)
}
Output: SELECT orders.id AS order_id, orders.date, u.id AS user_id, u.name AS user_name FROM orders INNER JOIN users AS u ON orders.user_id = u.id WHERE u.age > $1 AND u.deleted_at IS NOT NULL ORDER BY orders.date DESC, u.name ASC === [32]
Example (LiteralSimple) ¶
package main
import (
"fmt"
"github.com/rrgmc/litsql/dialect/psql"
"github.com/rrgmc/litsql/dialect/psql/sm"
"github.com/rrgmc/litsql/sq"
)
func main() {
// SELECT
q := psql.Select(
// u.id, u.name
sm.Columns("u.id", "u.name"),
// , u.created_at, u.updated_at
sm.Columns("u.created_at", "u.updated_at"),
// FROM users AS u
sm.From("users AS u"),
// WHERE u.age > $1
sm.WhereClause("u.age > ?", 40),
// WHERE u.city_id = $2
sm.WhereClause("u.city_id = ?", sq.NamedArg("city_id")),
// AND u.deleted_at IS NOT NULL
sm.Where("u.deleted_at IS NOT NULL"),
// ORDER BY u.name ASC, u.age DESC
sm.OrderBy("u.name ASC", "u.age DESC"),
)
qs, args, err := q.Build(
sq.WithParseArgs(map[string]any{
"city_id": 66,
}),
)
if err != nil {
panic(err)
}
fmt.Println(qs)
fmt.Println("===")
fmt.Println(args)
}
Output: SELECT u.id, u.name, u.created_at, u.updated_at FROM users AS u WHERE u.age > $1 AND u.city_id = $2 AND u.deleted_at IS NOT NULL ORDER BY u.name ASC, u.age DESC === [40 66]
Example (LiteralSimpleInvalid) ¶
package main
import (
"fmt"
"github.com/rrgmc/litsql/dialect/psql"
"github.com/rrgmc/litsql/dialect/psql/sm"
)
func main() {
// the library won't prevent invalid SQL from being generated, like when using raw string.
// SELECT
q := psql.Select(
// u.id, u.name of user
sm.Columns("u.id", "u.name of user"),
// FROM users AND NOT users
sm.From("users AND NOT users"),
// WHERE CREATE TABLE users
sm.Where("CREATE TABLE users"),
)
qs, _, err := q.Build()
if err != nil {
panic(err)
}
fmt.Println(qs)
}
Output: SELECT u.id, u.name of user FROM users AND NOT users WHERE CREATE TABLE users
Example (LiteralWith) ¶
package main
import (
"fmt"
"github.com/rrgmc/litsql/dialect/psql"
"github.com/rrgmc/litsql/dialect/psql/sm"
)
func main() {
q := psql.Select(
// WITH regional_sales AS (
sm.With("regional_sales").As(
// SELECT
psql.Select(
// region, SUM(amount) AS total_sales
sm.Columns("region", "SUM(amount) AS total_sales"),
// FROM orders
sm.From("orders"),
// GROUP BY region
sm.GroupBy("region"),
),
),
// ), top_regions AS (
sm.With("top_regions").As(
// SELECT
psql.Select(
// region
sm.Columns("region"),
// FROM regional_sales
sm.From("regional_sales"),
// WHERE total_sales > (SELECT SUM(total_sales)/10 FROM regional_sales)
sm.WhereClause("total_sales > ?",
psql.Select(
sm.Columns("SUM(total_sales)/10"),
sm.From("regional_sales"),
),
),
),
),
// )
// SELECT
// region, product, SUM(quantity) AS product_units, SUM(amount) AS product_sales
sm.Columns("region", "product", "SUM(quantity) AS product_units", "SUM(amount) AS product_sales"),
// FROM orders
sm.From("orders"),
// WHERE region IN (SELECT region FROM top_regions)
sm.WhereClause("region IN ?",
psql.Select(
sm.Columns("region"),
sm.From("top_regions"),
),
),
// GROUP BY region, product
sm.GroupBy("region", "product"),
)
qs, _, err := q.Build()
if err != nil {
panic(err)
}
fmt.Println(qs)
}
Output: WITH regional_sales AS ( SELECT region, SUM(amount) AS total_sales FROM orders GROUP BY region ), top_regions AS ( SELECT region FROM regional_sales WHERE total_sales > ( SELECT SUM(total_sales)/10 FROM regional_sales ) ) SELECT region, product, SUM(quantity) AS product_units, SUM(amount) AS product_sales FROM orders WHERE region IN ( SELECT region FROM top_regions ) GROUP BY region, product
func SelectRaw ¶ added in v0.8.1
func SelectRaw(rawQuery string, args ...any) SelectQuery
func SelectRawExpr ¶ added in v0.8.1
func SelectRawExpr(e litsql.Expression) SelectQuery
type UpdateModApply ¶
type UpdateModApply = sq.QueryModApply[tag.UpdateTag]
type UpdateQuery ¶
func Update ¶
func Update(mods ...UpdateMod) UpdateQuery
func UpdateRaw ¶ added in v0.8.1
func UpdateRaw(rawQuery string, args ...any) UpdateQuery
func UpdateRawExpr ¶ added in v0.8.1
func UpdateRawExpr(e litsql.Expression) UpdateQuery
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.