rcode_DatabaseInterface: R-code for Functions to Access Database Tables

View source: R/to_R_interface.R

rcode_DatabaseInterfaceR Documentation

R-code for Functions to Access Database Tables

Description

R-code for Functions to Access Database Tables

Usage

rcode_DatabaseInterface(
  db = NULL,
  dbSchema = NULL,
  tableNamePattern = "",
  functionPrefix = "db_",
  pattern = "^",
  dbg = TRUE,
  sql.dbg = TRUE,
  create.create.functions = FALSE
)

Arguments

db

database name or file

dbSchema

database schema as returned by getDatabaseSchema

tableNamePattern

pattern matching the names of tables/views for which an accessor function is to be generated

functionPrefix

prefix to be given to each generated function. Default: "db_"

pattern

pattern matching the part of the table name that will be replaced with functionPrefix. Default: "^", i.e. the prefix will be appended to the start of the table name

dbg

if TRUE, progress messages are shown during the creation of the interface functions

sql.dbg

if TRUE, SQL strings used to access the database are shown when calling the interface functions

create.create.functions

if TRUE, functions for creating new records in the database tables are created


KWB-R/kwb.db documentation built on Oct. 1, 2023, 4:10 a.m.