db_str: Show structure of a table.

Description Usage Arguments Value Details Examples

View source: R/RMariaDBHelper.R

Description

Run a database query on a table that shows the columns and their properties.

Usage

1
db_str(tablename, conf_file = "~/.db_conf.yml")

Arguments

tablename

(character) A table name to query for structure.

conf_file

(character) A file containing database connection parameters. (Default: "~/.db_conf.yml")

Value

(dataframe) The query result returned as a dataframe.

Details

A SHOW COLUMNS query will return a dataframe of columns and their properties.

Examples

1
2
3
4
## Not run: 
db_str("iris")

## End(Not run)

deohs/RMariaDBHelper documentation built on Dec. 31, 2020, 11:17 p.m.