69 lines
1.9 KiB
R
69 lines
1.9 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/db.R
|
|
\name{MNR.DB}
|
|
\alias{MNR.DB}
|
|
\title{MNR database queries base class}
|
|
\value{
|
|
<\link[AVSDevR.DBClient]{DBClient}> The DBClient instance used
|
|
by the class instance
|
|
}
|
|
\description{
|
|
MNR database queries base class
|
|
|
|
MNR database queries base class
|
|
}
|
|
\section{Methods}{
|
|
\subsection{Public methods}{
|
|
\itemize{
|
|
\item \href{#method-MNR.DB-new}{\code{MNR.DB$new()}}
|
|
\item \href{#method-MNR.DB-getDBClient}{\code{MNR.DB$getDBClient()}}
|
|
\item \href{#method-MNR.DB-clone}{\code{MNR.DB$clone()}}
|
|
}
|
|
}
|
|
\if{html}{\out{<hr>}}
|
|
\if{html}{\out{<a id="method-MNR.DB-new"></a>}}
|
|
\if{latex}{\out{\hypertarget{method-MNR.DB-new}{}}}
|
|
\subsection{Method \code{new()}}{
|
|
Initialises the instance with a database client
|
|
\link[AVSDevR.DBClient]{DBClient}
|
|
\subsection{Usage}{
|
|
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB$new(db_client)}\if{html}{\out{</div>}}
|
|
}
|
|
|
|
\subsection{Arguments}{
|
|
\if{html}{\out{<div class="arguments">}}
|
|
\describe{
|
|
\item{\code{db_client}}{<\link[AVSDevR.DBClient]{DBClient}> A DBClient instance}
|
|
}
|
|
\if{html}{\out{</div>}}
|
|
}
|
|
}
|
|
\if{html}{\out{<hr>}}
|
|
\if{html}{\out{<a id="method-MNR.DB-getDBClient"></a>}}
|
|
\if{latex}{\out{\hypertarget{method-MNR.DB-getDBClient}{}}}
|
|
\subsection{Method \code{getDBClient()}}{
|
|
Returns the current DBClient instance in use
|
|
\subsection{Usage}{
|
|
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB$getDBClient()}\if{html}{\out{</div>}}
|
|
}
|
|
|
|
}
|
|
\if{html}{\out{<hr>}}
|
|
\if{html}{\out{<a id="method-MNR.DB-clone"></a>}}
|
|
\if{latex}{\out{\hypertarget{method-MNR.DB-clone}{}}}
|
|
\subsection{Method \code{clone()}}{
|
|
The objects of this class are cloneable with this method.
|
|
\subsection{Usage}{
|
|
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB$clone(deep = FALSE)}\if{html}{\out{</div>}}
|
|
}
|
|
|
|
\subsection{Arguments}{
|
|
\if{html}{\out{<div class="arguments">}}
|
|
\describe{
|
|
\item{\code{deep}}{Whether to make a deep clone.}
|
|
}
|
|
\if{html}{\out{</div>}}
|
|
}
|
|
}
|
|
}
|