Documentar esquema

funcional

Genera documentación en Markdown del esquema de la base de datos, lista para un repositorio o wiki.

Generar Markdown documentación del esquema de la base de datos en un solo paso: eliges la acción, indicas dónde guardar y listo. A propósito, no hay nada que configurar: el documento se genera a partir del modelo de esquema que SQLly ya tiene cargado para IntelliSense, así que no hace falta ninguna ida y vuelta extra al servidor y refleja exactamente lo que la aplicación sabe.

La salida es un diccionario de datos encabezado por la conexión y la base de datos, dividido en Tablas, Vistas, Procedimientos, Funciones, y Otros objetos. Cada tabla incluye una cuadrícula de columnas con nombre, tipo, nulabilidad, valor predeterminado y anotaciones de clave (clave primaria, identidad, FK → objetivo) - además incluye sus claves foráneas como una lista; las rutinas obtienen sus firmas de parámetros y sus tipos de retorno. Los esquemas muy grandes se dividen automáticamente en un archivo de índice más un archivo por esquema, para que el resultado siga siendo navegable en un repositorio o wiki.

SQLly
Salida del esquema de documento de SQLly (Markdown)Salida del esquema de documento de SQLly (Markdown)
Documentar esquema: la estructura de la base de datos representada como documentación Markdown lista para guardar.

Escribiendo un diccionario de datos

  1. Conéctate y dale un momento al modelo de esquema para que se cargue (es el mismo modelo que impulsa el autocompletado). Si aún no se ha cargado, SQLly lo indica en la barra de estado y no hace nada.
  2. Haz clic derecho en la base de datos en el explorador y elige Esquema › Documentar esquema (Markdown)..., o ejecuta Documentar esquema (Markdown)... desde la paleta de comandos. Si lo abres desde el explorador, esa base de datos se activa primero.
  3. Se abre un cuadro de diálogo de guardar con schema-docs.md sugerido. Elige una carpeta y un nombre.
  4. La barra de estado confirma dónde se guardó y cuántos archivos se escribieron cuando el esquema se dividió.

Cómo se ve el Markdown

Los objetos se ordenan por sección y luego por nombre. Un esquema pequeño produce algo como esto:

# 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 |  |
  • Tablas - una fila por columna. Admite NULL es yes, no, o ? cuando el modelo no lo sabe. La Clave celda combina PK, FK → target, y identity.
  • Vistas - una cuadrícula Columna / Tipo, o Columnas no registradas en el modelo de esquema cuando el modelo solo conoce el nombre de la vista.
  • Procedimientos y funciones - una cuadrícula Parámetro / Tipo / Modo / Predeterminado (el modo es in, out, o in/out), No hay parámetros. cuando no hay ninguno, y una Devuelve: línea para funciones.
  • Otros objetos - los sinónimos muestran su destino; todo lo demás se lista por nombre con No se ha registrado ningún detalle estructural.

Los caracteres de barra vertical en los valores se escapan y los saltos de línea se aplanan, así que los valores predeterminados y los tipos nunca rompen la estructura de la tabla.

Esquemas grandes

Hasta 2000 objetos van al único archivo que indicaste. A partir de ahí, SQLly escribe ese archivo como un índice listando cada esquema con su cantidad de objetos y un enlace, más un archivo por esquema junto a él, nombrado según tu archivo: schema-docs.sales.md, schema-docs.audit.md, y así sucesivamente. Los nombres de los esquemas se ajustan para que sean válidos como nombre de archivo, y dos esquemas que colisionarían reciben un sufijo numérico en lugar de sobrescribirse. No se trunca nada.

Cosas que debes saber

  • Funciona en todos los motores a los que SQLly se conecta, porque lee el propio modelo de SQLly en lugar de un catálogo específico del motor.
  • El documento es tan completo como el modelo cargado. Si el modelo nunca registró las columnas de una vista, el documento lo indica en lugar de adivinar.
  • Guardar escribe el archivo directamente; los archivos existentes con el mismo nombre se reemplazan.
  • Guardar en un archivo no está disponible en la vista previa del navegador; usa la aplicación de escritorio.