query hints in dsn

Author: Yancey0623

connection.go

@@ -22,7 +22,6 @@ const (
 type odpsConn struct {
 	*http.Client
 	*Config
-	hints map[string]string
 }
 
 // ODPS does not support transaction
@@ -130,7 +129,7 @@ func (conn *odpsConn) wait(query string, args []driver.Value) (string, error) {
 		query = fmt.Sprintf(query, args)
 	}
 
-	ins, err := conn.createInstance(newSQLJob(query, conn.hints))
+	ins, err := conn.createInstance(newSQLJob(query, conn.QueryHints))
 	if err != nil {
 		return "", err
 	}

driver.go

@@ -8,26 +8,16 @@ import (
 
 // register driver
 func init() {
-	sql.Register("maxcompute", &MaxcomputeDriver{})
+	sql.Register("maxcompute", &Driver{})
 }
 
-// MaxcomputeDriver impls database/sql/driver.Driver
-type MaxcomputeDriver struct {
-	conn odpsConn
-}
+// impls database/sql/driver.Driver
+type Driver struct{}
 
-func (o MaxcomputeDriver) Open(dsn string) (driver.Conn, error) {
+func (d Driver) Open(dsn string) (driver.Conn, error) {
 	cfg, err := ParseDSN(dsn)
 	if err != nil {
 		return nil, err
 	}
-	o.conn = odpsConn{&http.Client{}, cfg, nil}
-	return &o.conn, nil
-}
-
-// SetQuerySettings sets the global query settings.
-// TODO(Yancey1989): add the one-off query settings interface.
-func (o MaxcomputeDriver) SetQuerySettings(hints map[string]string) error {
-	o.conn.hints = hints
-	return nil
+	return &odpsConn{&http.Client{}, cfg}, nil
 }

driver_test.go

@@ -9,10 +9,11 @@ import (
 )
 
 var cfg4test = &Config{
-	AccessID:  os.Getenv("ODPS_ACCESS_ID"),
-	AccessKey: os.Getenv("ODPS_ACCESS_KEY"),
-	Project:   os.Getenv("ODPS_PROJECT"),
-	Endpoint:  os.Getenv("ODPS_ENDPOINT"),
+	AccessID:   os.Getenv("ODPS_ACCESS_ID"),
+	AccessKey:  os.Getenv("ODPS_ACCESS_KEY"),
+	Project:    os.Getenv("ODPS_PROJECT"),
+	Endpoint:   os.Getenv("ODPS_ENDPOINT"),
+	QueryHints: map[string]string{"hints_odps.sql.mapper.split_size": "16"},
 }
 
 func TestSQLOpen(t *testing.T) {
@@ -26,7 +27,6 @@ func TestQuerySettings(t *testing.T) {
 	a := assert.New(t)
 	db, err := sql.Open("maxcompute", cfg4test.FormatDSN())
 	a.NoError(err)
-	db.Driver().(*MaxcomputeDriver).SetQuerySettings(map[string]string{"odps.sql.mapper.split.size": "16"})
 	_, err = db.Query("SELECT * FROM gomaxcompute_test LIMIT;")
 	a.NoError(err)
 }

dsn.go

@@ -2,6 +2,7 @@ package gomaxcompute
 
 import (
 	"fmt"
+	"net/url"
 	"regexp"
 	"strings"
 )
@@ -13,10 +14,11 @@ var (
 )
 
 type Config struct {
-	AccessID  string
-	AccessKey string
-	Project   string
-	Endpoint  string
+	AccessID   string
+	AccessKey  string
+	Project    string
+	Endpoint   string
+	QueryHints map[string]string
 }
 
 func ParseDSN(dsn string) (*Config, error) {
@@ -26,32 +28,41 @@ func ParseDSN(dsn string) (*Config, error) {
 	}
 	id, key, endpointURL := sub[1], sub[2], sub[3]
 
-	query := make(map[string]string)
-	for _, s := range strings.Split(sub[4], "&") {
-		pair := reQuery.FindStringSubmatch(s)
-		if len(pair) != 3 {
-			return nil, fmt.Errorf("dsn %s doesn't match access_id:access_key@url?curr_project=project&scheme=http|https", dsn)
-		}
-		if pair[1] != "scheme" && pair[1] != currentProject {
-			return nil, fmt.Errorf("dsn %s 's query is neither scheme or %s", dsn, currentProject)
-		}
-		query[pair[1]] = pair[2]
+	var schemeArgs []string
+	var currProjArgs []string
+	var ok bool
+	queryHints := make(map[string]string)
+
+	querys, err := url.ParseQuery(sub[4])
+	if err != nil {
+		return nil, err
+	}
+
+	if schemeArgs, ok = querys["scheme"]; !ok || len(schemeArgs) != 1 {
+		return nil, fmt.Errorf("dsn %s should have one scheme argument", dsn)
 	}
-	if _, ok := query[currentProject]; !ok {
-		return nil, fmt.Errorf("dsn %s doesn't have curr_project", dsn)
+	if currProjArgs, ok = querys[currentProject]; !ok || len(currProjArgs) != 1 {
+		return nil, fmt.Errorf("dsn %s should have one current_project argument", dsn)
 	}
-	if _, ok := query["scheme"]; !ok {
-		return nil, fmt.Errorf("dsn %s doesn't have scheme", dsn)
+
+	for k, v := range querys {
+		// The query args such as hints_odps.sql.mapper.split_size=16
+		// would be converted to the maxcompute query hints: {"odps.sql.mapper.split_size": "16"}
+		if strings.HasPrefix(k, "hints_") {
+			queryHints[k[6:]] = v[0]
+		}
 	}
-	if query["scheme"] != "http" && query["scheme"] != "https" {
+
+	if schemeArgs[0] != "http" && schemeArgs[0] != "https" {
 		return nil, fmt.Errorf("dsn %s 's scheme is neither http nor https", dsn)
 	}
 
 	config := &Config{
-		AccessID:  id,
-		AccessKey: key,
-		Project:   query[currentProject],
-		Endpoint:  query["scheme"] + "://" + endpointURL}
+		AccessID:   id,
+		AccessKey:  key,
+		Project:    currProjArgs[0],
+		Endpoint:   schemeArgs[0] + "://" + endpointURL,
+		QueryHints: queryHints}
 
 	return config, nil
 }
@@ -62,6 +73,12 @@ func (cfg *Config) FormatDSN() string {
 		return ""
 	}
 	scheme, endpointURL := pair[0], pair[1]
-	return fmt.Sprintf("%s:%s@%s?curr_project=%s&scheme=%s",
+	dsnFormt := fmt.Sprintf("%s:%s@%s?curr_project=%s&scheme=%s",
 		cfg.AccessID, cfg.AccessKey, endpointURL, cfg.Project, scheme)
+	if len(cfg.QueryHints) != 0 {
+		for k, v := range cfg.QueryHints {
+			dsnFormt = fmt.Sprintf("%s&hints_%s=%v", dsnFormt, k, v)
+		}
+	}
+	return dsnFormt
 }

dsn_test.go

@@ -9,13 +9,14 @@ import (
 func TestConfig_ParseDSN(t *testing.T) {
 	a := assert.New(t)
 
-	correct := "access_id:[email protected]/api?curr_project=test_ci&scheme=http"
+	correct := "access_id:[email protected]/api?curr_project=test_ci&scheme=http&hints_odps.sql.mapper.split_size=16"
 	config, err := ParseDSN(correct)
 	a.NoError(err)
 	a.Equal("access_id", config.AccessID)
 	a.Equal("access_key", config.AccessKey)
 	a.Equal("test_ci", config.Project)
 	a.Equal("http://service.com/api", config.Endpoint)
+	a.Equal("16", config.QueryHints["odps.sql.mapper.split_size"])
 
 	badDSN := []string{
 		"", // empty
@@ -46,11 +47,13 @@ func TestConfig_ParseDSN(t *testing.T) {
 func TestConfig_FormatDSN(t *testing.T) {
 	a := assert.New(t)
 	config := Config{
-		AccessID:  "access_id",
-		AccessKey: "access_key",
-		Project:   "test_ci",
-		Endpoint:  "http://service.com/api"}
-	a.Equal("access_id:[email protected]/api?curr_project=test_ci&scheme=http", config.FormatDSN())
+		AccessID:   "access_id",
+		AccessKey:  "access_key",
+		Project:    "test_ci",
+		Endpoint:   "http://service.com/api",
+		QueryHints: map[string]string{"odps.sql.mapper.split_size": "16"}}
+	a.Equal("access_id:[email protected]/api?curr_project="+
+		"test_ci&scheme=http&hints_odps.sql.mapper.split_size=16", config.FormatDSN())
 }
 
 func TestConfig_ParseAndFormatRoundTrip(t *testing.T) {