自定义操作
功能的把你自己的 SQL 模板变成表、视图和例程上的右键操作。
将你自己的任何 SQL 模板变成对表、视图、存储过程和函数的右键命令。打开 工具 › 模板资源管理器,创建或编辑模板的位置在 我的模板,并勾选 在资源管理器右键菜单中显示(自定义操作)。选择哪些对象类型会应用它(默认全部四种;至少保留一种勾选)。此后,在对象资源管理器中右键匹配的对象,就能在 工具 › 自定义操作。物化视图不能配置自定义操作。


占位符
SQLly 会在打开脚本之前,用你右键点击的对象填充这些占位符。名称会按脚本所打开连接的方言写成带引号的标识符([Orders] 在 SQL Server 上, "Orders" 在 PostgreSQL 上, `Orders` 在 MySQL 上),因此带有空格、保留字或引号字符的名称保持为一个标识符,不会变成额外的 SQL。
| 占位符 | 将变为 |
|---|---|
{server} | 连接的显示名称,与资源管理器中显示的一致,并按标识符加引号。 |
{database} | 对象所在的数据库名称,带引号。 |
{schema} | 对象的模式,带引号(在没有模式的引擎上为空)。 |
{object} | 对象自身的名称,带引号。 |
{kind} | table, view, procedure,或 function. |
其中每个 {server}, {database}, {schema},以及 {object} 有另外两种形式:
{object:literal}将名称写为连接方言中的完整转义字符串字面值,包括引号(N'Orders'在 SQL Server 上,'Orders'其他地方)。凡是函数需要以文本形式接收名称的场合都可以用它,例如OBJECT_ID({object:literal}).{object:raw}只写裸名称,不加引号或转义;只有换行符会被转换为空格。它用于注释和标签。不要把它放在 SQL 中或你自己的引号里,因为包含引号字符的名称会导致跳出。
每个占位符只会被替换一次。恰好含有占位符文本的名称,例如 {schema} 或者 <n,int,5>,会按原样写出,之后不会再展开。不匹配这些占位符的大括号,比如字符串里的 JSON,会保持原样。
SSMS 风格的 <name,type,default> 参数在同一个模板中仍然有效。模板里带参数时,点击它的自定义操作会先打开一个小型的 参数 对话框,每个参数一个输入框,已填入默认值。改好需要改的部分,然后按 生成脚本 (或者 运行 ,用于运行操作)或 输入; 取消 或者 ESC 不执行任何操作。如同 SSMS,你输入的内容会按原样替换该占位符的每一处,不会加引号,所以值可以是数字、名称,也可以是整个条件。不带参数的模板会跳过对话框。像下面这个模板会列出你右键的任意表的前几行:
-- {kind} {object:raw} on {server:raw}
SELECT TOP <top_n,int,100> * FROM {schema}.{object};
生成脚本或运行
默认情况下,自定义操作 脚本: 填好的 SQL 会在该对象自己的连接和数据库上开一个新查询标签页,供你审阅。要跳过审阅,请勾选 立即运行 在模板上。这些操作会 (运行) 在菜单中其名称之后。
只有当填入参数值后其 SQL 是只读的(仅 SELECT 语句,且引擎的只读检查没有标记任何内容)。其他任何情况,例如 UPDATE、 DROP,或者存储过程调用——都会先打开标签页,并在确认对话框里先给你看 SQL,无论该连接有没有开启数据更改审查。在此之上,所有常规执行防护依然生效,包括仅限 SELECT 的连接、生产环境锁和租户限定。
SQLly 在你点击时按名称查找模板(确认其参数时会再次查找),因此你在模板资源管理器里保存的修改会立即生效。删除模板会同时移除它的菜单项。SQLly 把模板保存在内存中并监视模板文件,因此在 SQLly 之外对文件做的修改保存片刻后就会反映到菜单里。如果保存的模板文件无法读取, 自定义操作 不会列出任何内容,运行操作时会停止并在状态栏显示一条消息,模板资源管理器会指出问题所在,而不是直接覆盖文件。