org.noear.solon.ai.skills.text2sql

类 Text2SqlSkill

java.lang.Object

org.noear.solon.ai.chat.skill.AbsSkill

org.noear.solon.ai.skills.text2sql.Text2SqlSkill

所有已实现的接口:

Skill

@Preview(value="3.9.1")
public class Text2SqlSkill
extends AbsSkill

智能 Text-to-SQL 专家技能：实现自然语言到结构化查询的桥接。

该技能集成了企业级数据分析所需的深度适配与安全策略：

• 自适应方言引擎：内置多种 SqlDialect，支持对引号、分页、元数据提取等差异进行底层平替，确保 AI 编写的 SQL 具有极高执行率。
• 分级元数据策略：支持 FULL（注入全量 DDL）与 DYNAMIC（仅注入目录，按需探测）两种模式，自动应对超大规模数据表带来的 Token 挑战。
• 执行安全护栏：强制只读校验（SELECT-only）、自动分页注入（LIMIT 防雪崩）以及标识符修复（Alias Repairing）。
• 语义关联引导：自动提取外键关系（Foreign Keys）与表备注，为 AI 提供语义化的“关联线索”，提升多表 Join 的准确性。

从以下版本开始:

3.9.1

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	cachedSchemaInfo
protected SqlDialect	dialect
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	globalRelations
protected static org.slf4j.Logger	LOG
protected int	maxContextLength
protected int	maxRows
protected boolean	readOnly
protected SchemaMode	schemaMode
protected org.noear.solon.data.sql.SqlUtils	sqlUtils
protected java.util.List<java.lang.String>	tableNames
protected java.util.Map<java.lang.String,java.lang.String>	tableRemarksMap

从类继承的字段 org.noear.solon.ai.chat.skill.AbsSkill

tools

构造器概要

构造器

构造器和说明
Text2SqlSkill(javax.sql.DataSource dataSource, java.lang.String... tables)
Text2SqlSkill(org.noear.solon.data.sql.SqlUtils sqlUtils, java.lang.String... tables)

方法概要

限定符和类型	方法和说明
java.lang.String	description() 获取技能描述
Text2SqlSkill	dialect(SqlDialect dialect)
java.lang.String	executeSql(java.lang.String sql)
protected java.lang.String	extractSchemaInfo(java.util.List<java.lang.String> tables)
java.lang.String	getInstruction(Prompt prompt) 动态指令注入：生成并注入到 System Message 的描述性文本（如果使用 MD 层级，从第三级开始） 用于约束 AI 如何使用该技能下的工具
java.lang.String	getTableSchema(java.lang.String tableName)
java.util.Collection<FunctionTool>	getTools(Prompt prompt) 动态工具注入：获取该技能挂载的所有功能工具
Text2SqlSkill	maxContextLength(int length)
Text2SqlSkill	maxRows(int maxRows)
java.lang.String	name() 获取技能名称（默认类名）
void	onAttach(Prompt prompt) 挂载钩子：技能被激活时触发 可用于初始化会话状态、审计日志记录或上下文预处理
Text2SqlSkill	readOnly(boolean readOnly)
Text2SqlSkill	schemaMode(SchemaMode schemaMode)

从类继承的方法 org.noear.solon.ai.chat.skill.AbsSkill

metadata

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.noear.solon.ai.chat.skill.Skill

isSupported

字段详细资料

LOG

protected static final org.slf4j.Logger LOG

sqlUtils

protected final org.noear.solon.data.sql.SqlUtils sqlUtils

tableNames

protected final java.util.List<java.lang.String> tableNames

tableRemarksMap

protected final java.util.Map<java.lang.String,java.lang.String> tableRemarksMap

globalRelations

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> globalRelations

dialect

protected SqlDialect dialect

cachedSchemaInfo

protected java.lang.String cachedSchemaInfo

maxRows

protected int maxRows

maxContextLength

protected int maxContextLength

schemaMode

protected SchemaMode schemaMode

readOnly

protected boolean readOnly

构造器详细资料

Text2SqlSkill

public Text2SqlSkill(javax.sql.DataSource dataSource,
                     java.lang.String... tables)

Text2SqlSkill

public Text2SqlSkill(org.noear.solon.data.sql.SqlUtils sqlUtils,
                     java.lang.String... tables)

方法详细资料

maxRows

public Text2SqlSkill maxRows(int maxRows)

maxContextLength

public Text2SqlSkill maxContextLength(int length)

schemaMode

public Text2SqlSkill schemaMode(SchemaMode schemaMode)

readOnly

public Text2SqlSkill readOnly(boolean readOnly)

dialect

public Text2SqlSkill dialect(SqlDialect dialect)

name

public java.lang.String name()

从接口复制的说明: Skill

获取技能名称（默认类名）

description

public java.lang.String description()

从接口复制的说明: Skill

获取技能描述

onAttach

public void onAttach(Prompt prompt)

从接口复制的说明: Skill

挂载钩子：技能被激活时触发 可用于初始化会话状态、审计日志记录或上下文预处理

getInstruction

public java.lang.String getInstruction(Prompt prompt)

从接口复制的说明: Skill

动态指令注入：生成并注入到 System Message 的描述性文本（如果使用 MD 层级，从第三级开始） 用于约束 AI 如何使用该技能下的工具

executeSql

@ToolMapping(name="execute_sql",
             description="\u6267\u884c\u5355\u6761 SELECT \u67e5\u8be2\u8bed\u53e5\u3002")
public java.lang.String executeSql(@Param(value="sql")
                                                                                                                                                               java.lang.String sql)

getTableSchema

@ToolMapping(name="get_table_schema",
             description="\u83b7\u53d6\u7279\u5b9a\u8868\u7684\u8be6\u7ec6\u5217\u4fe1\u606f\u548c DDL")
public java.lang.String getTableSchema(@Param(value="tableName")
                                                                                                                                                                                      java.lang.String tableName)

extractSchemaInfo

protected java.lang.String extractSchemaInfo(java.util.List<java.lang.String> tables)

getTools

public java.util.Collection<FunctionTool> getTools(Prompt prompt)

从接口复制的说明: Skill

动态工具注入：获取该技能挂载的所有功能工具

指定者:

getTools 在接口中 Skill

覆盖:

getTools 在类中 AbsSkill