Portée du locataire

fonctionnel

Configurer le garde-fou multi-locataire contre les filtres manquants : s'il s'exécute, la colonne du locataire et la table des locataires.

Configurer le multi-locataire de SQLly garde-fou contre les filtres manquants pour la base de données actuelle. Quatre modes : Désactivé (par défaut, rien lié aux locataires n'est affiché), Autorisé (reconnaître les filtres de locataire, ne jamais embêter), Avertir (une table à périmètre de locataire interrogée sans son prédicat de locataire reçoit un avertissement de validation), et Obligatoire (cette omission devient une erreur bloquante et l'exécution refuse de continuer). C'est ainsi que vous enseignez à SQLly ce que signifie « avoir oublié le filtre de locataire » pour votre le schéma.

Désactivé jusqu'à ce que vous l'activiez. Chaque base de données commence en mode Désactivé : pas d'avertissements pour les locataires et pas d'exécutions bloquées tant que vous n'avez pas choisi Autorisé, Avertir ou Requis pour cette base de données dans Outils › Délimitation des locataires. La même valeur par défaut s'applique partout où SQLly vérifie votre SQL - l'application de bureau, l'aperçu dans le navigateur, le serveur de langage et le moteur en ligne de commande.

Laissez la colonne du locataire vide et le garde-fou utilise les conventions habituelles - TenantId, AccountId, OrganizationId, OrgId et leurs formes soulignées - ou nommez votre propre colonne pour affiner la détection. Vous pouvez aussi la faire pointer vers la table des locataires elle-même, avec ses colonnes id et display-name. Les modifications sont enregistrées à chaque frappe et s'appliquent à la validation suivante ; les paramètres sont conservés par serveur et par base de données dans un simple fichier local, comme le reste de votre configuration SQLly.

Un garde-fou, pas un outil de réécriture. La portée du locataire n’injecte jamais de clause WHERE ni ne modifie votre SQL. Elle vérifie seulement ce que vous avez écrit, et même en mode Obligatoire elle ne bloque que sur un diagnostic confirmé de filtre de locataire manquant, en laissant passer (fail open) plutôt que de deviner.
SQLly
Configuration de la délimitation par locataire SQLlyConfiguration de la délimitation par locataire SQLly
Portée du locataire : activez la protection pour une base de données et nommez la colonne du locataire ainsi que la table des locataires.

Configuration pour une base de données SaaS

  1. Cliquez avec le bouton droit sur la base de données et choisissez Outils › Délimitation des locataires..., ou exécutez Portée du locataire depuis la palette de commandes tant que vous y êtes connecté. Le titre affiche le serveur et la base de données en cours de configuration.
  2. Choisissez un mode. Une description sur une seule ligne sous les boutons explique ce que fait le mode sélectionné.
  3. Si votre colonne de locataire ne porte pas l'un des noms habituels - disons qu'elle s'appelle customer_id - tapez-la Colonne du locataire. Une fois que vous nommez une colonne, seule cette colonne marque une table comme délimitée par locataire.
  4. Remplissez éventuellement Table des locataires. Sa Colonne de l'identifiant du locataire et Colonne du nom affiché du locataire champs apparaissent une fois qu'une table est nommée.
  5. Fermez la boîte de dialogue. Il n'y a pas de bouton Enregistrer ; chaque modification est déjà sauvegardée.

Ce que vérifie le garde-fou

Une table est considérée comme délimité par locataire lorsqu'elle possède la colonne de locataire. Une instruction qui lit, met à jour ou supprime des lignes doit mentionner cette colonne dans une WHERE ou JOIN ... ON condition :

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

La première instruction obtient un diagnostic de validation dans l'éditeur, avec un message tel que `dbo.orders` est ciblée par locataire grâce à `tenant_id`, mais l’instruction n’a pas de filtre `tenant_id` dans WHERE ou JOIN ON.

  • INSERT est exempté - les nouvelles lignes portent leur propre valeur de locataire.
  • Le registre des locataires est exempté - une table dont la clé primaire est la colonne locataire, telle que tenants(tenant_id, name), est la liste des locataires, pas les données des locataires.
  • La vérification recherche la colonne dans une condition ; elle ne juge pas la valeur à laquelle vous la comparez.

Les quatre modes

ModeEffet
DésactivéLe mode par défaut pour chaque base de données. La protection est désactivée et rien de lié aux locataires n'est affiché. Les champs sont masqués, et Off ne stocke aucun réglage de colonne ou de table, si bien que fermer la boîte de dialogue en mode Off les perd.
AutoriséAucun avertissement ni erreur concernant les filtres de locataires manquants. Vos paramètres de colonnes et de tables sont conservés.
AvertirUn filtre manquant est un avertissement de validation ; Exécuter fonctionne toujours.
ObligatoireUn filtre manquant est une erreur de validation. Appuyer sur Exécuter refuse le lot et place le message dans la barre d'état, y compris lors de l'exécution contre plusieurs cibles à la fois.

Où il est stocké

Les paramètres sont indexés par nom de serveur et de base de données, en ignorant la casse, et sauvegardés au format JSON dans tenant-scoping.json dans le dossier de données d'application de SQLly (sur macOS, ~/Library/Application Support/SQLLY). Une base de données que vous ne configurez jamais est en mode désactivé. L'aperçu du navigateur garde les paramètres uniquement pour la session en cours.

Mise à niveau depuis une version précédente ? La première fois que la nouvelle version démarre, elle efface tous les paramètres de portée des locataires enregistrés auparavant, une fois - y compris les bases de données que vous aviez définies sur Avertir ou Obligatoire. Si vous voulez activer la protection sur une base de données, ouvrez la Portée des locataires et réactivez-la.

La protection a besoin des colonnes de la table fournies par le modèle de schéma chargé pour savoir qu’une table est limitée à un locataire. Les tables que le modèle ne connaît pas ne sont pas vérifiées.