cas_disconnect_from_db: Ensure that connection to database is disconnected...

View source: R/cas_database.R

cas_disconnect_from_dbR Documentation

Ensure that connection to database is disconnected consistently

Description

Ensure that connection to database is disconnected consistently

Usage

cas_disconnect_from_db(
  db_connection = NULL,
  db_type = NULL,
  use_db = NULL,
  disconnect_db = FALSE
)

Arguments

db_connection

Defaults to NULL. If NULL, and database is enabled, castarter will use a local sqlite database. A custom connection to other databases can be given (see vignette castarter_db_management for details).

use_db

Defaults to NULL. If given, it should be given either TRUE or FALSE. Typically set with cas_enable_db() or cas_disable_db().

disconnect_db

Defaults to TRUE. If FALSE, leaves the connection to database open.

Value

Nothing, used for its side effects.

See Also

Other database functions: cas_check_db_folder(), cas_check_use_db(), cas_connect_to_db(), cas_create_db_folder(), cas_disable_db(), cas_enable_db(), cas_get_db_settings(), cas_read_from_db(), cas_set_db(), cas_set_db_folder(), cas_write_to_db()

Examples

cas_disconnect_from_db()

giocomai/castarter documentation built on April 23, 2024, 11:14 p.m.