mirror of https://github.com/aldy505/bob.git
279 lines
8.8 KiB
Markdown
279 lines
8.8 KiB
Markdown
# Bob - SQL Query Builder
|
|
|
|
[](https://pkg.go.dev/github.com/aldy505/bob) [](https://goreportcard.com/report/github.com/aldy505/bob)  [](https://www.codefactor.io/repository/github/aldy505/bob) [](https://codecov.io/gh/aldy505/bob) [](https://www.codacy.com/gh/aldy505/bob/dashboard?utm_source=github.com&utm_medium=referral&utm_content=aldy505/bob&utm_campaign=Badge_Grade) [](https://github.com/aldy505/bob/actions/workflows/build.yml) [](https://github.com/aldy505/bob/actions/workflows/coverage.yml)
|
|
|
|
Think of this as an extension of [Squirrel](https://github.com/Masterminds/squirrel) with functionability like [Knex](https://knexjs.org/). I still use Squirrel for other types of queries (insert, select, and all that), but I needed some SQL builder for create table and some other stuffs. Including database creation & upsert.
|
|
|
|
Oh, and of course, heavily inspired by [Bob the Builder](https://en.wikipedia.org/wiki/Bob_the_Builder).
|
|
|
|
```go
|
|
import "github.com/aldy505/bob"
|
|
```
|
|
|
|
## Usage
|
|
|
|
It's not ready for large-scale production yet (although I've already using it on one of my projects). But, the API is probably close to how you'd do things on Squirrel.
|
|
|
|
### Create a table
|
|
|
|
```go
|
|
import "github.com/aldy505/bob"
|
|
|
|
func main() {
|
|
// Note that CREATE TABLE doesn't returns args params.
|
|
sql, _, err := bob.
|
|
CreateTable("tableName").
|
|
// The first parameter is the column's name.
|
|
// The second parameters and so on forth are extras.
|
|
StringColumn("id", "NOT NULL", "PRIMARY KEY", "AUTOINCREMENT").
|
|
StringColumn("email", "NOT NULL", "UNIQUE").
|
|
// See the list of available column definition types through pkg.go.dev or scroll down below.
|
|
TextColumn("password").
|
|
// Or add your custom type.
|
|
AddColumn(bob.ColumnDef{Name: "tableName", Type: "customType", Extras: []string{"NOT NULL"}}).
|
|
ToSql()
|
|
if err != nil {
|
|
// handle your error
|
|
}
|
|
}
|
|
```
|
|
|
|
Available column definition types (please be aware that some only works on certain database):
|
|
* `StringColumn()` - Default to `VARCHAR(255)`
|
|
* `TextColumn()` - Default to `TEXT`
|
|
* `UUIDColumn()` - Defaults to `UUID`
|
|
* `BooleanColumn()` - Defaults to `BOOLEAN`
|
|
* `IntegerColumn()` - Defaults to `INTEGER`. Postgres and SQLite only.
|
|
* `IntColumn()` - Defaults to `INT`. MySQL and MSSQL only.
|
|
* `RealColumn()` - Defaults to `REAL`. Postgres, MSSQL, and SQLite only.
|
|
* `FloatColumn()` - Defaults to `FLOAT`. Postgres and SQLite only.
|
|
* `DateTimeColumn()` - Defaults to `DATETIME`.
|
|
* `TimeStampColumn()` - Defaults to `TIMESTAMP`.
|
|
* `TimeColumn()` - Defaults to `TIME`.
|
|
* `DateColumn()` - Defaults to `DATE`.
|
|
* `JSONColumn()` - Dafults to `JSON`. MySQL and Postgres only.
|
|
* `JSONBColumn()` - Defaults to `JSONB`. Postgres only.
|
|
* `BlobColumn()` - Defaults to `BLOB`. MySQL and SQLite only.
|
|
|
|
For any other types, please use `AddColumn()`.
|
|
|
|
Another builder of `bob.CreateTableIfNotExists()` is also available.
|
|
|
|
### Check if a table exists
|
|
|
|
```go
|
|
func main() {
|
|
sql, args, err := bob.HasTable("users").ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
```
|
|
|
|
### Check if a column exists
|
|
|
|
```go
|
|
func main() {
|
|
sql, args, err := bob.HasColumn("email").ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
```
|
|
|
|
### Drop table
|
|
|
|
```go
|
|
func main() {
|
|
sql, _, err := bob.DropTable("users").ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
```
|
|
|
|
You could also do `bob.DropTableIfExists("users")` to output a `DROP TABLE IF EXISTS "users"` query.
|
|
|
|
### Truncate table
|
|
|
|
```go
|
|
func main() {
|
|
sql, _, err := bob.Truncate("users").ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
```
|
|
|
|
### Rename table
|
|
|
|
```go
|
|
func main() {
|
|
sql, _, err := bob.RenameTable("users", "people").ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
```
|
|
|
|
### Upsert
|
|
|
|
```go
|
|
func main() {
|
|
sql, args, err := bob.
|
|
// Notice that you should give database dialect on the second params.
|
|
// Available database dialect are MySQL, PostgreSQL, SQLite, and MSSQL.
|
|
Upsert("users", bob.MySQL).
|
|
Columns("name", "email", "age").
|
|
// You could do multiple Values() call, but I'd suggest to not do it.
|
|
// Because this is an upsert function, not an insert one.
|
|
Values("Thomas Mueler", "tmueler@something.com", 25).
|
|
Replace("age", 25).
|
|
PlaceholderFormat(bob.Question).
|
|
ToSql()
|
|
|
|
// Another example for PostgreSQL
|
|
sql, args, err = bob.
|
|
Upsert("users", bob.PostgreSQL).
|
|
Columns("name", "email", "age").
|
|
Values("Billy Urtha", "billu@something.com", 30).
|
|
Key("email").
|
|
Replace("age", 40).
|
|
PlaceholderFormat(bob.Dollar).
|
|
ToSql()
|
|
|
|
// One more time, for MSSQL / SQL Server.
|
|
sql, args, err = bob.
|
|
Upsert("users", bob.MSSQL).
|
|
Columns("name", "email", "age").
|
|
Values("George Rust", "georgee@something.com", 19).
|
|
Key("email", "georgee@something.com").
|
|
Replace("age", 18).
|
|
PlaceholderFormat(bob.AtP).
|
|
ToSql()
|
|
}
|
|
```
|
|
|
|
### Placeholder format / Dialect
|
|
|
|
Default placeholder is a question mark (MySQL-like). If you want to change it, simply use something like this:
|
|
|
|
```go
|
|
func main() {
|
|
// Option 1
|
|
sql, args, err := bob.HasTable("users").PlaceholderFormat(bob.Dollar).ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
// Option 2
|
|
sql, args, err = bob.HasTable("users").ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
correctPlaceholder := bob.ReplacePlaceholder(sql, bob.Dollar)
|
|
}
|
|
```
|
|
|
|
Available placeholder formats:
|
|
* `bob.Question` - `INSERT INTO "users" (name) VALUES (?)`
|
|
* `bob.Dollar` - `INSERT INTO "users" (name) VALUES ($1)`
|
|
* `bob.Colon` - `INSERT INTO "users" (name) VALUES (:1)`
|
|
* `bob.AtP` - `INSERT INTO "users" (name) VALUES (@p1)`
|
|
|
|
### With pgx (PostgreSQL)
|
|
|
|
```go
|
|
import (
|
|
"context"
|
|
"log"
|
|
"strings"
|
|
|
|
"github.com/aldy505/bob"
|
|
"github.com/jackc/pgx/v4"
|
|
)
|
|
|
|
func main() {
|
|
db := pgx.Connect()
|
|
|
|
// Check if a table is exists
|
|
sql, args, err = bob.HasTable("users").PlaceholderFormat(bob.Dollar).ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
var hasTableUsers bool
|
|
err = db.QueryRow(context.Background(), sql, args...).Scan(&hasTableUsers)
|
|
if err != nil {
|
|
if err == bob.ErrEmptyTablePg {
|
|
hasTableUsers = false
|
|
} else {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
|
|
if !hasTableUsers {
|
|
// Create "users" table
|
|
sql, _, err := bob.
|
|
CreateTable("users").
|
|
IntegerColumn("id", "PRIMARY KEY", "SERIAL").
|
|
StringColumn("name", "NOT NULL").
|
|
TextColumn("password", "NOT NULL").
|
|
DateColumn("created_at").
|
|
ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
_, err = db.Query(context.Background(), splitQuery[i])
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
// Create another table, this time with CREATE TABLE IF NOT EXISTS
|
|
sql, _, err := bob.
|
|
CreateTableIfNotExists("inventory").
|
|
UUIDColumn("id", "PRIMARY KEY").
|
|
IntegerColumn("userID", "FOREIGN KEY REFERENCES users(id)").
|
|
JSONColumn("items").
|
|
IntegerColumn("quantity").
|
|
ToSql()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
_, err = db.Query(context.Background(), inventoryQuery[i])
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Features
|
|
|
|
* `bob.CreateTable(tableName)` - Basic SQL create table
|
|
* `bob.CreateTableIfNotExists(tableName)` - Create table if not exists
|
|
* `bob.HasTable(tableName)` - Checks if column exists (return error if false, check example above for error handling)
|
|
* `bob.HasColumn(columnName)` - Check if a column exists on current table
|
|
* `bob.DropTable(tableName)` - Drop a table (`drop table "users"`)
|
|
* `bob.DropTableIfExists(tableName)` - Drop a table if exists (`drop table if exists "users"`)
|
|
* `bob.RenameTable(currentTable, desiredName)` - Rename a table (`rename table "users" to "people"`)
|
|
* `bob.Truncate(tableName)` - Truncate a table (`truncate "users"`)
|
|
* `bob.Upsert(tableName, dialect)` - UPSERT function (`insert into "users" ("name", "email") values (?, ?) on duplicate key update email = ?`)
|
|
|
|
### TODO
|
|
|
|
Meaning these are some ideas for the future development of Bob.
|
|
|
|
* `bob.ExecWith()` - Just like Squirrel's [ExecWith](https://pkg.go.dev/github.com/Masterminds/squirrel?utm_source=godoc#ExecWith)
|
|
* `bob.Count(tableName, columnName)` - Count query (`select count("active") from "users"`)
|
|
|
|
## Contributing
|
|
|
|
Contributions are always welcome! As long as you add a test for your changes.
|
|
|
|
## License
|
|
|
|
Bob is licensed under [MIT license](./LICENSE)
|