Merge pull request #120 from doug-martin/issue118-fix

Fix for #118

HISTORY.md

@@ -1,3 +1,11 @@
+## v8.2.0
+
+* [FIX] Fix reflection errors related to nil pointers and unexported fields [#118](https://github.com/doug-martin/goqu/issues/118)
+    * Unexported fields are ignored when creating a columnMap
+    * Nil embedded pointers will no longer cause a panic
+    * Fields on nil embedded pointers will be ignored when creating update or insert statements.
+* [ADDED] You can now ingore embedded structs and their fields by using `db:"-"` tag on the embedded struct.
+
 ## v8.1.0
 
 * [ADDED] Support column DEFAULT when inserting/updating via struct [#27](https://github.com/doug-martin/goqu/issues/27)

docs/inserting.md

@@ -196,6 +196,87 @@ Output:
 INSERT INTO "user" ("first_name", "last_name") VALUES (DEFAULT, 'Farley'), ('Jimmy', 'Stewart'), (DEFAULT, 'Jeffers') []
 ```
 
+`goqu` will also use fields in embedded structs when creating an insert.
+
+**NOTE** unexported fields will be ignored!
+
+```go
+type Address struct {
+	Street string `db:"address_street"`
+	State  string `db:"address_state"`
+}
+type User struct {
+	Address
+	FirstName string
+	LastName  string
+}
+ds := goqu.Insert("user").Rows(
+	User{Address: Address{Street: "111 Street", State: "NY"}, FirstName: "Greg", LastName: "Farley"},
+	User{Address: Address{Street: "211 Street", State: "NY"}, FirstName: "Jimmy", LastName: "Stewart"},
+	User{Address: Address{Street: "311 Street", State: "NY"}, FirstName: "Jeff", LastName: "Jeffers"},
+)
+insertSQL, args, _ := ds.ToSQL()
+fmt.Println(insertSQL, args)
+```
+
+Output:
+```
+INSERT INTO "user" ("address_state", "address_street", "firstname", "lastname") VALUES ('NY', '111 Street', 'Greg', 'Farley'), ('NY', '211 Street', 'Jimmy', 'Stewart'), ('NY', '311 Street', 'Jeff', 'Jeffers') []
+```
+
+**NOTE** When working with embedded pointers if the embedded struct is nil then the fields will be ignored.
+
+```go
+type Address struct {
+	Street string
+	State  string
+}
+type User struct {
+	*Address
+	FirstName string
+	LastName  string
+}
+ds := goqu.Insert("user").Rows(
+	User{FirstName: "Greg", LastName: "Farley"},
+	User{FirstName: "Jimmy", LastName: "Stewart"},
+	User{FirstName: "Jeff", LastName: "Jeffers"},
+)
+insertSQL, args, _ := ds.ToSQL()
+fmt.Println(insertSQL, args)
+```
+
+Output:
+```
+INSERT INTO "user" ("firstname", "lastname") VALUES ('Greg', 'Farley'), ('Jimmy', 'Stewart'), ('Jeff', 'Jeffers') []
+```
+
+You can ignore an embedded struct or struct pointer by using `db:"-"`
+
+```go
+type Address struct {
+	Street string
+	State  string
+}
+type User struct {
+	Address   `db:"-"`
+	FirstName string
+	LastName  string
+}
+
+ds := goqu.Insert("user").Rows(
+	User{Address: Address{Street: "111 Street", State: "NY"}, FirstName: "Greg", LastName: "Farley"},
+	User{Address: Address{Street: "211 Street", State: "NY"}, FirstName: "Jimmy", LastName: "Stewart"},
+	User{Address: Address{Street: "311 Street", State: "NY"}, FirstName: "Jeff", LastName: "Jeffers"},
+)
+insertSQL, args, _ := ds.ToSQL()
+fmt.Println(insertSQL, args)
+```
+
+Output:
+```
+INSERT INTO "user" ("firstname", "lastname") VALUES ('Greg', 'Farley'), ('Jimmy', 'Stewart'), ('Jeff', 'Jeffers') []
+```
+
 <a name="insert-map"></a>
 **Insert `map[string]interface{}`**
 

docs/updating.md

@@ -171,6 +171,81 @@ Output:
 UPDATE "items" SET "address"='111 Test Addr',"name"=DEFAULT []
 ```
 
+`goqu` will also use fields in embedded structs when creating an update.
+
+**NOTE** unexported fields will be ignored!
+
+```go
+type Address struct {
+	Street string `db:"address_street"`
+	State  string `db:"address_state"`
+}
+type User struct {
+	Address
+	FirstName string
+	LastName  string
+}
+ds := goqu.Update("user").Set(
+	User{Address: Address{Street: "111 Street", State: "NY"}, FirstName: "Greg", LastName: "Farley"},
+)
+updateSQL, args, _ := ds.ToSQL()
+fmt.Println(updateSQL, args)
+```
+
+Output:
+```
+UPDATE "user" SET "address_state"='NY',"address_street"='111 Street',"firstname"='Greg',"lastname"='Farley' []
+```
+
+**NOTE** When working with embedded pointers if the embedded struct is nil then the fields will be ignored.
+
+```go
+type Address struct {
+	Street string
+	State  string
+}
+type User struct {
+	*Address
+	FirstName string
+	LastName  string
+}
+ds := goqu.Update("user").Set(
+	User{FirstName: "Greg", LastName: "Farley"},
+)
+updateSQL, args, _ := ds.ToSQL()
+fmt.Println(updateSQL, args)
+```
+
+Output:
+```
+UPDATE "user" SET "firstname"='Greg',"lastname"='Farley' []
+```
+
+You can ignore an embedded struct or struct pointer by using `db:"-"`
+
+```go
+type Address struct {
+	Street string
+	State  string
+}
+type User struct {
+	Address   `db:"-"`
+	FirstName string
+	LastName  string
+}
+ds := goqu.Update("user").Set(
+	User{Address: Address{Street: "111 Street", State: "NY"}, FirstName: "Greg", LastName: "Farley"},
+)
+updateSQL, args, _ := ds.ToSQL()
+fmt.Println(updateSQL, args)
+```
+
+Output:
+```
+UPDATE "user" SET "firstname"='Greg',"lastname"='Farley' []
+```
+
+
 <a name="set-map"></a>
 **[Set with Map](https://godoc.org/github.com/doug-martin/goqu/#UpdateDataset.Set)**