https://github.com/majerr/sqlhelper
https://github.com/majerr/sqlhelper
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/majerr/sqlhelper
- Owner: majerr
- License: gpl-3.0
- Created: 2021-04-09T14:23:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T16:32:56.000Z (about 1 year ago)
- Last Synced: 2024-11-28T15:48:43.574Z (3 months ago)
- Language: R
- Homepage: https://majerr.github.io/sqlhelper/
- Size: 4.75 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - majerr/sqlhelper - (R)
README
# sqlhelper
Easier SQL integration with R
## Summary
`sqlhelper` facilitates preparing and executing _files_ of SQL code from R.
In particular, `sqlhelper` does two things. It:
1. provides **functions for preparing and executing files of
sql queries**; and it
1. provides **functions to manage multiple RDBMS connections**.
To do this `sqlhelper` defines a number of functions, many of which are also
exported for convenience.
There are, of course, many excellent ways to interact with a database from R,
often not involving SQL at all (e.g. [dbplyr](https://dbplyr.tidyverse.org/));
`sqlhelper` is for the times when you *do* want to use SQL - perhaps you have
inherited some legacy SQL, or need some specific functionality offered by your
RDBMS, or simply prefer to write SQL. The article `vignette("use-case")`
describes the setup for a specific motivating case.
## Installation
The current stable version is available from CRAN:
```R
install.packages("sqlhelper")
```
You can the install development version from github:
```R
# install.packages("devtools")
devtools::install_github("majerr/sqlhelper@dev")
```
## Getting Started
Basic functionality is described in [`vignette("sqlhelper")`](https://majerr.github.io/sqlhelper/dev/articles/sqlhelper.html)
Execution of SQL files is described in detail in [`vignette("execution")`](https://majerr.github.io/sqlhelper/dev/articles/execution.html)
Setup and management of database connections is described in
[`vignette("connections")`](https://majerr.github.io/sqlhelper/dev/articles/connections.html)
There are some details about using `sqlhelper` within other packages in [`vignette("use_case")`](https://majerr.github.io/sqlhelper/dev/articles/use_case.html)
[](https://github.com/majerr/sqlhelper/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/majerr/sqlhelper)