docs: clarify schema discovery for dbListTables#583
Open
LeonidasZhak wants to merge 2 commits into
Open
Conversation
4ef8962 to
5c31346
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarify how to discover tables in a non-default schema, both by listing objects with
Id(schema = ...)and by usingoptions = "-c search_path=..."for a connection.Thanks to maintainers
Thanks for the pointers in #399 and for the existing schema-qualified table examples.
Issue or motivation
Issue #399 notes that users looking for tables in a specific schema do not easily find the supported workflows.
Root cause
The connection docs only pointed readers to the general libpq options reference, and the table docs showed schema-qualified writes without showing the matching schema-scoped listing patterns.
Change
options = "-c search_path=..."in thedbConnect()docs with a runnable exampledbListObjects(con, Id(schema = ...))anddbListTables()on a connection withsearch_pathsetsearch_pathworkflowTests
devtools::document()UserNM=true R CMD INSTALL .devtools::test(filter = "dbConnect")rcmdcheck::rcmdcheck(args = c("--no-manual", "--ignore-vignettes"), error_on = "note")pkgdown::build_site(preview = FALSE)Scope
I did not change
dbListTables()behavior or add a new schema argument. This PR only documents the existing workflows and adds a focused regression test for the documented connection-option path.