Learn R Programming

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); 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

A stable version of sqlhelper has not yet been released. The current development version is being prepared for submission to CRAN.

Pending acceptance, the future stable version will be available from CRAN:

install.packages("sqlhelper")

Alternatively, you can install development versions from github:

# install.packages("devtools")

devtools::install_github("majerr/sqlhelper@dev")

Getting Started

Basic functionality is described in vignette("sqlhelper")

Execution of SQL files is described in detail in vignette("execution")

Setup and management of database connections is described in vignette("connections")

There are some details about using sqlhelper within other packages in vignette("use_case")

Copy Link

Version

Install

install.packages('sqlhelper')

Monthly Downloads

111

Version

0.2.1

License

GPL (>= 3)

Issues

Pull Requests

Stars

Forks

Maintainer

Matthew Roberts

Last Published

January 21st, 2024

Functions in sqlhelper (0.2.1)

live_connection

Return the named connection or NULL
prepare_sql

prepare queries and assemble meta data prior to execution
connection_info

Browse available connections
default_conn

Return the default connection
run_files

Read, prepare and execute .SQL files
read_sql

Read a sql file and return it's contents as a tibble
config_examples

Examples of yaml configurations for database connections
connect

(Re-)Establish connections to databases
disconnect

Close all connections and remove them from the connections cache
is_connected

Test whether a database is connected
run_queries

Execute a sequence of SQL queries
set_default_conn_name

Set/get the name of the default connection to use