add StructTagKeyIs

Forgot this in 0.1.0. Without this, I cannot migrate existing Gorp users
because Gorp does not understand `db:",auto"`.

1 files changed, 8 insertions, 0 deletions

diff --git a/oblast.go b/oblast.go
index 52c0cfd..338f245 100644
--- a/oblast.go
+++ b/oblast.go
@@ -123,6 +123,14 @@ func PrimaryKeyIs(columnNames ...string) PlanOption {
 	return func(opts *planOpts) { opts.PrimaryKeyColumnNames = columnNames }
 }
 
+// StructTagKeyIs is a PlanOption for record types that allows renaming the struct tag key that Oblast inspects from its default value of "db".
+// For example, providing StructTagKeyIs("oblast") means that a struct tag like `db:",auto"` must be written as `oblast:",auto"` instead.
+//
+// This is useful when migrating from or to another ORM library that uses the same `db:"..."` tag as Oblast, but with conflicting semantics.
+func StructTagKeyIs(key string) PlanOption {
+	return func(opts *planOpts) { opts.StructTagKey = key }
+}
+
 // Handle is an interface for functions providing direct DB access.
 // It covers methods provided by both *sql.DB and *sql.Tx, thus allowing functions using it to be used both within and outside of transactions.
 type Handle interface {