Documenter le schéma

fonctionnel

Générez une documentation Markdown du schéma de la base de données, prête pour un dépôt ou un wiki.

Générer Markdown documentation du schéma de la base de données en une seule étape : choisissez l'action, indiquez où l'enregistrer, et c'est tout. Il n'y a délibérément rien à configurer, le document est construit à partir du modèle de schéma que SQLly a déjà chargé pour IntelliSense, donc aucun aller-retour serveur supplémentaire, et il reflète exactement ce que l'application connaît.

La sortie est un dictionnaire de données avec en en-tête la connexion et la base de données, sectionné en Tables, Vues, Procédures, Fonctions, et Autres objets. Chaque table obtient une grille de colonnes, nom, type, nullabilité, valeur par défaut et annotations de clé (clé primaire, identité, FK → cible) - plus ses clés étrangères sous forme de liste ; les routines obtiennent leurs signatures de paramètres et types de retour. Les schémas très volumineux sont automatiquement séparés en un fichier d'index plus un fichier par schéma, afin que le résultat reste navigable dans un dépôt ou un wiki.

SQLly
Sortie du schéma de document SQLly (Markdown)Sortie du schéma de document SQLly (Markdown)
Documenter le schéma : la structure de la base de données rendue en documentation Markdown prête à être enregistrée.

Rédaction d'un dictionnaire de données

  1. Connectez-vous et laissez le modèle de schéma se charger (c'est le même modèle qui alimente l'autocomplétion). S'il n'a pas encore chargé, SQLly l'indique dans la barre d'état et ne fait rien.
  2. Cliquez avec le bouton droit sur la base de données dans l'explorateur et choisissez Schéma › Documenter le schéma (Markdown)..., ou exécutez Documenter le schéma (Markdown)... depuis la palette de commandes. L'ouverture depuis l'explorateur fait d'abord de cette base de données la base active.
  3. Une boîte de dialogue d'enregistrement s'ouvre avec schema-docs.md suggéré. Choisissez un dossier et un nom.
  4. La barre d'état confirme où il a été enregistré et combien de fichiers ont été écrits lorsque le schéma a été scindé.

À quoi ressemble le Markdown

Les objets sont triés par section puis par nom. Un petit schéma produit quelque chose comme ceci :

# Data Dictionary — Shop / sales

Generated by SQLLY from the loaded schema model. 2 objects.

## Tables

### dbo.Orders

| Column | Type | Nullable | Default | Key |
|---|---|---|---|---|
| OrderId | int | no |  | PK, identity |
| CustomerId | int | no |  | FK → dbo.Customers |
| Total | decimal | yes |  |  |

- Foreign key (CustomerId) → dbo.Customers (CustomerId)

## Procedures

### dbo.PlaceOrder

| Parameter | Type | Mode | Default |
|---|---|---|---|
| @CustomerId | int | in |  |
  • Tables - une ligne par colonne. Nullable est yes, no, ou ? quand le modèle ne sait pas. La Clé cellule combine PK, FK → target, et identity.
  • Vues - une grille Colonne / Type, ou Colonnes non enregistrées dans le modèle de schéma lorsque le modèle ne connaît que le nom de la vue.
  • Procédures et fonctions - une grille Paramètre / Type / Mode / Valeur par défaut (le mode est in, out, ou in/out), Aucun paramètre. lorsqu'il n'y en a pas, et un Retourne : ligne pour les fonctions.
  • Autres objets - les synonymes montrent leur cible ; tout le reste est listé par nom avec Aucun détail structurel enregistré.

Les caractères pipe dans les valeurs sont échappés et les sauts de ligne aplatis, donc les valeurs par défaut et les types ne cassent jamais la mise en page du tableau.

Grands schémas

Jusqu’à 2 000 objets sont placés dans le fichier unique que vous avez nommé. Au-delà de cela, SQLly écrit ce fichier comme un index listant chaque schéma avec son nombre d'objets et un lien, plus un fichier par schéma à côté, nommé d'après votre fichier : schema-docs.sales.md, schema-docs.audit.md, et ainsi de suite. Les noms de schéma sont rendus sûrs pour les noms de fichiers, et deux schémas qui entreraient en collision reçoivent un suffixe numérique plutôt que de s'écraser mutuellement. Rien n'est tronqué.

Bon à savoir

  • Cela fonctionne sur tous les moteurs auxquels SQLly se connecte, car cela lit le modèle propre à SQLly plutôt qu'un catalogue spécifique à chaque moteur.
  • Le document est seulement aussi complet que le modèle chargé. Si le modèle n'a jamais enregistré les colonnes d'une vue, le document l'indique plutôt que de deviner.
  • Enregistrer écrit le fichier directement ; les fichiers existants portant le même nom sont remplacés.
  • L'enregistrement dans un fichier n'est pas disponible dans l'aperçu du navigateur ; utilisez l'application de bureau.