{"id":18307532,"url":"https://github.com/clubside/mssql-db-document","last_synced_at":"2026-05-10T02:50:00.995Z","repository":{"id":219383168,"uuid":"748501233","full_name":"clubside/mssql-db-document","owner":"clubside","description":"Node tool to generate HTML documentation of a SQL Server database","archived":false,"fork":false,"pushed_at":"2024-01-29T04:00:29.000Z","size":443,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T05:24:41.701Z","etag":null,"topics":["documentation-generator","nodejs","sql-server"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clubside.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-01-26T05:29:47.000Z","updated_at":"2024-01-28T03:06:13.000Z","dependencies_parsed_at":"2025-02-15T05:32:21.005Z","dependency_job_id":null,"html_url":"https://github.com/clubside/mssql-db-document","commit_stats":null,"previous_names":["clubside/mssql-db-document"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clubside%2Fmssql-db-document","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clubside%2Fmssql-db-document/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clubside%2Fmssql-db-document/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clubside%2Fmssql-db-document/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clubside","download_url":"https://codeload.github.com/clubside/mssql-db-document/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248027898,"owners_count":21035679,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["documentation-generator","nodejs","sql-server"],"created_at":"2024-11-05T16:04:36.238Z","updated_at":"2026-05-10T02:50:00.939Z","avatar_url":"https://github.com/clubside.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SQL Server Database Documentation Generator\n\nCreate HTML documentation for a SQL Server database.\n\n## Description\n\nCreates an HTML document that describes a SQL Server database. Output for each table includes columns, indexes, foreign keys, check constraints and up to ten rows of sample data. A quick jump tag list of all tables is placed at the top.\n\nYou can view sample output based on Microsoft's `AdventureWorks2014` database here:\n\n[GitHub Pages](https://clubside.github.io/mssql-db-document/)\n\nThis is very work-in-progress for a specific need but I'm hoping to make it more robust for general usage. Feel free to make comments or suggestion in the Discussions area.\n\n## Usage\n\nThe tool can be operated through command line arguments or a `JSON` configuration file. If neither a configuration file nor the four database-related arguments is provided the tool will attempt to load `config.json`.\n\nThe configuration file follows this format:\n\n```json\n{\n    \"user\": \"username\",\n    \"password\": \"userpassword\",\n    \"server\": \"servername\",\n    \"database\": \"databasename\"\n}\n```\n\nThe `config.json` included in this package matches the above code and will not function without editing with real values. The file exists simply as a template.\n\nThe command line arguments are:\n\n| Argument | Description |\n| --- | --- |\n| **--config**, **-c** *file name* | File with JSON configuration data |\n| **--user**, **-u** *user name* | User with privileges to access the database |\n| **--password**, **-p** *user password* | Password for database user |\n| **--server**, **-s** *server name or IP* | Server computer name or IP address |\n| **--database**, **-d** *database name* | Name of the database on the server to document |\n\nIncluding `--config` or `-c` will override the other arguments if a file name is passed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclubside%2Fmssql-db-document","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclubside%2Fmssql-db-document","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclubside%2Fmssql-db-document/lists"}