sbf_backup_pg: Save PostgreSQL backup

In poissonconsulting/subfoldr2: Save and Load R Objects

Save PostgreSQL backup

Description

Save a copy of your database in a plain text format. This saves all the SQL code to recreate the structure and data.

Usage

sbf_backup_pg(
  db_dump_name = sbf_get_db_name(),
  sub = sbf_get_sub(),
  main = sbf_get_main(),
  config_path = getOption("psql.config_path", NULL),
  config_value = getOption("psql.config_value", "default")
)

Arguments

db_dump_name	A string of the name for the database backup file
sub	A string specifying the path to the sub folder (by default the current sub folder).
main	A string specifying the path to the main folder (by default the current main folder)
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_backup()

Value

TRUE (or errors)

See Also

Other postgresql functions: 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_open_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: 
sbf_backup_pg()

sbf_backup_pg("database-22")

## End(Not run)

poissonconsulting/subfoldr2 documentation built on Nov. 17, 2024, 1:33 a.m.