get_default_connection: Get the default ScidbConnection

View source: R/connection.R

get_default_connectionR Documentation

Get the default ScidbConnection

Description

Call arrayop::db_connect to establish a connection

Usage

get_default_connection(.report_error_if_not_connected = TRUE)

Arguments

.report_error_if_not_connected

Whether to report error if db_connect has not been called before this function. Default TRUE to ensure a valid connection object is returned or throw an error. Set to FALSE, if we need to test if a connection object exists or not without causing an error.

E.g. conn_obj_available = get_default_connection(F)$has_connected()

Value

The default ScidbConnection object. Report error if db_connect is not called prior to this function.


Paradigm4/ArrayOpR documentation built on Dec. 11, 2023, 5:59 a.m.