Package 'hscidbutil'

Version of dplyr::compute() that creates Aria tables.

Description

Version of dplyr::compute() that creates Aria tables.

Usage

compute_a(sql, name, temporary, overwrite, ...)

Arguments

sql	the sql to compute
name	the name of the table to create (defaults to a new unique table name)
temporary	whether to create a temporary table (defaults to TRUE if table name not specified, otherwise needs to be explicitly specified)
overwrite	whether to overwrite existing tables (default to TRUE for temporary tables, FALSE otherwise)
...	Other arguments passed on to dplyr::compute(),

Value

a dbplyr tbl referencing the table computed

---

ColumnStore version of dplyr::compute().

Description

ColumnStore version of dplyr::compute().

Usage

compute_c(sql, name, temporary, overwrite, ...)

Arguments

sql	the sql to compute
name	the name of the table to create (defaults to a new unique table name)
temporary	whether to create a temporary table (defaults to TRUE if table name not specified, otherwise needs to be explicitly specified)
overwrite	whether to overwrite existing tables (default to TRUE for temporary tables, FALSE otherwise)
...	Other arguments passed on to dplyr::compute(),

Value

a dbplyr tbl referencing the table computed

---

Version of dplyr::copy_to() that creates Aria tables and has a better parameter order

Description

Version of dplyr::copy_to() that creates Aria tables and has a better parameter order

Usage

copy_to_a(df, con, name, temporary, overwrite, ...)

Arguments

df	the dataframe to copy to the SQL store
con	the connection to the SQL store
name	the name of the table to create (defaults to a new unique table name)
temporary	whether to create a temporary table
overwrite	whether to overwrite existing tables (default to TRUE for temporary tables, FALSE otherwise)
...	Other arguments passed on to dplyr::copy_to(),

Value

a dbplyr tbl referencing the table created

---

Version of dplyr::copy_to() that creates ColumnStore tables and has a better parameter order

Description

Version of dplyr::copy_to() that creates ColumnStore tables and has a better parameter order

Usage

copy_to_c(df, con, name, temporary, overwrite, ...)

Arguments

df	the dataframe to copy to the SQL store
con	the connection to the SQL store
name	the name of the table to create (defaults to a new unique table name)
temporary	whether to create a temporary table (defaults to TRUE if table name not specified, otherwise needs to be explicitly specified)
overwrite	whether to overwrite existing tables (default to TRUE for temporary tables, FALSE otherwise)
...	Other arguments passed on to dplyr::copy_to(),

Value

a dbplyr tbl referencing the table created

---

Delete all "temporary" tables starting with tmp_ in the given schemas

Description

Delete all "temporary" tables starting with tmp_ in the given schemas

Usage

delete_temporary_tables(con, ...)

Arguments

con	the connection to probe
...	the schemas to probe

---

Get a database connection as defined by a yaml configuration or environment variables

Description

Get a database connection as defined by a yaml configuration or environment variables

Usage

get_connection(
  params = here("params.yaml"),
  secret = here("secret.yaml"),
  key = "db",
  bigint = "integer",
  ...
)

Arguments

params	a params.yaml-file that defines some of db_host, db_name and db_user under a given key
secret	a secret.yaml-file that defines some of db_host, db_name, db_user and db_pass under a given key
key	the key in the yaml file to extract
bigint	how should the connection convert bigints
...	Other arguments passed on to DBI::dbConnect(),

Value

the MariaDB connection object

---

List schemas in a database

Description

List schemas in a database

Usage

list_schemas(con)

Arguments

con	the connection to probe

Value

a list of the schemas defined in the database

---

List all "temporary" tables starting with tmp_ in the given schema

Description

List all "temporary" tables starting with tmp_ in the given schema

Usage

list_temporary_tables(con, ...)

Arguments

con	the connection to probe
...	the schemas to probe

Value

a tibble with TABLE_SCHEMA and TABLE_NAME columns containing information of the temporary tables found.

---

Register all tables in a schema as dbplyr tables in the given enviroment

Description

Register all tables in a schema as dbplyr tables in the given enviroment

Usage

register_tables(con, schemas, envir = .GlobalEnv)

Arguments

con	the connection to probe
schemas	the schemas to probe
envir	the environment in which to register the tables

---