基础逻辑完成

Author: wangle201210

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -1,2 +1,72 @@
-# text2sql
-将自然语言转换为对应的SQL查询语句
+# Text2SQL
+
+一个基于自然语言处理的工具，可以将自然语言转换为对应的SQL查询语句。
+
+## 功能特点
+
+- 支持将中文自然语言转换为SQL查询语句
+- 自动验证生成的SQL语句的正确性
+- 支持多次重试以提高成功率
+- 可选择是否执行生成的SQL语句
+
+## 安装
+
+```bash
+go get github.com/wangle201210/text2sql
+```
+
+## 使用方法
+
+### 基本用法
+
+```go
+package main
+
+import (
+    "github.com/wangle201210/text2sql"
+    "fmt"
+)
+
+func main() {
+    client := &text2sql.Text2sql{
+        DbLink:    "root:password@tcp(127.0.0.1:3306)/database?charset=utf8mb4&parseTime=True&loc=Local",
+        Try:       5,      // 失败时的重试次数
+        ShouldRun: true,   // 是否执行生成的SQL
+    }
+    
+    // 将中文问题转换为SQL并执行
+    sql, result, err := client.Do("王五的openid")
+    if err != nil {
+        panic(err)
+    }
+    
+    fmt.Printf("生成的SQL: %s\n", sql)
+    fmt.Printf("执行结果: %v\n", result)
+}
+```
+
+### 配置说明
+
+- `DbLink`: MySQL数据库连接信息
+- `Try`: SQL生成失败时的重试次数
+- `ShouldRun`: 是否执行生成的SQL语句
+    - 设置为`true`时会执行SQL并返回结果
+    - 设置为`false`时只返回生成的SQL语句
+
+
+## 注意事项
+
+1. 确保数据库连接字符串中包含正确的用户名、密码和数据库名
+2. 建议在生产环境中适当设置重试次数，避免过多重试
+3. 如果只需要生成SQL而不执行，请将`ShouldRun`设置为`false`
+4. 用例的数据在[note20250226.sql](./note20250226.sql)
+
+## 依赖
+
+- gorm.io/gorm
+- gorm.io/driver/mysql
+- github.com/cloudwego/eino
+
+## 许可证
+
+MIT License

eino/eino.go

@@ -0,0 +1,14 @@
+package eino
+
+import (
+	"context"
+)
+
+func GetSQL(ddl, question string) (sql string) {
+	ctx := context.Background()
+	messages := createMessagesFromTemplate(ddl, question)
+	cm := createOpenAIChatModel(ctx)
+	result := generate(ctx, cm, messages)
+	sql = result.Content
+	return
+}

eino/generate.go

@@ -0,0 +1,17 @@
+package eino
+
+import (
+	"context"
+	"log"
+
+	"github.com/cloudwego/eino/components/model"
+	"github.com/cloudwego/eino/schema"
+)
+
+func generate(ctx context.Context, llm model.ChatModel, in []*schema.Message) *schema.Message {
+	result, err := llm.Generate(ctx, in)
+	if err != nil {
+		log.Fatalf("llm generate failed: %v", err)
+	}
+	return result
+}

eino/message.go

@@ -0,0 +1,58 @@
+package eino
+
+import (
+	"context"
+	"log"
+
+	"github.com/cloudwego/eino/components/prompt"
+	"github.com/cloudwego/eino/schema"
+)
+
+const (
+	UnrelatedQuestion = "不相关的问题，请重新提问"
+)
+
+func createTemplate() prompt.ChatTemplate {
+	// 创建模板，使用 FString 格式
+	return prompt.FromMessages(schema.FString,
+		// 系统消息模板
+		schema.SystemMessage("{role}"+
+			"Given an input question, first create a syntactically correct MySQL query to run, then look at the results of the query and return the answer to the input question."+
+			"Unless the user specifies in the question a specific number of examples to obtain, query for at most {limit} results using the LIMIT clause as per MySQL. "+
+			"You can order the results to return the most informative data in the database."+
+			"Never query for all columns from a table. "+
+			"You must query only the columns that are needed to answer the question."+
+			"Wrap each column name in backticks (`) to denote them as delimited identifiers."+
+			"Pay attention to use only the column names you can see in the tables below. "+
+			"Be careful to not query for columns that do not exist. "+
+			"Also, pay attention to which column is in which table."+
+			"Pay attention to use CURDATE() function to get the current date, if the question involves \"today\"."+
+			"Can only perform queries and does not accept any modification or deletion functions."+
+			"Use the following table schema info to create your SQL query:\n{ddl}"+
+			"返回内容只能包含SQL语句，不包含解释及其他信息也不要加上sql标签。",
+		// "通过分析用户的提问与数据库表结构之间的关系，生成相应的SQL查询语句。如果提问的内容与现有的数据库表结构没有任何关联，返回：\"{unrelated}\"。",
+		),
+		// 插入需要的对话历史（新对话的话这里不填）
+		schema.MessagesPlaceholder("chat_history", true),
+
+		// 用户消息模板
+		schema.UserMessage("Question: {question}"),
+	)
+}
+
+func createMessagesFromTemplate(ddl, question string) []*schema.Message {
+	template := createTemplate()
+	// 使用模板生成消息
+	messages, err := template.Format(context.Background(), map[string]any{
+		"role": "You are a MySQL expert.",
+		// "unrelated":    UnrelatedQuestion,
+		"question":     question,
+		"ddl":          ddl,
+		"limit":        10,
+		"chat_history": []*schema.Message{},
+	})
+	if err != nil {
+		log.Fatalf("format template failed: %v\n", err)
+	}
+	return messages
+}

eino/model.go

@@ -0,0 +1,22 @@
+package eino
+
+import (
+	"context"
+	"log"
+	"os"
+
+	"github.com/cloudwego/eino-ext/components/model/openai"
+	"github.com/cloudwego/eino/components/model"
+)
+
+func createOpenAIChatModel(ctx context.Context) model.ChatModel {
+	chatModel, err := openai.NewChatModel(ctx, &openai.ChatModelConfig{
+		Model:   os.Getenv("OPENAI_MODEL_NAME"),
+		APIKey:  os.Getenv("OPENAI_API_KEY"),
+		BaseURL: os.Getenv("OPENAI_BASE_URL"),
+	})
+	if err != nil {
+		log.Fatalf("create openai chat model failed, err=%v", err)
+	}
+	return chatModel
+}

go.mod

@@ -0,0 +1,50 @@
+module github.com/wangle201210/text2sql
+
+go 1.23.0
+
+require (
+	github.com/cloudwego/eino v0.3.13
+	github.com/cloudwego/eino-ext/components/model/openai v0.0.0-20250225083118-fd27d80f189c
+	gorm.io/driver/mysql v1.5.7
+	gorm.io/gorm v1.25.12
+)
+
+require (
+	filippo.io/edwards25519 v1.1.0 // indirect
+	github.com/bytedance/sonic v1.12.2 // indirect
+	github.com/bytedance/sonic/loader v0.2.0 // indirect
+	github.com/cloudwego/base64x v0.1.4 // indirect
+	github.com/cloudwego/eino-ext/libs/acl/openai v0.0.0-20250221090944-e8ef7aabbe10 // indirect
+	github.com/cloudwego/iasm v0.2.0 // indirect
+	github.com/dustin/go-humanize v1.0.1 // indirect
+	github.com/getkin/kin-openapi v0.118.0 // indirect
+	github.com/go-openapi/jsonpointer v0.19.5 // indirect
+	github.com/go-openapi/swag v0.19.5 // indirect
+	github.com/go-sql-driver/mysql v1.9.0 // indirect
+	github.com/goph/emperror v0.17.2 // indirect
+	github.com/invopop/yaml v0.1.0 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/cpuid/v2 v2.0.9 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
+	github.com/nikolalohinski/gonja v1.5.3 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.9 // indirect
+	github.com/perimeterx/marshmallow v1.1.4 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/sashabaranov/go-openai v1.32.5 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/slongfield/pyfmt v0.0.0-20220222012616-ea85ff4c361f // indirect
+	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/yargevad/filepathx v1.0.0 // indirect
+	golang.org/x/arch v0.11.0 // indirect
+	golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1 // indirect
+	golang.org/x/sys v0.28.0 // indirect
+	golang.org/x/text v0.22.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)