Merge pull request #85 from datastax-ext/master

Add CQL support

Author: huandu

README.md

@@ -9,7 +9,7 @@
 - [Usage](#usage)
   - [Basic usage](#basic-usage)
   - [Pre-defined SQL builders](#pre-defined-sql-builders)
-  - [Build SQL for MySQL, PostgreSQL, SQLServer, SQLite or ClickHouse](#build-sql-for-mysql-postgresql-sqlserve-sqlite-or-clickhouse)
+  - [Build SQL for MySQL, PostgreSQL, SQLServer, SQLite, CQL, or ClickHouse](#build-sql-for-mysql-postgresql-sqlserve-sqlite-or-clickhouse)
   - [Using `Struct` as a light weight ORM](#using-struct-as-a-light-weight-orm)
   - [Nested SQL](#nested-sql)
   - [Use `sql.Named` in a builder](#use-sqlnamed-in-a-builder)
@@ -110,7 +110,7 @@ Following are some utility methods to deal with special cases.
 
 To learn how to use builders, check out [examples on GoDoc](https://pkg.go.dev/github.com/huandu/go-sqlbuilder#pkg-examples).
 
-### Build SQL for MySQL, PostgreSQL, SQLServe, SQLite or ClickHouse
+### Build SQL for MySQL, PostgreSQL, SQLServer, SQLite, CQL, or ClickHouse
 
 Parameter markers are different in MySQL, PostgreSQL, SQLServer and SQLite. This package provides some methods to set the type of markers (we call it "flavor") in all builders.
 
@@ -122,7 +122,7 @@ We can wrap any `Builder` with a default flavor through `WithFlavor`.
 
 To be more verbose, we can use `PostgreSQL.NewSelectBuilder()` to create a `SelectBuilder` with the `PostgreSQL` flavor. All builders can be created in this way.
 
-Right now, there are only three flavors, `MySQL`, `PostgreSQL`, `SQLServer` and `SQLite`. Open new issue to me to ask for a new flavor if you find it necessary.
+Right now, there are five flavors, `MySQL`, `PostgreSQL`, `SQLServer`, `SQLite`, and `CQL`. Open new issue to me to ask for a new flavor if you find it necessary.
 
 ### Using `Struct` as a light weight ORM
 

args.go

@@ -233,7 +233,7 @@ func (args *Args) compileArg(buf *bytes.Buffer, flavor Flavor, values []interfac
 		}
 	default:
 		switch flavor {
-		case MySQL, SQLite, ClickHouse:
+		case MySQL, SQLite, CQL, ClickHouse:
 			buf.WriteRune('?')
 		case PostgreSQL:
 			fmt.Fprintf(buf, "$%d", len(values)+1)

args_test.go

@@ -77,6 +77,21 @@ func TestArgs(t *testing.T) {
 
 		a.Equal(actual, expected)
 	}
+
+	DefaultFlavor = CQL
+
+	for expected, c := range cases {
+		args := new(Args)
+
+		for i := 1; i < len(c); i++ {
+			args.Add(c[i])
+		}
+
+		sql, values := args.Compile(c[0].(string))
+		actual := fmt.Sprintf("%v\n%v", sql, values)
+
+		a.Equal(actual, expected)
+	}
 }
 
 func toPostgreSQL(sql string) string {

builder_test.go

@@ -103,3 +103,24 @@ func TestBuildWithPostgreSQL(t *testing.T) {
 	a.Equal(sql, "SELECT $1 AS col5 LEFT JOIN SELECT col1, col2 FROM t1 WHERE id = $2 AND level > $3 LEFT JOIN SELECT col3, col4 FROM t2 WHERE id = $4 AND level <= $5")
 	a.Equal(args, []interface{}{7890, 1234, 2, 4567, 5})
 }
+
+func TestBuildWithCQL(t *testing.T) {
+	a := assert.New(t)
+
+	ib1 := CQL.NewInsertBuilder()
+	ib1.InsertInto("t1").Cols("col1", "col2").Values(1, 2)
+
+	ib2 := CQL.NewInsertBuilder()
+	ib2.InsertInto("t2").Cols("col3", "col4").Values(3, 4)
+
+	old := DefaultFlavor
+	DefaultFlavor = CQL
+	defer func() {
+		DefaultFlavor = old
+	}()
+
+	sql, args := Build("BEGIN BATCH USING TIMESTAMP $0 $1; $2; APPLY BATCH;", 1481124356754405, ib1, ib2).Build()
+
+	a.Equal(sql, "BEGIN BATCH USING TIMESTAMP ? INSERT INTO t1 (col1, col2) VALUES (?, ?); INSERT INTO t2 (col3, col4) VALUES (?, ?); APPLY BATCH;")
+	a.Equal(args, []interface{}{1481124356754405, 1, 2, 3, 4})
+}

flavor.go

@@ -16,6 +16,7 @@ const (
 	PostgreSQL
 	SQLite
 	SQLServer
+	CQL
 	ClickHouse
 )
 
@@ -50,6 +51,8 @@ func (f Flavor) String() string {
 		return "SQLite"
 	case SQLServer:
 		return "SQLServer"
+	case CQL:
+		return "CQL"
 	case ClickHouse:
 		return "ClickHouse"
 	}
@@ -72,6 +75,8 @@ func (f Flavor) Interpolate(sql string, args []interface{}) (string, error) {
 		return sqliteInterpolate(sql, args...)
 	case SQLServer:
 		return sqlserverInterpolate(sql, args...)
+	case CQL:
+		return cqlInterpolate(sql, args...)
 	case ClickHouse:
 		return clickhouseInterpolate(sql, args...)
 	}
@@ -132,6 +137,8 @@ func (f Flavor) Quote(name string) string {
 		return fmt.Sprintf("`%s`", name)
 	case PostgreSQL, SQLServer, SQLite:
 		return fmt.Sprintf(`"%s"`, name)
+	case CQL:
+		return fmt.Sprintf("'%s'", name)
 	}
 
 	return name

flavor_test.go

@@ -121,3 +121,20 @@ func ExampleFlavor_Interpolate_sqlServer() {
 	// SELECT name FROM user WHERE id <> 1234 AND name = N'Charmy Liu' AND desc LIKE N'%mother\'s day%'
 	// <nil>
 }
+
+func ExampleFlavor_Interpolate_cql() {
+	sb := CQL.NewSelectBuilder()
+	sb.Select("name").From("user").Where(
+		sb.E("id", 1234),
+		sb.E("name", "Charmy Liu"),
+	)
+	sql, args := sb.Build()
+	query, err := CQL.Interpolate(sql, args)
+
+	fmt.Println(query)
+	fmt.Println(err)
+
+	// Output:
+	// SELECT name FROM user WHERE id = 1234 AND name = 'Charmy Liu'
+	// <nil>
+}

insert_test.go

@@ -52,7 +52,7 @@ func ExampleReplaceInto() {
 func ExampleInsertBuilder() {
 	ib := NewInsertBuilder()
 	ib.InsertInto("demo.user")
-	ib.Cols("id", "name", "status", "created_at")
+	ib.Cols("id", "name", "status", "created_at", "updated_at")
 	ib.Values(1, "Huan Du", 1, Raw("UNIX_TIMESTAMP(NOW())"))
 	ib.Values(2, "Charmy Liu", 1, 1234567890)
 
@@ -61,14 +61,14 @@ func ExampleInsertBuilder() {
 	fmt.Println(args)
 
 	// Output:
-	// INSERT INTO demo.user (id, name, status, created_at) VALUES (?, ?, ?, UNIX_TIMESTAMP(NOW())), (?, ?, ?, ?)
+	// INSERT INTO demo.user (id, name, status, created_at, updated_at) VALUES (?, ?, ?, UNIX_TIMESTAMP(NOW())), (?, ?, ?, ?)
 	// [1 Huan Du 1 2 Charmy Liu 1 1234567890]
 }
 
 func ExampleInsertBuilder_insertIgnore() {
 	ib := NewInsertBuilder()
 	ib.InsertIgnoreInto("demo.user")
-	ib.Cols("id", "name", "status", "created_at")
+	ib.Cols("id", "name", "status", "created_at", "updated_at")
 	ib.Values(1, "Huan Du", 1, Raw("UNIX_TIMESTAMP(NOW())"))
 	ib.Values(2, "Charmy Liu", 1, 1234567890)
 
@@ -77,7 +77,7 @@ func ExampleInsertBuilder_insertIgnore() {
 	fmt.Println(args)
 
 	// Output:
-	// INSERT IGNORE INTO demo.user (id, name, status, created_at) VALUES (?, ?, ?, UNIX_TIMESTAMP(NOW())), (?, ?, ?, ?)
+	// INSERT IGNORE INTO demo.user (id, name, status, created_at, updated_at) VALUES (?, ?, ?, UNIX_TIMESTAMP(NOW())), (?, ?, ?, ?)
 	// [1 Huan Du 1 2 Charmy Liu 1 1234567890]
 }
 
@@ -132,7 +132,7 @@ func ExampleInsertBuilder_insertIgnore_clickhouse() {
 func ExampleInsertBuilder_replaceInto() {
 	ib := NewInsertBuilder()
 	ib.ReplaceInto("demo.user")
-	ib.Cols("id", "name", "status", "created_at")
+	ib.Cols("id", "name", "status", "created_at", "updated_at")
 	ib.Values(1, "Huan Du", 1, Raw("UNIX_TIMESTAMP(NOW())"))
 	ib.Values(2, "Charmy Liu", 1, 1234567890)
 
@@ -141,7 +141,7 @@ func ExampleInsertBuilder_replaceInto() {
 	fmt.Println(args)
 
 	// Output:
-	// REPLACE INTO demo.user (id, name, status, created_at) VALUES (?, ?, ?, UNIX_TIMESTAMP(NOW())), (?, ?, ?, ?)
+	// REPLACE INTO demo.user (id, name, status, created_at, updated_at) VALUES (?, ?, ?, UNIX_TIMESTAMP(NOW())), (?, ?, ?, ?)
 	// [1 Huan Du 1 2 Charmy Liu 1 1234567890]
 }
 

interpolate.go

@@ -386,6 +386,11 @@ func sqliteInterpolate(query string, args ...interface{}) (string, error) {
 	return mysqlLikeInterpolate(SQLite, query, args...)
 }
 
+// cqlInterpolate works the same as MySQL interpolating.
+func cqlInterpolate(query string, args ...interface{}) (string, error) {
+	return mysqlLikeInterpolate(CQL, query, args...)
+}
+
 func clickhouseInterpolate(query string, args ...interface{}) (string, error) {
 	return mysqlLikeInterpolate(ClickHouse, query, args...)
 }
@@ -426,6 +431,9 @@ func encodeValue(buf []byte, arg interface{}, flavor Flavor) ([]byte, error) {
 		case SQLServer:
 			buf = append(buf, v.Format("2006-01-02 15:04:05.999999 Z07:00")...)
 
+		case CQL:
+			buf = append(buf, v.Format("2006-01-02 15:04:05.999999Z0700")...)
+
 		case ClickHouse:
 			buf = append(buf, v.Format("2006-01-02 15:04:05.999999")...)
 		}
@@ -525,7 +533,7 @@ func encodeValue(buf []byte, arg interface{}, flavor Flavor) ([]byte, error) {
 				buf = appendHex(buf, data)
 				buf = append(buf, '\'')
 
-			case SQLServer:
+			case SQLServer, CQL:
 				buf = append(buf, "0x"...)
 				buf = appendHex(buf, data)
 
@@ -585,7 +593,11 @@ func quoteStringValue(buf []byte, s string, flavor Flavor) []byte {
 			buf = append(buf, "\\Z"...)
 
 		case '\'':
-			buf = append(buf, "\\'"...)
+			if flavor == CQL {
+				buf = append(buf, "''"...)
+			} else {
+				buf = append(buf, "\\'"...)
+			}
 
 		case '"':
 			buf = append(buf, "\\\""...)

interpolate_test.go

@@ -3,6 +3,7 @@ package sqlbuilder
 import (
 	"database/sql/driver"
 	"errors"
+	"fmt"
 	"strconv"
 	"testing"
 	"time"
@@ -19,7 +20,6 @@ func (v errorValuer) Value() (driver.Value, error) {
 }
 
 func TestFlavorInterpolate(t *testing.T) {
-	a := assert.New(t)
 	dt := time.Date(2019, 4, 24, 12, 23, 34, 123456789, time.FixedZone("CST", 8*60*60)) // 2019-04-24 12:23:34.987654321 CST
 	_, errOutOfRange := strconv.ParseInt("12345678901234567890", 10, 32)
 	byteArr := [...]byte{'f', 'o', 'o'}
@@ -163,7 +163,36 @@ func TestFlavorInterpolate(t *testing.T) {
 			"SELECT @p1", nil,
 			"", ErrInterpolateMissingArgs,
 		},
-
+		{
+			CQL,
+			"SELECT * FROM a WHERE name = ? AND state IN (?, ?, ?, ?, ?)", []interface{}{"I'm fine", 42, int8(8), int16(-16), int32(32), int64(64)},
+			"SELECT * FROM a WHERE name = 'I''m fine' AND state IN (42, 8, -16, 32, 64)", nil,
+		},
+		{
+			CQL,
+			"SELECT * FROM `a?` WHERE name = \"?\" AND state IN (?, '?', ?, ?, ?, ?, ?)", []interface{}{"\r\n\b\t\x1a\x00\\\"'", uint(42), uint8(8), uint16(16), uint32(32), uint64(64), "useless"},
+			"SELECT * FROM `a?` WHERE name = \"?\" AND state IN ('\\r\\n\\b\\t\\Z\\0\\\\\\\"''', '?', 42, 8, 16, 32, 64)", nil,
+		},
+		{
+			CQL,
+			"SELECT ?, ?, ?, ?, ?, ?, ?, ?, ?", []interface{}{true, false, float32(1.234567), float64(9.87654321), []byte(nil), []byte("I'm bytes"), dt, time.Time{}, nil},
+			"SELECT TRUE, FALSE, 1.234567, 9.87654321, NULL, 0x49276D206279746573, '2019-04-24 12:23:34.123457+0800', '0000-00-00', NULL", nil,
+		},
+		{
+			CQL,
+			"SELECT '\\'?', \"\\\"?\", `\\`?`, \\?", []interface{}{CQL},
+			"SELECT '\\'?', \"\\\"?\", `\\`?`, \\'CQL'", nil,
+		},
+		{
+			CQL,
+			"SELECT ?", nil,
+			"", ErrInterpolateMissingArgs,
+		},
+		{
+			CQL,
+			"SELECT ?", []interface{}{complex(1, 2)},
+			"", ErrInterpolateUnsupportedArgs,
+		},
 		{
 			ClickHouse,
 			"SELECT * FROM a WHERE name = ? AND state IN (?, ?, ?, ?, ?)", []interface{}{"I'm fine", 42, int8(8), int16(-16), int32(32), int64(64)},
@@ -212,10 +241,13 @@ func TestFlavorInterpolate(t *testing.T) {
 	}
 
 	for idx, c := range cases {
-		a.Use(&idx, &c)
-		query, err := c.Flavor.Interpolate(c.SQL, c.Args)
+		t.Run(fmt.Sprintf("%s: %s", c.Flavor.String(), c.Query), func(t *testing.T) {
+			a := assert.New(t)
+			a.Use(&idx, &c)
+			query, err := c.Flavor.Interpolate(c.SQL, c.Args)
 
-		a.Equal(query, c.Query)
-		a.Assert(err == c.Err || err.Error() == c.Err.Error())
+			a.Equal(query, c.Query)
+			a.Assert(err == c.Err || err.Error() == c.Err.Error())
+		})
 	}
 }

select.go

@@ -310,6 +310,11 @@ func (sb *SelectBuilder) BuildWithFlavor(flavor Flavor, initialArg ...interface{
 				buf.WriteString(strconv.Itoa(sb.offset))
 			}
 		}
+	case CQL:
+		if sb.limit >= 0 {
+			buf.WriteString(" LIMIT ")
+			buf.WriteString(strconv.Itoa(sb.limit))
+		}
 	case PostgreSQL:
 		if sb.limit >= 0 {
 			buf.WriteString(" LIMIT ")