{"id":32397189,"url":"https://github.com/cklutz/docdb","last_synced_at":"2026-04-18T19:31:45.228Z","repository":{"id":270490282,"uuid":"803201641","full_name":"cklutz/docdb","owner":"cklutz","description":"Generate DocFX metadata from SQL Server database schema","archived":false,"fork":false,"pushed_at":"2025-06-09T10:45:06.000Z","size":8580,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-25T07:53:57.439Z","etag":null,"topics":["docfx","docfx-plugin","documentation-generator","sql-server","template"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cklutz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-05-20T09:13:30.000Z","updated_at":"2025-06-09T10:45:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"73e1df5b-5c58-4395-9fdf-92085be71edb","html_url":"https://github.com/cklutz/docdb","commit_stats":null,"previous_names":["cklutz/docdb"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cklutz/docdb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklutz%2Fdocdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklutz%2Fdocdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklutz%2Fdocdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklutz%2Fdocdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cklutz","download_url":"https://codeload.github.com/cklutz/docdb/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklutz%2Fdocdb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31982519,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T17:30:12.329Z","status":"ssl_error","status_checked_at":"2026-04-18T17:29:59.069Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docfx","docfx-plugin","documentation-generator","sql-server","template"],"created_at":"2025-10-25T07:35:29.244Z","updated_at":"2026-04-18T19:31:45.210Z","avatar_url":"https://github.com/cklutz.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocDB\r\n\r\nGenerate metadata for SQL Server databases, for use with [DocFX](https://github.com/dotnet/docfx), to generate reference documentation.\r\n\r\n[![NuGet](https://img.shields.io/nuget/v/docdb.console)](https://www.nuget.org/packages/docdb.console)\r\n[![Status](https://github.com/cklutz/docdb/workflows/Windows/badge.svg)](https://github.com/cklutz/docdb/actions?query=workflow%3AWindows)\r\n[![MIT License](https://img.shields.io/github/license/cklutz/docdb?color=%230b0\u0026style=flat-square)](https://github.com/cklutz/docdb/blob/master/LICENSE)\r\n\r\nYou can use this tool to generate meta data files (\u003ccode\u003e.yml\u003c/code\u003e files) for a given SQL Server database.\r\nThen use \u003ccode\u003edocfx\u003c/code\u003e to generate reference documentation like you would do for other languages (e.g. C#).\r\n\r\n__Warning__: Albeit usable, this tool is not complete. Still lacking are unit tests and code coverage and integration style tests. YMMV.\r\n\r\n## Features\r\n\r\nDocDB can document the following SQL Server objects:\r\n\r\n* Tables (including indexes, checks, keys, triggers)\r\n* Stored Procedures\r\n* Functions (scalar, table valued, aggregates)\r\n* Types (data types, table types, CLR types)\r\n* Assemblies (incl. decompiled C# code)\r\n* DDL Triggers\r\n* XML Schema collections\r\n* Parition information (functions, schemes)\r\n* Sequences\r\n* Rules\r\n* Defaults\r\n* Roles (database and application roles)\r\n* Users\r\n* Synonyms\r\n* Schemas\r\n* Database itself (files, filegroups, settings, etc.)\r\n\r\nAll documents and objects are cross references (for example, foreign keys to target table).\r\nFor every applicable object, the relevant SQL CREATE script is included.\r\n\r\nAdditionally, a table of contents is generated that structures the objects as they are in\r\nthe Object Explorer of SSMS.\r\n\r\n## Getting Started\r\n\r\n1. Install docfx as a global tool:\r\n\r\n```bash\r\ndotnet tool install -g docfx\r\n```\r\n\r\n2. Install DocDB as a global tool:\r\n\r\n```bash\r\ndotnet tool install -g docdb.console\r\n```\r\n\r\n**TODO**: Document rest of procedure (or see [AdventureWorks2022 sample](samples/AdventureWorks2022/README.md)).\r\n\r\n\r\n## Examples\r\n\r\nThe following pictures are based on the [AdventureWorks Sample Database](https://github.com/microsoft/sql-server-samples/tree/master/samples/databases/adventure-works/oltp-install-script). To generate those yourself see [AdventureWorks2022 sample](samples/AdventureWorks2022/README.md).\r\n\r\n![](docs/images/sample_db.png)\r\n*Database Overview*\r\n\r\n![](docs/images/sample_table.png)\r\n*Table Details*\r\n\r\n![](docs/images/sample_view_overview.png)\r\n*Views Overview*\r\n\r\n![](docs/images/sample_sp.png)\r\n*Stored Procedure Details*\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcklutz%2Fdocdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcklutz%2Fdocdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcklutz%2Fdocdb/lists"}