TableInfo: Tools to explore the tables or columns in a database

In bfatemi/sqlsauce: The Secret Sauce for Dishing Data

Description

Functions assist with exploring db objects at the abstraction layer, and general exploration of the Morpheus data

Usage

TableInfo(db = NULL, print = FALSE)

Relate(db = NULL, tbls = NULL, tbl_Pattern = NULL)

PrimaryKey(db = NULL, tbls = NULL)

ColumnInfo(db = NULL, tbls = NULL, closeConn = FALSE, print = FALSE)

Columns(db = NULL, tbls = NULL, return = FALSE, closeConn = TRUE)

getTables(db = NULL)

getColumns(db = NULL, tbls)

getPrimaryKey(db = NULL, tbls)

Arguments

db	A character value naming the database (e.g. "Morpheus")
print	A boolean indicating whether to print information on the R console
tbls	A character vector of table names belonging to the database specified by "db"
tbl_Pattern	A regex pattern to filter on desired tables
closeConn	A boolean indicating whether this function to close the connection to "db". Default is TRUE.
return	A boolean indicating whether to return objects in memory. Defaults to FALSE which means information is simply printed on the R console and not captured. Ideal default for quick lookups.

Functions

• TableInfo: Given a database, get all databases on same server

• Relate: Will present a relation between tables in a given db

• PrimaryKey: A function to retrieve information about one or more table's primary key column

• ColumnInfo: A function to detailed information about a given table's columns. If argument "tbls" not provided, retrive information about all tbls in the specified database

• Columns: A function that serves as a quick lookup of columns in a table. Defaults to table "MainLog" in database "Morpheus".

• getTables: An internal wrapper around sqlTables

• getColumns: An internal wrapper around sqlColumns

• getPrimaryKey: An internal wrapper around sqlPrimaryKeys

Examples

## Not run: 
# Let's explore what data is available in Morpheus

# Available tables?
TableInfo(db = "Morpheus")
TableInfo(db = "RemoteFE", print = T)

# What are the keys for each table?
PrimaryKey("Morpheus")

# Get key for a specific table
PrimaryKey("Morpheus", "MainLog")

# Let's explore MainLog columns
ColumnInfo(tables = "MainLog")

# Shortcuts/quick view
Columns()
Columns(table = "ProcedureSummaries")

## End(Not run)

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