{"id":14066948,"url":"https://github.com/mjfii/TSQL-Documentation-Lib","last_synced_at":"2025-07-30T00:31:46.409Z","repository":{"id":90851980,"uuid":"80131724","full_name":"mjfii/TSQL-Documentation-Lib","owner":"mjfii","description":"Utilizes MS SQL metadata to document any given database.","archived":false,"fork":false,"pushed_at":"2021-12-30T18:07:05.000Z","size":15,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-13T07:11:57.845Z","etag":null,"topics":["database","markdown","r","tsql"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mjfii.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}},"created_at":"2017-01-26T16:23:52.000Z","updated_at":"2022-01-23T22:51:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"d59ce6a3-6b39-49fb-aeb6-f8d75e16b44d","html_url":"https://github.com/mjfii/TSQL-Documentation-Lib","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjfii%2FTSQL-Documentation-Lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjfii%2FTSQL-Documentation-Lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjfii%2FTSQL-Documentation-Lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjfii%2FTSQL-Documentation-Lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mjfii","download_url":"https://codeload.github.com/mjfii/TSQL-Documentation-Lib/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228065127,"owners_count":17863939,"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":["database","markdown","r","tsql"],"created_at":"2024-08-13T07:05:20.849Z","updated_at":"2024-12-04T07:30:28.723Z","avatar_url":"https://github.com/mjfii.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"# T-SQL Data Definition Documentation\n\nThis R package, `tsql.documentation`, utilizes the MS SQL metadata to compile, via knitter, a comprehensive and easily navigable documentation deliverable for database deployments.\n\n## Motivation\n\nBuilding clean and concise data definition documentation over and over again is mind-numbing, especially since everything that is needed is [usually] stored in the inherent metadata.  I needed a way to pull all this together and build a PDF (with navigation), WITHOUT the need of an over priced documentation tool.\n\n## Prerequisites\n\nThe two required packages, `rmarkdown` and `RODBC` - both of which are installing when this library is loaded.  However, since the result renders a PDF file via `pandoc`, you need to manually install LaTeX, i.e. [MikTeX](https://miktex.org/).  Additionally, for ease of installation, `devtools` is recommended.\n\n## Installation\n\nUsing the `devtools` function, install with the below:\n\n```r\ninstall_github('mjfii/TSQL-Documentation')\nlibrary('tsql.documentation')\n```\n\n## Examples\n\nTo open a connection (note: only integrated security is available):\n\n```r\ncnn \u003c- get.connection('\u003cserver_name\u003e','\u003cdatabase_name\u003e')\n```\n\nTo load a data frame with markdown:\n```r\ncnn \u003c- get.connection('\u003cserver_name\u003e','\u003cdatabase_name\u003e')  \nmd \u003c- get.markdown(cnn)  \n```\n\nTo write full documentation to disk:\n```r\ncnn \u003c- get.connection('\u003cserver_name\u003e','\u003cdatabase_name\u003e')  \ndoc \u003c- get.documentation(cnn, 'c:/' , 'documentation.pdf')  \n```\n\n## Contributors\n\nMichael Flanigan  \n email: [mick.flanigan@gmail.com](mick.flanigan@gmail.com)  \n twitter: [@mjfii](https://twitter.com/mjfii)  \n\n# Versioning\n\n0.0.0.9000 - Initial deployment (2017-01-26)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjfii%2FTSQL-Documentation-Lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmjfii%2FTSQL-Documentation-Lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjfii%2FTSQL-Documentation-Lib/lists"}