Browse Source

bug(doc): mysql conf must be exported

ngjaying 4 years atrás
parent
commit
915b756da2
2 changed files with 16 additions and 16 deletions
  1. 8 8
      docs/en_US/plugins/plugins_tutorial.md
  2. 8 8
      docs/zh_CN/plugins/plugins_tutorial.md

+ 8 - 8
docs/en_US/plugins/plugins_tutorial.md

@@ -76,8 +76,8 @@ import (
 )
 
 type mysqlConfig struct {
-	url           string   `json:"url"`
-	table         string   `json:"table"`
+	Url   string `json:"url"`
+	Table string `json:"table"`
 }
 
 type mysqlSink struct {
@@ -92,11 +92,11 @@ func (m *mysqlSink) Configure(props map[string]interface{}) error {
 	if err != nil {
 		return fmt.Errorf("read properties %v fail with error: %v", props, err)
 	}
-	if cfg.url == ""{
-		return fmt.Errorf("property url is required")
+	if cfg.Url == "" {
+		return fmt.Errorf("property Url is required")
 	}
-	if cfg.table == ""{
-		return fmt.Errorf("property table is required")
+	if cfg.Table == "" {
+		return fmt.Errorf("property Table is required")
 	}
 	return nil
 }
@@ -104,7 +104,7 @@ func (m *mysqlSink) Configure(props map[string]interface{}) error {
 func (m *mysqlSink) Open(ctx api.StreamContext) (err error) {
 	logger := ctx.GetLogger()
 	logger.Debug("Opening mysql sink")
-	m.db, err = sql.Open("mysql", m.conf.url)
+	m.db, err = sql.Open("mysql", m.conf.Url)
 	return
 }
 
@@ -117,7 +117,7 @@ func (m *mysqlSink) Collect(ctx api.StreamContext, item interface{}) error {
 		// And it is possible to be any other kind of data if the sink `dataTemplate` is set
 		logger.Debugf("mysql sink receive %s", item)
 		//TODO hard coded column here. In production, we'd better get the column/value pair from the item
-		sql := fmt.Sprintf("INSERT INTO %s (`name`) VALUES ('%s')", m.conf.table, v)
+		sql := fmt.Sprintf("INSERT INTO %s (`name`) VALUES ('%s')", m.conf.Table, v)
 		logger.Debugf(sql)
 		insert, err := m.db.Query(sql)
 		if err != nil {

+ 8 - 8
docs/zh_CN/plugins/plugins_tutorial.md

@@ -75,8 +75,8 @@ import (
 )
 
 type mysqlConfig struct {
-	url           string   `json:"url"`
-	table         string   `json:"table"`
+	Url   string `json:"url"`
+	Table string `json:"table"`
 }
 
 type mysqlSink struct {
@@ -91,11 +91,11 @@ func (m *mysqlSink) Configure(props map[string]interface{}) error {
 	if err != nil {
 		return fmt.Errorf("read properties %v fail with error: %v", props, err)
 	}
-	if cfg.url == ""{
-		return fmt.Errorf("property url is required")
+	if cfg.Url == ""{
+		return fmt.Errorf("property Url is required")
 	}
-	if cfg.table == ""{
-		return fmt.Errorf("property table is required")
+	if cfg.Table == ""{
+		return fmt.Errorf("property Table is required")
 	}
 	return nil
 }
@@ -103,7 +103,7 @@ func (m *mysqlSink) Configure(props map[string]interface{}) error {
 func (m *mysqlSink) Open(ctx api.StreamContext) (err error) {
 	logger := ctx.GetLogger()
 	logger.Debug("Opening mysql sink")
-	m.db, err = sql.Open("mysql", m.conf.url)
+	m.db, err = sql.Open("mysql", m.conf.Url)
 	return
 }
 
@@ -116,7 +116,7 @@ func (m *mysqlSink) Collect(ctx api.StreamContext, item interface{}) error {
         // 如果sink的`dataTemplate`属性有设置,则可能为各种其他的类型		
 		logger.Debugf("mysql sink receive %s", item)
 		//TODO 此处列名写死。生产环境中一般可从item中的键值对获取列名
-		sql := fmt.Sprintf("INSERT INTO %s (`name`) VALUES ('%s')", m.conf.table, v)
+		sql := fmt.Sprintf("INSERT INTO %s (`name`) VALUES ('%s')", m.conf.Table, v)
 		logger.Debugf(sql)
 		insert, err := m.db.Query(sql)
 		if err != nil {