テナントスコープ

実装済み

マルチテナントのフィルター欠落ガードの設定: 有効にするかどうか、テナント列、テナントテーブル。

SQLly のマルチテナント フィルター未指定ガード 現在のデータベース用。4 つのモードがあります: オフ (デフォルトでは、テナント関連は何も表示されません)、 許可済み (テナントフィルターを認識し、しつこく警告しない)、 警告 (テナント述語なしでテナントスコープのテーブルにクエリすると、検証の警告が出ます)、および 必須 (その省略はブロッキングエラーになり、実行が拒否されます)。これが、SQLly に対して「テナントフィルターの付け忘れ」が何を意味するかを教える方法です。 あなたの スキーマ。

オンにするまでオフです。 すべてのデータベースは「オフ」から始まります。次の設定でそのデータベースに「許可」「警告」「必須」を選ぶまで、テナント警告も実行のブロックもありません ツール › テナントスコープ。SQLly が SQL をチェックするあらゆる場所(デスクトップアプリ、ブラウザープレビュー、言語サーバー、コマンドラインエンジン)で、同じ既定値が適用されます。

テナント列を空白のままにすると、ガードは通常の慣例を使用します - TenantId, AccountId, OrganizationId, OrgId およびそのアンダースコア付きの形式 - または独自の列名を指定して検出を絞り込みます。必要に応じて、ID列と表示名列を指定してテナントテーブル自体を指すこともできます。変更はキーストロークごとに保存され、次の検証に適用されます。設定はサーバーとデータベースごとに、SQLlyの他の設定と同様、プレーンなローカルファイルに保存されます。

ガードであって、書き換えではありません。 テナントスコープが WHERE 句を挿入したり SQL を編集したりすることはありません。書かれた内容を検査するだけで、必須モードでもブロックするのは、テナントフィルターの欠落が確定した診断だけです。推測で止めることはせず、フェイルオープンします。
SQLly
SQLly テナントスコープ設定SQLly テナントスコープ設定
テナントスコープ: データベースのガードを有効にし、テナント列とテナントテーブルの名前を指定します。

SaaS データベース向けの設定

  1. データベースを右クリックし、次を選択します ツール › テナントスコープ...、または次を実行 テナントスコープ 次から コマンドパレット 接続中に。タイトルには、構成中のサーバーとデータベースが表示されます。
  2. モードを選びます。ボタンの下にある 1 行の説明に、選択したモードの動作が表示されます。
  3. テナント列が一般的な名前のいずれでもない場合(たとえば customer_id - 次に入力します テナント列。列を指定すると、その列だけがテーブルをテナントスコープとしてマークします。
  4. 必要に応じて入力します テナントテーブル。その テナント ID 列 そして テナント表示名列 テーブル名を指定すると、フィールドが表示されます。
  5. ダイアログを閉じます。保存ボタンはありません。すべての変更はすでに保存されています。

ガードがチェックする内容

テーブルは次として扱われます テナントスコープ テナント列がある場合に適用されます。このテーブルを読み取り、更新、削除するステートメントは、その列を WHERE または JOIN ... ON 条件:

SELECT total FROM dbo.orders;                         -- flagged
SELECT total FROM dbo.orders WHERE tenant_id = 7;  -- fine
SELECT o.total FROM dbo.orders o
JOIN dbo.users u ON o.tenant_id = u.tenant_id;       -- fine

最初のステートメントにはエディターに検証の診断が表示され、そのメッセージはたとえば `dbo.orders` は `tenant_id` でテナント分離されていますが、このステートメントの WHERE にも JOIN ON にも `tenant_id` のフィルターがありません.

  • INSERT は対象外 - 新しい行には、それぞれ独自のテナント値が入ります。
  • テナントレジストリは対象外です - 主キーがテナント列であるテーブル。たとえば tenants(tenant_id, name)、テナントデータではなく、テナントの一覧です。
  • このチェックは、条件の中の列を調べます。比較する値の内容までは判断しません。

4 つのモード

モード効果
オフすべてのデータベースの既定です。ガードは無効で、テナント関連のものは何も表示されません。フィールドは非表示で、「オフ」では列やテーブルの設定は保存されないため、「オフ」のままダイアログを閉じると、それらは破棄されます。
許可済みテナントフィルターの欠落に関する警告やエラーはありません。列とテーブルの設定は保持されます。
警告フィルターの欠落は検証警告です。実行は引き続き可能です。
必須フィルターの欠落は検証エラーです。「実行」を押すとバッチは拒否され、メッセージがステータスバーに表示されます。複数のターゲットに対して同時に実行する場合も同様です。

保存場所

設定は、サーバー名とデータベース名(大文字小文字を区別しない)をキーとして JSON で保存されます。保存先は tenant-scoping.json SQLly のアプリケーションデータフォルダー (macOS の場合) ~/Library/Application Support/SQLLY)。設定していないデータベースはオフモードです。ブラウザープレビューでは、設定は現在のセッション限りで保持されます。

以前のバージョンからアップグレードしますか? 新しいバージョンの初回起動時に、以前保存されたテナントスコープの設定を、1 回だけすべてクリアします。「警告」や「必須」に設定していたデータベースも含まれます。データベースでガードを有効にしたい場合は、テナントスコープを開いてもう一度オンにしてください。

ガードがテーブルをテナントスコープと判断するには、読み込まれたスキーマモデルからテーブルの列を得る必要があります。モデルが知らないテーブルはチェックされません。