diff --git a/NEWS.md b/NEWS.md index 57a2e068..6e9261d4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -127,8 +127,8 @@ Internal changes only. # RPostgres 1.0-4 (2017-12-20) -- Only call `PQcancel()` if the query hasn't completed, fixes transactions on Amazon RedShift (#159, @mmuurr). -- Fix installation on MacOS. +- Only call `PQcancel()` if the query hasn't completed, fixes transactions on Amazon Redshift (#159, @mmuurr). +- Fix installation on macOS. - Check libpq version in configure script (need at least 9.0). - Fix UBSAN warning: reference binding to null pointer (#156). - Fix rchk warning: PROTECT internal temporary SEXP objects (#157). diff --git a/R/PqResult.R b/R/PqResult.R index ce25529c..f2437144 100644 --- a/R/PqResult.R +++ b/R/PqResult.R @@ -57,13 +57,13 @@ setMethod("dbColumnInfo", "PqResult", function(res, ...) { #' fetches and clears for you. #' #' @param conn A [PqConnection-class] created by [dbConnect()]. -#' @param statement An SQL string to execute +#' @param statement An SQL string to execute. #' @param params A list of query parameters to be substituted into #' a parameterised query. Query parameters are sent as strings, and the #' correct type is imputed by PostgreSQL. If this fails, you can manually #' cast the parameter with e.g. `"$1::bigint"`. -#' @param ... Another arguments needed for compatibility with generic ( -#' currently ignored). +#' @param ... Other arguments needed for compatibility with generic (currently +#' ignored). #' @examples #' # For running the examples on systems without PostgreSQL connection: #' run <- postgresHasDefault() diff --git a/R/quote.R b/R/quote.R index 07ad22e8..506e8ea2 100644 --- a/R/quote.R +++ b/R/quote.R @@ -7,8 +7,9 @@ NULL #' at most one `table` component and at most one `schema` component. #' #' @param conn A [PqConnection-class] created by `dbConnect()` -#' @param x A character to escaped -#' @param ... Other arguments needed for compatibility with generic +#' @param x A character vector to be quoted. +#' @param ... Other arguments needed for compatibility with generic (currently +#' ignored). #' @examples #' # For running the examples on systems without PostgreSQL connection: #' run <- postgresHasDefault() diff --git a/R/tables.R b/R/tables.R index 0897817e..b9d76af9 100644 --- a/R/tables.R +++ b/R/tables.R @@ -22,7 +22,7 @@ #' with [DBI::dbDataType()]). #' @param copy If `TRUE`, serializes the data frame to a single string #' and uses `COPY name FROM stdin`. This is fast, but not supported by -#' all postgres servers (e.g. Amazon's redshift). If `FALSE`, generates +#' all postgres servers (e.g. Amazon's Redshift). If `FALSE`, generates #' a single SQL string. This is slower, but always supported. #' #' @examples diff --git a/README.md b/README.md index 7c5b82ff..cdd68943 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ RPostgres is an DBI-compliant interface to the postgres database. It's a ground- don't need to worry about leaking connections or memory. * Is a little faster, saving ~5 ms per query. (For reference, it takes around 5ms - to retrive a 1000 x 25 result set from a local database, so this is + to retrieve a 1000 x 25 result set from a local database, so this is decent speed up for smaller queries.) * A simplified build process that relies on system libpq. diff --git a/man/postgres-query.Rd b/man/postgres-query.Rd index e79ded78..91131f88 100644 --- a/man/postgres-query.Rd +++ b/man/postgres-query.Rd @@ -22,15 +22,15 @@ \arguments{ \item{conn}{A \linkS4class{PqConnection} created by \code{\link[=dbConnect]{dbConnect()}}.} -\item{statement}{An SQL string to execute} +\item{statement}{An SQL string to execute.} \item{params}{A list of query parameters to be substituted into a parameterised query. Query parameters are sent as strings, and the correct type is imputed by PostgreSQL. If this fails, you can manually cast the parameter with e.g. \code{"$1::bigint"}.} -\item{...}{Another arguments needed for compatibility with generic ( -currently ignored).} +\item{...}{Other arguments needed for compatibility with generic (currently +ignored).} \item{res}{Code a \linkS4class{PqResult} produced by \code{\link[DBI:dbSendQuery]{DBI::dbSendQuery()}}.} diff --git a/man/postgres-tables.Rd b/man/postgres-tables.Rd index 4bea47d5..d49e91c2 100644 --- a/man/postgres-tables.Rd +++ b/man/postgres-tables.Rd @@ -85,7 +85,7 @@ with \code{\link[DBI:dbDataType]{DBI::dbDataType()}}).} \item{copy}{If \code{TRUE}, serializes the data frame to a single string and uses \verb{COPY name FROM stdin}. This is fast, but not supported by -all postgres servers (e.g. Amazon's redshift). If \code{FALSE}, generates +all postgres servers (e.g. Amazon's Redshift). If \code{FALSE}, generates a single SQL string. This is slower, but always supported.} \item{con}{A database connection.} diff --git a/man/quote.Rd b/man/quote.Rd index 4a0ad4f4..bb577fd6 100644 --- a/man/quote.Rd +++ b/man/quote.Rd @@ -55,9 +55,10 @@ \arguments{ \item{conn}{A \linkS4class{PqConnection} created by \code{dbConnect()}} -\item{x}{A character to escaped} +\item{x}{A character vector to be quoted.} -\item{...}{Other arguments needed for compatibility with generic} +\item{...}{Other arguments needed for compatibility with generic (currently +ignored).} } \description{ If an object of class \link{Id} is used for \code{dbQuoteIdentifier()}, it needs diff --git a/vignettes/work-queue.Rmd b/vignettes/work-queue.Rmd index fe4f655e..07150329 100644 --- a/vignettes/work-queue.Rmd +++ b/vignettes/work-queue.Rmd @@ -69,7 +69,7 @@ con <- dbConnect(RPostgres::Postgres()) dbExecute(con, "LISTEN grapevine") ``` -...in this case, "grapevine" is arbitary, we don't need to create channels ahead of time. +...in this case, "grapevine" is arbitrary, we don't need to create channels ahead of time. To make sure we have something to receive, we can start a separate R process using [callr](https://CRAN.R-project.org/package=callr). Ordinarily this would be part of another R script, maybe on another computer. This will wait a bit, and use ``NOTIFY`` to send a message, then finish: