DebugHelp: Internal Dev Testing and Debugging Functions

In bfatemi/sqlsauce: The Secret Sauce for Dishing Data

Description

These are functions that are not exposed to users. They are internal functions designed to assist with debugging errors related to tracing and identifying connections.

Usage

time.env

PrintSqlError(msg = NULL, friendly = NULL, nFrame = NULL)

xtimetaken(time)

Timer(START = TRUE, print = FALSE)

.CallStack(nFrame)

.Caller(nFrame = NULL)

Arguments

msg	A character string representing the message to display within the banner
friendly	A friendly description of the error message to be displayed
nFrame	A numeric value representing an index for a frame in the function callstack
time	A date/time object from which point to calculate duration since.
START	A boolean value representing whether to start the timer or end the timer. START = FALSE will display the timer information
print	A boolean indicating whether to print output on the console in addition to returning a numeric value representing the duration in seconds

Format

An object of class environment of length 0.

Functions

• PrintSqlError: A helper function to display sql errors that occur during a query

• xtimetaken: A helper function to assist timing operations

• Timer: A helper function to assist timing operations

• .CallStack: A helper function to extract the relevant and helpful portion of the function callstack

• .Caller: A function to parse the function call stack and identify a caller at the current postion or at the position identified by "nFrame"

Internal Use Only

Internal functions not intended to be used by developers.

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