aqrcDBdisconnect: Function to disconnect from any pool connection and cleanup...

View source: R/aqrcDBconnect.R

aqrcDBdisconnectR Documentation

Function to disconnect from any pool connection and cleanup the connection

Description

This function will disconnect from any pool connection and remove the connection object from the R environment.

Usage

aqrcDBdisconnect(poolConn, pos = NULL)

Arguments

poolConn

pool object which represents an active connection.

pos

inherited from rm(). The numeric position of the environment from which to remove the object, or a character string naming the environment (parsed with as.environment()).

Details

This function will disconnect a database connection via the pool package. After disconnecting it will remove the connection object from the R environment.

Value

Nothing.

See Also

poolClose

rm

Examples

## Not run: 
# poolIMP is a database connection
aqrcDBdisconnect(poolIMP)
# the connection is closed and the object, poolIMP, is removed.

## End(Not run)


jgiacomo/AQRCxray documentation built on Nov. 19, 2022, 9:15 p.m.