piper.io.read_sql¶
-
piper.io.read_sql(sql, con=None, sql_info=False, trim_blanks=True, return_sql=False, info=True)[source]¶ Custom pandas pd.read_sql wrapper function
Examples
df = read_sql(sql=sql, con=con)
- df = read_sql(sql=get_sql_text(sql, variables),
con=con, sql_info=True, info=False)
- Parameters
sql – sql text to be executed
con – database connection
sql_info – Default False If True, display logged sql code executed
trim_blanks – If true, strip all column (row) values of leading and trailing blanks
info – Default True If True, display additional logging information
- Returns
- Return type
a pandas dataframe and optionally executed sql code (text)