カスタムアクション

実装済み

独自の SQL テンプレートを、テーブル、ビュー、ルーチンの右クリックアクションとして使えるようにします。

独自の SQL テンプレートを、テーブル、ビュー、プロシージャ、関数の右クリックコマンドにできます。開く ツール › テンプレートエクスプローラー、次のテンプレートを作成または編集します マイテンプレート、そして次のチェックボックスをオンにします エクスプローラーの右クリックメニューに表示(カスタムアクション)。どのオブジェクト種別に適用するかを選びます(既定では 4 つすべて。少なくとも 1 つはチェックを入れたままにする必要があります)。その後、オブジェクトエクスプローラーで該当するオブジェクトを右クリックすると、テンプレートが次の下に表示されます ツール › カスタムアクション。マテリアライズドビューにはカスタムアクションはありません。

SQLly
2 つのユーザーテンプレートを一覧表示する「カスタムアクション」サブメニューが付いた、テーブルの右クリックメニュー。2 つのユーザーテンプレートを一覧表示する「カスタムアクション」サブメニューが付いた、テーブルの右クリックメニュー。
2 つのユーザーテンプレートを一覧表示する「カスタムアクション」サブメニューが付いた、テーブルの右クリックメニュー。

プレースホルダー

SQLly は、スクリプトを開く前に、右クリックしたオブジェクトからこれらのプレースホルダーを埋めます。名前は、スクリプトが開く接続のダイアレクトで、引用符付き識別子として書き込まれます ([Orders] SQL Server では、 "Orders" PostgreSQL で、 `Orders` MySQL の場合)。そのため、スペース、予約語、引用符を含む名前も 1 つの識別子のままで、余分な SQL になることはありません。

プレースホルダー変換後
{server}エクスプローラーに表示される接続の表示名で、識別子として引用符で囲まれたもの。
{database}オブジェクトが存在するデータベース(引用符付き)。
{schema}オブジェクトのスキーマ(引用符付き。スキーマのないエンジンでは空)。
{object}オブジェクト自身の名前(引用符付き)。
{kind}table, view, procedure、または function.

それぞれの {server}, {database}, {schema}、そして {object} 他に 2 つの形式があります:

  • {object:literal} 名前を、接続の方言に合わせた、エスケープ済みの完全な文字列リテラルとして書き出します。引用符も含みます(N'Orders' SQL Server では、 'Orders' それ以外の場所)。関数が名前をテキストとして受け取る場所ならどこでも使えます。たとえば OBJECT_ID({object:literal}).
  • {object:raw} 引用符やエスケープなしで名前をそのまま書き出します。改行のみがスペースに置き換えられます。コメントやラベル用です。引用符を含む名前が外に飛び出してしまうため、SQL の中や独自の引用符の中には置かないでください。

各プレースホルダーは必ず 1 回だけ置換されます。たまたまプレースホルダー形式のテキストを含む名前、たとえば {schema} または <n,int,5>、そのまま書き込まれ、再度展開されることはありません。文字列内の JSON など、これらのプレースホルダーのどれにも一致しない波括弧は、そのまま残されます。

SSMSスタイル <name,type,default> パラメーターは同じテンプレートでも引き続き動作します。テンプレートにパラメーターがある場合、カスタムアクションをクリックすると、まず小さな パラメーター パラメーターごとに1つのボックスがあり、デフォルト値が入力されたダイアログ。必要なものを変更して、次を押します スクリプト (または 実行 実行アクション用)、または 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 は、クリックしたとき (およびパラメーターを確認したときにもう一度) にテンプレートを名前で検索するため、テンプレートエクスプローラーで保存した編集はすぐに反映されます。テンプレートを削除すると、そのメニュー項目が削除されます。SQLly はテンプレートをメモリに保持し、テンプレートファイルを監視しているため、SQLly の外でファイルに加えた変更は、保存の少し後にメニューに表示されます。保存されたテンプレートファイルを読み取れない場合、 カスタムアクション は何も一覧表示せず、アクションを実行するとステータスバーのメッセージとともに停止し、テンプレートエクスプローラーはファイルを上書きせずに問題を示します。