https://github.com/mjfii/TSQL-Documentation-Lib
Utilizes MS SQL metadata to document any given database.
https://github.com/mjfii/TSQL-Documentation-Lib
database markdown r tsql
Last synced: 4 months ago
JSON representation
Utilizes MS SQL metadata to document any given database.
- Host: GitHub
- URL: https://github.com/mjfii/TSQL-Documentation-Lib
- Owner: mjfii
- License: apache-2.0
- Created: 2017-01-26T16:23:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-12-30T18:07:05.000Z (over 3 years ago)
- Last Synced: 2024-08-13T07:11:57.845Z (8 months ago)
- Topics: database, markdown, r, tsql
- Language: R
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - mjfii/TSQL-Documentation-Lib - Utilizes MS SQL metadata to document any given database. (R)
README
# T-SQL Data Definition Documentation
This R package, `tsql.documentation`, utilizes the MS SQL metadata to compile, via knitter, a comprehensive and easily navigable documentation deliverable for database deployments.
## Motivation
Building 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.
## Prerequisites
The 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.
## Installation
Using the `devtools` function, install with the below:
```r
install_github('mjfii/TSQL-Documentation')
library('tsql.documentation')
```
## Examples
To open a connection (note: only integrated security is available):
```r
cnn <- get.connection('','')
```
To load a data frame with markdown:
```r
cnn <- get.connection('','')
md <- get.markdown(cnn)
```
To write full documentation to disk:
```r
cnn <- get.connection('','')
doc <- get.documentation(cnn, 'c:/' , 'documentation.pdf')
```
## Contributors
Michael Flanigan
email: [[email protected]]([email protected])
twitter: [@mjfii](https://twitter.com/mjfii)
# Versioning
0.0.0.9000 - Initial deployment (2017-01-26)