benchdogGet the tools
ToolsSQL Documenter
SQL Server and Azure SQL

Benchdog SQL Documenter

Document a database in minutes, not days.

VS Code, desktop and command line. Windows, Mac and Linux. One licence covers all three.

Browse SQL Server and Azure SQL databases, edit the description on every object, and document them as HTML, Markdown, Word or PDF, with diagrams and links. Only the structure is read, never table data.

Document a database in one go

Pick your databases and formats and Benchdog writes the lot: a cover, then a page for every table, view, procedure, function, trigger, type, sequence, synonym, schema, user and role. Several databases make one document, and a server page can sum up each server.

Tick the databases and formats, then Generate.

Every format your team reads

Share the format each reader wants. HTML is a folder of pages, with a tree and a filter, that opens straight from disk, Markdown suits a GitHub or Azure DevOps wiki, and Word and PDF are one file with bookmarks, links and page numbers.

HTML that opens from disk and loads nothing from the internet.

Diagrams drawn for you

Each table's page draws the tables linked to it by foreign keys, and code draws what it uses and what uses it. In HTML, click a box to open its page or save the diagram as SVG; in PDF, diagrams stay sharp at any zoom.

Diagrams on every page, with each box linked to its object.

Every detail, every link

Table pages show columns with key marks, indexes, foreign keys, constraints, triggers, permissions, what uses them and the CREATE script. Every name that is another object links to its page, and a foreign key jumps to the exact column it points at.

One PDF, with bookmarks, links and page numbers.

Edit descriptions as you browse

Browse each database in SSMS's groups, with row counts from SQL Server's catalogue, and write the description for any object, column or parameter. It is saved in the database as MS_Description, so SSMS and your documents both show it.

Describe any table, column or parameter, saved in the database.

Run it again with project files

Save the databases, formats, folder and cover in a .sqldoc.json file, then make the same documents again from the desktop app, VS Code or the command line. In VS Code the file gets autocomplete, and any problem shows on its line.

A project file keeps every choice, ready to run again.

Your cover, your choices

Put your title, author and copyright on the cover and in every footer, add your logo, and restyle the HTML with your own CSS. Leave out objects by name with wildcards, whole kinds such as users, or sections such as scripts.

Your title, logo and copyright on every document.

Azure SQL and SQL Server alike

Azure SQL uses your Benchdog sign-in, and SQL Server on your network can use your Windows account, with no Benchdog sign-in at all. For servers that only allow SQL logins, the password stays in memory, or in the system's secure store if you ask.

Add a database from Azure SQL or any SQL Server you can reach.