租户范围

功能的

配置多租户缺失过滤防护:是否启用、租户列以及租户表。

配置 SQLly 的多租户 缺少筛选器保护 用于当前数据库。四种模式: 关闭 (默认情况下不显示任何租户相关内容), 允许 (能识别租户过滤器,从不唠叨), 警告 (在没有租户谓词的情况下查询租户范围表会收到验证警告),以及 强制 (这种遗漏会成为阻塞性错误,“运行”会拒绝执行)。这就是你教 SQLly 明白“忘记租户过滤器”对 你的 模式。

开启之前,它保持关闭。 每个数据库一开始都是 Off:没有租户警告,也不会拦截运行,直到你为该数据库在 工具 › 租户范围限制中为该数据库选择允许、警告或必需。相同的默认设置适用于 SQLly 检查 SQL 的所有地方——桌面应用、浏览器预览、语言服务器以及命令行引擎。

将租户列留空,防护机制会使用常规约定 - TenantId, AccountId, OrganizationId, OrgId 以及带下划线的写法——也可以自己指定列名来缩小识别范围。还可以把它直接指向租户表,使用其中的 id 和显示名称列。每次按键都会保存更改,并在下一次校验时生效;这些设置按“服务器 + 数据库”保存在一个普通的本地文件里,和你其他 SQLly 配置一样。

是防护,不是改写器。 租户范围永远不会注入 WHERE 子句或编辑你的 SQL。它只检查你写的内容,即便在必需模式下,也仅在诊断确认缺少租户过滤器时才阻止运行;无法确定时一律放行,而不是猜测。
SQLly
SQLly 租户范围配置SQLly 租户范围配置
租户范围:为数据库启用保护,并指定租户列和租户表。

为 SaaS 数据库进行设置

  1. 右键点击数据库并选择 工具 › 租户范围限制...,或者运行 租户范围 从 命令面板 在连接到数据库时。标题显示正在配置的服务器和数据库。
  2. 选择一个模式。按钮下方的一行描述解释所选模式的作用。
  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),是租户列表,而不是租户数据。
  • 该检查会查找条件中用到的列;它不会评判你拿它比较的值。

四种模式

模式效果
关闭每个数据库的默认设置。防护处于关闭状态,不显示任何与租户相关的内容。这些字段会被隐藏,Off 状态不存储任何列或表设置,因此在 Off 状态下关闭对话框会丢弃这些设置。
允许不会有关于缺少租户过滤器的警告或错误。你的列和表设置会被保留。
警告缺失的筛选器是验证警告;运行仍然有效。
强制缺少筛选器属于验证错误。按下运行会拒绝整个批次,并把消息放进状态栏,同时对着多个目标运行时也是如此。

存储位置

设置以服务器和数据库名称为键,不区分大小写,并以 JSON 格式保存在 tenant-scoping.json SQLly 的应用数据文件夹中(在 macOS 上, ~/Library/Application Support/SQLLY)。你从未配置的数据库处于关闭模式。浏览器预览仅为当前会话保留设置。

从早期版本升级? 新版首次启动时,会一次性清除之前保存的所有租户范围设置——包括你设为警告或必需的数据库。想让某个数据库重新受到保护,请打开租户范围并重新开启。

防护机制需要从已加载的模式模型中获取表的列信息,才能识别哪些表属于租户范围。模型不了解的表不会检查。