Merge pull request #3 from aldy505/feat/upsert

Feat/upsert (WIP)

Author: Reinaldy Rafli

README.md

@@ -2,7 +2,7 @@
 
 [![Go Reference](https://pkg.go.dev/badge/github.com/aldy505/bob.svg)](https://pkg.go.dev/github.com/aldy505/bob) [![Go Report Card](https://goreportcard.com/badge/github.com/aldy505/bob)](https://goreportcard.com/report/github.com/aldy505/bob) ![GitHub](https://img.shields.io/github/license/aldy505/bob) [![CodeFactor](https://www.codefactor.io/repository/github/aldy505/bob/badge)](https://www.codefactor.io/repository/github/aldy505/bob) [![codecov](https://codecov.io/gh/aldy505/bob/branch/master/graph/badge.svg?token=Noeexg5xEJ)](https://codecov.io/gh/aldy505/bob) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/9b78970127c74c1a923533e05f65848d)](https://www.codacy.com/gh/aldy505/bob/dashboard?utm_source=github.com&utm_medium=referral&utm_content=aldy505/bob&utm_campaign=Badge_Grade) [![Build test](https://github.com/aldy505/bob/actions/workflows/build.yml/badge.svg)](https://github.com/aldy505/bob/actions/workflows/build.yml) [![Test and coverage](https://github.com/aldy505/bob/actions/workflows/coverage.yml/badge.svg)](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.
+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).
 
@@ -116,6 +116,44 @@ func main() {
 }
 ```
 
+### 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", "[email protected]", 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", "[email protected]", 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", "[email protected]", 19).
+    Key("email", "[email protected]").
+    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:
@@ -222,12 +260,12 @@ func main() {
 * `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.Upsert(tableName)` - UPSERT function (`insert into "users" ("name", "email") values (?, ?) on duplicate key update email = ?`)
 * `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"`)
 

bob.go

@@ -8,9 +8,20 @@ import (
 
 // ErrEmptyTable is a common database/sql error if a table is empty or no rows is returned by the query.
 var ErrEmptyTable = errors.New("sql: no rows in result set")
+
 // ErrEmptyTable is a common pgx error if a table is empty or no rows is returned by the query.
 var ErrEmptyTablePgx = errors.New("no rows in result set")
 
+// ErrDialectNotSupported tells you whether the dialect is supported or not.
+var ErrDialectNotSupported = errors.New("provided database dialect is not supported")
+
+const (
+	MySQL int = iota
+	PostgreSQL
+	SQLite
+	MSSQL
+)
+
 // BobBuilderType is the type for BobBuilder
 type BobBuilderType builder.Builder
 
@@ -21,12 +32,12 @@ type BobBuilder interface {
 
 // CreateTable creates a table with CreateBuilder interface
 func (b BobBuilderType) CreateTable(table string) CreateBuilder {
-	return CreateBuilder(b).Name(table)
+	return CreateBuilder(b).name(table)
 }
 
 // CreateTableIfNotExists creates a table with CreateBuilder interface, if the table doesn't exists.
 func (b BobBuilderType) CreateTableIfNotExists(table string) CreateBuilder {
-	return CreateBuilder(b).Name(table).IfNotExists()
+	return CreateBuilder(b).name(table).ifNotExists()
 }
 
 // HasTable checks if a table exists with HasBuilder interface
@@ -41,28 +52,49 @@ func (b BobBuilderType) HasColumn(column string) HasBuilder {
 
 // DropTable drops (delete contents & remove) a table from the database.
 func (b BobBuilderType) DropTable(table string) DropBuilder {
-	return DropBuilder(b).DropTable(table)
+	return DropBuilder(b).dropTable(table)
 }
 
 // DropTable drops (delete contents & remove) a table from the database if the table exists.
 func (b BobBuilderType) DropTableIfExists(table string) DropBuilder {
-	return DropBuilder(b).DropTable(table).IfExists()
+	return DropBuilder(b).dropTable(table).ifExists()
 }
 
 // RenameTable simply renames an exisisting table.
 func (b BobBuilderType) RenameTable(from, to string) RenameBuilder {
-	return RenameBuilder(b).From(from).To(to)
+	return RenameBuilder(b).from(from).to(to)
 }
 
 // Truncate performs TRUNCATE function. It deletes all contents from a table but not deleting the table.
 func (b BobBuilderType) Truncate(table string) TruncateBuilder {
-	return TruncateBuilder(b).Truncate(table)
+	return TruncateBuilder(b).truncate(table)
+}
+
+func (b BobBuilderType) Upsert(table string, dialect int) UpsertBuilder {
+	return UpsertBuilder(b).dialect(dialect).into(table)
 }
 
 // BobStmtBuilder is the parent builder for BobBuilderType
 var BobStmtBuilder = BobBuilderType(builder.EmptyBuilder)
 
 // CreateTable creates a table with CreateBuilder interface.
+// Refer to README for available column definition types.
+//
+//      // 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 README.
+//        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
+//      }
 func CreateTable(table string) CreateBuilder {
 	return BobStmtBuilder.CreateTable(table)
 }
@@ -100,4 +132,43 @@ func RenameTable(from, to string) RenameBuilder {
 // Truncate performs TRUNCATE function. It deletes all contents from a table but not deleting the table.
 func Truncate(table string) TruncateBuilder {
 	return BobStmtBuilder.Truncate(table)
-}
+}
+
+// Upsert performs a UPSERT query with specified database dialect.
+// Supported database includes MySQL, PostgreSQL, SQLite and MSSQL.
+//
+//       // MySQL example:
+//       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", "[email protected]", 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", "[email protected]", 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", "[email protected]", 19).
+//         Key("email", "[email protected]").
+//         Replace("age", 18).
+//         PlaceholderFormat(bob.AtP).
+//         ToSql()
+func Upsert(table string, dialect int) UpsertBuilder {
+	return BobStmtBuilder.Upsert(table, dialect)
+}

create.go

@@ -27,13 +27,13 @@ func init() {
 	builder.Register(CreateBuilder{}, createData{})
 }
 
-// Name sets the table name
-func (b CreateBuilder) Name(name string) CreateBuilder {
+// name sets the table name
+func (b CreateBuilder) name(name string) CreateBuilder {
 	return builder.Set(b, "TableName", name).(CreateBuilder)
 }
 
-// IfNotExists adds IF NOT EXISTS to the query
-func (b CreateBuilder) IfNotExists() CreateBuilder {
+// ifNotExists adds IF NOT EXISTS to the query
+func (b CreateBuilder) ifNotExists() CreateBuilder {
 	return builder.Set(b, "IfNotExists", true).(CreateBuilder)
 }
 

drop.go

@@ -11,19 +11,19 @@ type DropBuilder builder.Builder
 
 type dropData struct {
 	TableName string
-	IfExists bool
+	IfExists  bool
 }
 
 func init() {
 	builder.Register(DropBuilder{}, dropData{})
 }
 
 // DropTable sets which table to be dropped
-func (b DropBuilder) DropTable(name string) DropBuilder {
+func (b DropBuilder) dropTable(name string) DropBuilder {
 	return builder.Set(b, "TableName", name).(DropBuilder)
 }
 
-func (b DropBuilder) IfExists() DropBuilder {
+func (b DropBuilder) ifExists() DropBuilder {
 	return builder.Set(b, "IfExists", true).(DropBuilder)
 }
 
@@ -45,9 +45,9 @@ func (d *dropData) ToSql() (sqlStr string, args []interface{}, err error) {
 	if d.IfExists {
 		sql.WriteString("IF EXISTS ")
 	}
-	
-	sql.WriteString("\""+d.TableName+"\";")
+
+	sql.WriteString("\"" + d.TableName + "\";")
 
 	sqlStr = sql.String()
 	return
-}
+}

drop_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 func TestDrop(t *testing.T) {
-	t.Run("should be able to create regular drop query", func (t *testing.T)  {
+	t.Run("should be able to create regular drop query", func(t *testing.T) {
 		sql, _, err := bob.DropTable("users").ToSql()
 		if err != nil {
 			t.Error(err)
@@ -37,4 +37,4 @@ func TestDrop(t *testing.T) {
 			t.Error(err)
 		}
 	})
-} 
+}

has.go

@@ -8,9 +8,6 @@ import (
 	"github.com/lann/builder"
 )
 
-// TODO - The whole file is a todo
-// Meant to find two things: HasTable and HasColumn(s)
-
 type HasBuilder builder.Builder
 
 type hasData struct {

has_test.go

@@ -1,13 +1,12 @@
 package bob_test
 
 import (
+	"reflect"
 	"testing"
 
 	"github.com/aldy505/bob"
 )
 
-// TODO - do more test
-
 func TestHas(t *testing.T) {
 	t.Run("should be able to create a hasTable query", func(t *testing.T) {
 		sql, args, err := bob.HasTable("users").ToSql()
@@ -19,8 +18,8 @@ func TestHas(t *testing.T) {
 		if sql != result {
 			t.Fatal("sql is not equal with result:", sql)
 		}
-
-		if len(args) != 1 {
+		argsResult := []interface{}{"users"}
+		if !reflect.DeepEqual(args, argsResult) {
 			t.Fatal("args is not equal with argsResult:", args)
 		}
 	})
@@ -36,7 +35,8 @@ func TestHas(t *testing.T) {
 			t.Fatal("sql is not equal with result:", sql)
 		}
 
-		if len(args) != 2 {
+		argsResult := []interface{}{"users", "name"}
+		if !reflect.DeepEqual(args, argsResult) {
 			t.Fatal("args is not equal with argsResult:", args)
 		}
 	})
@@ -52,7 +52,8 @@ func TestHas(t *testing.T) {
 			t.Fatal("sql is not equal with result:", sql)
 		}
 
-		if len(args) != 2 {
+		argsResult := []interface{}{"users", "name"}
+		if !reflect.DeepEqual(args, argsResult) {
 			t.Fatal("args is not equal with argsResult:", args)
 		}
 	})
@@ -68,12 +69,13 @@ func TestHas(t *testing.T) {
 			t.Fatal("sql is not equal with result:", sql)
 		}
 
-		if len(args) != 2 {
+		argsResult := []interface{}{"users", "private"}
+		if !reflect.DeepEqual(args, argsResult) {
 			t.Fatal("args is not equal with argsResult:", args)
 		}
 	})
 
-	t.Run("should be able to have a different placeholder", func(t *testing.T) {
+	t.Run("should be able to have a different placeholder - dollar", func(t *testing.T) {
 		sql, args, err := bob.HasTable("users").HasColumn("name").PlaceholderFormat(bob.Dollar).ToSql()
 		if err != nil {
 			t.Fatal(err.Error())
@@ -84,7 +86,8 @@ func TestHas(t *testing.T) {
 			t.Fatal("sql is not equal with result:", sql)
 		}
 
-		if len(args) != 2 {
+		argsResult := []interface{}{"users", "name"}
+		if !reflect.DeepEqual(args, argsResult) {
 			t.Fatal("args is not equal with argsResult:", args)
 		}
 	})

rename.go

@@ -10,20 +10,20 @@ type RenameBuilder builder.Builder
 
 type renameData struct {
 	From string
-	To string
+	To   string
 }
 
 func init() {
 	builder.Register(RenameBuilder{}, renameData{})
 }
 
-// From sets existing table name
-func (b RenameBuilder) From(name string) RenameBuilder {
+// from sets existing table name
+func (b RenameBuilder) from(name string) RenameBuilder {
 	return builder.Set(b, "From", name).(RenameBuilder)
 }
 
-// To sets desired table name
-func (b RenameBuilder) To(name string) RenameBuilder {
+// to sets desired table name
+func (b RenameBuilder) to(name string) RenameBuilder {
 	return builder.Set(b, "To", name).(RenameBuilder)
 }
 
@@ -38,6 +38,6 @@ func (d *renameData) ToSql() (sqlStr string, args []interface{}, err error) {
 	if len(d.From) == 0 || d.From == "" || len(d.To) == 0 || d.To == "" {
 		err = errors.New("rename statement must specify a table")
 	}
-	sqlStr = "RENAME TABLE \""+d.From+"\" TO \""+d.To+"\";"
+	sqlStr = "RENAME TABLE \"" + d.From + "\" TO \"" + d.To + "\";"
 	return
-}
+}