sbf_open_pg: Open PostgreSQL Connection

In poissonconsulting/subfoldr2: Save and Load R Objects

Open PostgreSQL Connection

Description

Connect to a PostgreSQL database with a config.yml file.

Usage

sbf_open_pg(
  config_path = getOption("psql.config_path", NULL),
  config_value = getOption("psql.config_value", "default")
)

Arguments

config_path	A string of a file path to the yaml configuration file. The default value grabs the file path from the psql.config_path option and uses NULL if no value supplied.
config_value	A string of the name of value. The default value grabs the value from the psql.config_value option and uses "default" if no value is supplied.

Details

Wrapper on psql::psql_connect()

Value

An S4 object that inherits from DBIConnection.

See Also

Other postgresql functions: sbf_backup_pg(), sbf_close_pg(), sbf_create_pg(), sbf_execute_pg(), sbf_get_config_file(), sbf_get_config_value(), sbf_get_schema(), sbf_list_tables_pg(), sbf_load_data_from_pg(), sbf_load_datas_from_pg(), sbf_reset_config_file(), sbf_reset_config_value(), sbf_reset_schema(), sbf_save_data_to_pg(), sbf_set_config_file(), sbf_set_config_value(), sbf_set_schema()

Examples

## Not run: 
conn <- sbf_open_pg()
sbf_close_pg(conn)

sbf_open_pg("config.yml")
sbf_close_pg(conn)

sbf_open_pg(config_path = "config.yml", config_value = "database")
sbf_close_pg(conn)

## End(Not run)

poissonconsulting/subfoldr2 documentation built on Nov. 1, 2024, 9:10 p.m.