RMySQL v0.10.9


Monthly downloads



by Jeroen Ooms

Database Interface and 'MySQL' Driver for R

Implements 'DBI' Interface to 'MySQL' and 'MariaDB' Databases.



Database Interface and MySQL Driver for R

Build Status AppVeyor Build Status Coverage Status CRAN_Status_Badge CRAN RStudio mirror downloads Github Stars

RMySQL is a database interface and MySQL driver for R. This version complies with the database interface definition as implemented in the package DBI 0.2-2.

Hello World

# Connect to my-db as defined in ~/.my.cnf
con <- dbConnect(RMySQL::MySQL(), group = "my-db")

dbWriteTable(con, "mtcars", mtcars)

dbListFields(con, "mtcars")
dbReadTable(con, "mtcars")

# You can fetch all results:
res <- dbSendQuery(con, "SELECT * FROM mtcars WHERE cyl = 4")

# Or a chunk at a time
res <- dbSendQuery(con, "SELECT * FROM mtcars WHERE cyl = 4")
  chunk <- dbFetch(res, n = 5)
# Clear the result

# Disconnect from the database


Binary packages for OS-X or Windows can be installed directly from CRAN:


The development version from github:

# install.packages("devtools")

Installation from source on Linux or OSX requires MariaDB Connector/C. On some older platforms you can also link against Oracle's libmysqlclient driver but the mariadb implementation is much better.

On recent Debian or Ubuntu install libmariadb-client-lgpl-dev. In Ubuntu 14.04 this was called libmariadbclient-dev.

sudo apt-get install -y libmariadb-client-lgpl-dev

On Fedora, CentOS or RHEL we need mariadb-devel:

sudo yum install mariadb-devel

On OS-X use mariadb-connector-c from Homebrew:

brew install mariadb-connector-c

MySQL configuration file

Instead of specifying a username and password in calls to dbConnect(), it's better to set up a MySQL configuration file that names the databases that you connect to most commonly. This file should live in ~/.my.cnf and look like:


If you want to run the examples, you'll need to set the proper options in the [rs-dbi] group of any MySQL option file, such as /etc/my.cnf or the .my.cnf file in your home directory. For a default single user install of MySQL, the following code should work:



Many thanks to Christoph M. Friedrich, John Heuer, Kurt Hornik, Torsten Hothorn, Saikat Debroy, Matthew Kelly, Brian D. Ripley, Mikhail Kondrin, Jake Luciani, Jens Nieschulze, Deepayan Sarkar, Louis Springer, Duncan Temple Lang, Luis Torgo, Arend P. van der Veen, Felix Weninger, J. T. Lindgren, Crespin Miller, and Michal Okonlewski, Seth Falcon and Paul Gilbert for comments, suggestions, bug reports, and patches.

Functions in RMySQL

Name Description
dbEscapeStrings Escape SQL-special characters in strings.
MySQLConnection-class Class MySQLConnection.
mysqlClientLibraryVersions MySQL Check for Compiled Versus Loaded Client Library Versions
transactions DBMS Transaction Management
dbUnloadDriver,MySQLDriver-method Unload MySQL driver.
dbFetch,MySQLResult,numeric-method Execute a SQL statement on a database connection.
make.db.names,MySQLConnection,character-method Make R/S-Plus identifiers into legal SQL identifiers
MySQLDriver-class Class MySQLDriver with constructor MySQL.
dbGetInfo,MySQLDriver-method Get information about a MySQL driver.
constants Constants
dbReadTable,MySQLConnection,character-method Convenience functions for importing/exporting DBMS tables
dbDataType,MySQLDriver-method Determine the SQL Data Type of an S object
MySQLResult-class Class MySQLResult
dbColumnInfo,MySQLConnection-method Experimental dbColumnInfo method for a connection
dbConnect,MySQLDriver-method Connect/disconnect to a MySQL DBMS
dbApply Apply R/S-Plus functions to remote groups of DBMS rows (experimental)
db-meta Database interface meta-data
mysqlBuildTableDefinition Build the SQL CREATE TABLE definition as a string
mysqlHasDefault Check if default database is available.
dbNextResult Fetch next result set from an SQL script or stored procedure (experimental)
dbQuoteIdentifier,MySQLConnection,character-method Quote method for MySQL identifiers
isIdCurrent Check if a database object is valid.
dbWriteTable,MySQLConnection,character,data.frame-method Write a local data frame or file to the database.
result-meta Database interface meta-data.
No Results!

Last month downloads


License GPL-2
URL https://github.com/rstats-db/rmysql, https://downloads.mariadb.org/connector-c/
BugReports https://github.com/rstats-db/rmysql/issues
SystemRequirements libmariadb-client-dev | libmariadb-client-lgpl-dev | libmysqlclient-dev (deb), mariadb-devel (rpm), mariadb | mysql-connector-c (brew), mysql56_dev (csw)
NeedsCompilation yes
Collate 'mysql.R' 'driver.R' 'connection.R' 'data-type.R' 'default.R' 'escaping.R' 'result.R' 'extension.R' 'is-valid.R' 'table.R' 'transaction.R'
Packaged 2016-05-07 18:20:46 UTC; jeroen
Repository CRAN
Date/Publication 2016-05-08 15:39:34

Include our badge in your README