Пользовательские действия

функциональный

Превратите собственные шаблоны SQL в действия по правому клику для таблиц, представлений и процедур.

Преобразуйте любой из ваших собственных SQL-шаблонов в команду правого клика для таблиц, представлений, процедур и функций. Откройте Инструменты › Обозреватель шаблонов, создайте или отредактируйте шаблон в Мои шаблоны, и отметьте Показать в контекстном меню обозревателя (Пользовательские действия). Выберите, к каким типам объектов он будет применяться (по умолчанию ко всем четырем; хотя бы один должен оставаться отмеченным). После этого при щелчке правой кнопкой мыши на соответствующем объекте в Обозревателе объектов шаблон будет отображаться в разделе Инструменты › Пользовательские действия. Для материализованных представлений пользовательские действия недоступны.

SQLly
Контекстное меню таблицы с подменю «Настраиваемые действия», в котором перечислены два шаблона пользователя.Контекстное меню таблицы с подменю «Настраиваемые действия», в котором перечислены два шаблона пользователя.
Контекстное меню таблицы с подменю «Настраиваемые действия», в котором перечислены два шаблона пользователя.

Заполнители

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> по-прежнему работают в том же шаблоне. Когда у шаблона есть параметры, щелчок по его пользовательскому действию сначала откроет небольшой Параметры диалог с одним полем на каждый параметр, где уже подставлено значение по умолчанию. Измените то, что нужно, и нажмите Скрипт (или Выполнить для действия запуска) или Enter; Отмена или 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 ищет шаблон по имени при клике (и снова при подтверждении его параметров), поэтому изменения, которые вы сохраняете в Template Explorer, вступают в силу сразу. Удаление шаблона удаляет его запись в меню. SQLly хранит ваши шаблоны в памяти и отслеживает файл шаблона, поэтому изменение, внесенное в файл вне SQLly, отобразится в меню через мгновение после сохранения. Если сохраненный файл шаблона невозможно прочитать, Пользовательские действия ничего не перечисляется, выполнение действия останавливается с сообщением в строке состояния, а Template Explorer указывает на проблему вместо того, чтобы перезаписывать файл.