Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: tweak driver docs #433

Merged
merged 1 commit into from
Apr 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion R/Redshift.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' Redshift driver/connection
#'
#' Use `Redshift()` instead of `Postgres()` to connect to an AWS Redshift cluster.
#' Use `drv = Redshift()` instead of `drv = Postgres()` to connect to an AWS Redshift cluster.
#' All methods in \pkg{RPostgres} and downstream packages can be called on such connections.
#' Some have different behavior for Redshift connections, to ensure better interoperability.
#'
Expand Down
10 changes: 6 additions & 4 deletions R/dbConnect_PqDriver.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@
#'
#' @description
#' `DBI::dbConnect()` establishes a connection to a database.
#' Set `drv = RPostgres::Postgres()` to connect to a SQL database
#' using the \pkg{RPostgres} package.
#' Set `drv = Postgres()` to connect to a PostgreSQL(-ish) database. Use `drv =
#' Redshift()` instead to connect to an AWS Redshift cluster.
#'
#' Manually disconnecting a connection is not necessary with \pkg{RPostgres},
#' but still recommended;
#' if you delete the object containing the connection, it will be automatically
#' disconnected during the next GC with a warning.
#'
#' @param drv Should be set to [RPostgres::Postgres()]
#' to use the \pkg{RPostgres} package.
#' @param drv [DBI::DBIDriver-class]. Use [Postgres()] to connect to a
#' PostgreSQL(-ish) database or [Redshift()] to connect to an AWS Redshift
#' cluster. Use an existing [DBI::DBIConnection-class] object to clone an
#' existing connection.
#' @param dbname Database name. If `NULL`, defaults to the user name.
#' Note that this argument can only contain the database name, it will not
#' be parsed as a connection string (internally, `expand_dbname` is set to
Expand Down
9 changes: 5 additions & 4 deletions man/Postgres.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions man/Redshift.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.