connection_check: Check if a connection is ready to use
In framework: Structured Data Science Project Scaffolding
connection_check R Documentation
Check if a connection is ready to use
Description
Diagnoses whether a configured database connection can be established.
Checks driver availability and configuration validity without actually
connecting to the database.
Usage
connection_check(connection_name)
Arguments
connection_name
Character. Name of the connection in config.yml
Value
A list with diagnostic information:
ready: Logical. TRUE if connection appears ready
driver: Driver name
package: Required package
package_installed: Whether package is available
config_valid: Whether configuration appears valid
messages: Character vector of diagnostic messages
framework documentation built on Feb. 18, 2026, 1:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| connection_check | R Documentation |
Check if a connection is ready to use
Description
Diagnoses whether a configured database connection can be established. Checks driver availability and configuration validity without actually connecting to the database.
Usage
connection_check(connection_name)
Arguments
connection_name |
Character. Name of the connection in config.yml |
Value
A list with diagnostic information:
ready: Logical. TRUE if connection appears ready
driver: Driver name
package: Required package
package_installed: Whether package is available
config_valid: Whether configuration appears valid
messages: Character vector of diagnostic messages
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.