Re-jigged the class implementation to get better support from roxygen2 and CRAN check(). Majority of public functions are documented (remaining are the CRUD functions)
This commit is contained in:
44
man/dot-configureDefault.Rd
Normal file
44
man/dot-configureDefault.Rd
Normal file
@@ -0,0 +1,44 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/DBConnection-Configure.R
|
||||
\name{.configureDefault}
|
||||
\alias{.configureDefault}
|
||||
\title{Configures the DBClient instance.}
|
||||
\usage{
|
||||
.configureDefault(
|
||||
host,
|
||||
port,
|
||||
user,
|
||||
password,
|
||||
dbname,
|
||||
engine = NULL,
|
||||
name = NULL,
|
||||
schema = NULL,
|
||||
autoconnect = NULL
|
||||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{host}{The database host}
|
||||
|
||||
\item{port}{The database port}
|
||||
|
||||
\item{user}{The database user to connect with}
|
||||
|
||||
\item{password}{The database password to connect with}
|
||||
|
||||
\item{dbname}{The database to use}
|
||||
|
||||
\item{engine}{The database engine (mysql, postgres) as supported by DBI}
|
||||
|
||||
\item{name}{The database to use (alternative to dbname)}
|
||||
|
||||
\item{schema}{The database schema to use (postgres)}
|
||||
|
||||
\item{autoconnect}{Autoconnect to the database if not already connected}
|
||||
}
|
||||
\value{
|
||||
The configuration accepted
|
||||
}
|
||||
\description{
|
||||
There are 2 options for configuration, either: pass in a named list; or use
|
||||
named parameters.
|
||||
}
|
||||
Reference in New Issue
Block a user