File: mysqlBuildTableDefinition.Rd

package info (click to toggle)
rmysql 0.11.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 420 kB
  • sloc: ansic: 1,666; makefile: 5; sh: 1
file content (40 lines) | stat: -rw-r--r-- 976 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/extension.R
\name{mysqlBuildTableDefinition}
\alias{mysqlBuildTableDefinition}
\title{Build the SQL CREATE TABLE definition as a string}
\usage{
mysqlBuildTableDefinition(
  dbObj,
  name,
  obj,
  field.types = NULL,
  row.names = TRUE,
  ...
)
}
\arguments{
\item{dbObj}{any DBI object (used only to dispatch according to the engine
(e.g., MySQL, Oracle, PostgreSQL, SQLite)}

\item{name}{name of the new SQL table}

\item{obj}{an R object coerceable to data.frame for which we want to create
a table}

\item{field.types}{optional named list of the types for each field in
\code{obj}}

\item{row.names}{logical, should row.name of \code{value} be exported as a
\code{row\_names} field? Default is TRUE}

\item{\dots}{reserved for future use}
}
\value{
An SQL string
}
\description{
The output SQL statement is a simple \code{CREATE TABLE} with suitable for
\code{dbGetQuery}
}
\keyword{internal}