ManageConnections: Managing Connections

In bfatemi/sqlsauce: The Secret Sauce for Dishing Data

Description

Functions to open/close and otherwise manage the connections to a configured database, stored in a connection pool. These functions are intended for developers that need access to the connection environment as they develop data products.

Usage

OpenDB(db = NULL)

CloseDB(db = NULL)

ConnPool()

ConnExists(db = NULL)

Clean(db = NULL)

GetConn(db)

GetConnRef(db)

Arguments

db	A character value representing the name of a database

Functions

• OpenDB: Open connection to a given database. Returns 1 on success

• CloseDB: Close a connection to given db. Returns 1 on success

• ConnPool: See all active (open or closed) connections in the pool

• ConnExists: A function to check whether a connection has been initiated. Returns TRUE if connection object exists, and FALSE otherwise. Error if argument is not the name of a configured db

• Clean: A function to clean the connection pool

• GetConn: A function to get a connection object from the connection pool

• GetConnRef: A function to get a connection object from the connection pool

Note

Any database where access to managing connections is required must be configured prior. Future functionality will include the ability to auto-configurate a database.

bfatemi/sqlsauce documentation built on May 12, 2019, 7:27 p.m.