{"Package":"RPostgres","Title":"'Rcpp' Interface to 'PostgreSQL'","Version":"1.3.1","Date":"2021-01-19","Authors@R":"\nc(person(given = \"Hadley\",\nfamily = \"Wickham\",\nrole = \"aut\"),\nperson(given = \"Jeroen\",\nfamily = \"Ooms\",\nrole = \"aut\"),\nperson(given = \"Kirill\",\nfamily = \"M\\u00fcller\",\nrole = c(\"aut\", \"cre\"),\nemail = \"krlmlr+r@mailbox.org\",\ncomment = c(ORCID = \"0000-0002-1416-3412\")),\nperson(given = \"RStudio\",\nrole = \"cph\"),\nperson(given = \"R Consortium\",\nrole = \"fnd\"),\nperson(given = \"Tomoaki\",\nfamily = \"Nishiyama\",\nrole = \"ctb\",\ncomment = \"Code for encoding vectors into strings derived from RPostgreSQL\"))","Description":"Fully 'DBI'-compliant 'Rcpp'-backed interface to\n'PostgreSQL' , an open-source relational\ndatabase.","License":"GPL-3","URL":"https://rpostgres.r-dbi.org, https://github.com/r-dbi/RPostgres","BugReports":"https://github.com/r-dbi/RPostgres/issues","Depends":"R (>= 3.1.0)","Imports":"bit64, blob (>= 1.2.0), DBI (>= 1.1.0), hms (>= 0.5.0),\nlubridate, methods, Rcpp (>= 0.11.4.2), withr","Suggests":"callr, covr, DBItest (>= 1.7.0), knitr, rmarkdown, testthat","LinkingTo":"BH, plogr (>= 0.2.0), Rcpp","VignetteBuilder":"knitr","Encoding":"UTF-8","LazyLoad":"true","RoxygenNote":"7.1.1","SystemRequirements":"libpq >= 9.0: libpq-dev (deb) or postgresql-devel\n(rpm)","Collate":"'PqDriver.R' 'PqConnection.R' 'PqResult.R' 'RPostgres-pkg.R'\n'RcppExports.R' 'Redshift.R' 'default.R' 'export.R' 'names.R'\n'quote.R' 'tables.R' 'transactions.R' 'utils.R'","NeedsCompilation":"yes","Packaged":"2021-01-19 13:06:02 UTC; kirill","Author":"Hadley Wickham [aut],\nJeroen Ooms [aut],\nKirill Mller [aut, cre] (),\nRStudio [cph],\nR Consortium [fnd],\nTomoaki Nishiyama [ctb] (Code for encoding vectors into strings derived\nfrom RPostgreSQL)","Maintainer":"Kirill Mller ","Repository":"CRAN","Date/Publication":"2021-01-19 13:50:05 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/RPostgres_1.3.1.tar.gz","jsonAuthors":[{"name":"Hadley Wickham","email":null,"maintainer":false},{"name":"Jeroen Ooms","email":null,"maintainer":false},{"name":"Kirill Müller","email":"krlmlr+r@mailbox.org","maintainer":true},{"name":"RStudio ","email":null,"maintainer":false},{"name":"R Consortium ","email":null,"maintainer":false},{"name":"Tomoaki Nishiyama","email":null,"maintainer":false}],"readme":"# RPostgres\n\n\n[![rcc](https://github.com/r-dbi/RPostgres/workflows/rcc/badge.svg)](https://github.com/r-dbi/RPostgres/actions)\n[![Codecov test coverage](https://codecov.io/gh/r-dbi/RPostgres/branch/master/graph/badge.svg)](https://codecov.io/gh/r-dbi/RPostgres?branch=master)\n[![CRAN status](https://www.r-pkg.org/badges/version/RPostgres)](https://CRAN.R-project.org/package=RPostgres)\n\n\nRPostgres is an DBI-compliant interface to the postgres database. It's a ground-up rewrite using C++ and Rcpp. Compared to RPostgreSQL, it:\n\n* Has full support for parameterised queries via `dbSendQuery()`, and `dbBind()`.\n\n* Automatically cleans up open connections and result sets, ensuring that you\n don't need to worry about leaking connections or memory.\n\n* Is a little faster, saving ~5 ms per query. (For reference, it takes around 5ms\n to retrive a 1000 x 25 result set from a local database, so this is \n decent speed up for smaller queries.)\n\n* A simplified build process that relies on system libpq.\n\n## Installation\n```R\n# Install the latest RPostgres release from CRAN:\ninstall.packages(\"RPostgres\")\n\n# Or the the development version from GitHub:\n# install.packages(\"remotes\")\nremotes::install_github(\"r-dbi/RPostgres\")\n```\n\nDiscussions associated with DBI and related database packages take place on [R-SIG-DB](https://stat.ethz.ch/mailman/listinfo/r-sig-db). \nThe website [Databases using R](https://db.rstudio.com/) describes the tools and best practices in this ecosystem.\n\n## Basic usage\n\n```R\nlibrary(DBI)\n# Connect to the default postgres database\ncon <- dbConnect(RPostgres::Postgres())\n\ndbListTables(con)\ndbWriteTable(con, \"mtcars\", mtcars)\ndbListTables(con)\n\ndbListFields(con, \"mtcars\")\ndbReadTable(con, \"mtcars\")\n\n# You can fetch all results:\nres <- dbSendQuery(con, \"SELECT * FROM mtcars WHERE cyl = 4\")\ndbFetch(res)\ndbClearResult(res)\n\n# Or a chunk at a time\nres <- dbSendQuery(con, \"SELECT * FROM mtcars WHERE cyl = 4\")\nwhile(!dbHasCompleted(res)){\n chunk <- dbFetch(res, n = 5)\n print(nrow(chunk))\n}\n# Clear the result\ndbClearResult(res)\n\n# Disconnect from the database\ndbDisconnect(con)\n```\n## Connecting to a specific Postgres instance\n\n```R\nlibrary(DBI)\n# Connect to a specific postgres database i.e. Heroku\ncon <- dbConnect(RPostgres::Postgres(),dbname = 'DATABASE_NAME', \n host = 'HOST', # i.e. 'ec2-54-83-201-96.compute-1.amazonaws.com'\n port = 5432, # or any other port specified by your DBA\n user = 'USERNAME',\n password = 'PASSWORD')\n\n```\n\n## Design notes\n\nThe original DBI design imagined that each package could instantiate X drivers, with each driver having Y connections and each connection having Z results. This turns out to be too general: a driver has no real state, for PostgreSQL each connection can only have one result set. In the RPostgres package there's only one class on the C side: a connection, which optionally contains a result set. On the R side, the driver class is just a dummy class with no contents (used only for dispatch), and both the connection and result objects point to the same external pointer.\n\n---\n\nPlease note that the 'RPostgres' project is released with a\n[Contributor Code of Conduct](https://rpostgres.r-dbi.org/code_of_conduct).\nBy contributing to this project, you agree to abide by its terms.","jobInfo":{"package":"RPostgres","version":"1.3.1","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-04-12T08:29:58+0000"}}

Description

Usage

Arguments