File: make.db.names-MySQLConnection-character-method.Rd

package info (click to toggle)
rmysql 0.10.16-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 416 kB
  • sloc: ansic: 1,662; sh: 58; makefile: 5
file content (49 lines) | stat: -rw-r--r-- 1,873 bytes parent folder | download
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
41
42
43
44
45
46
47
48
49
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/escaping.R
\docType{methods}
\name{make.db.names,MySQLConnection,character-method}
\alias{SQLKeywords,MySQLConnection-method}
\alias{isSQLKeyword,MySQLConnection,character-method}
\alias{make.db.names,MySQLConnection,character-method}
\title{Make R/S-Plus identifiers into legal SQL identifiers}
\usage{
\S4method{make.db.names}{MySQLConnection,character}(dbObj, snames,
  keywords = .SQL92Keywords, unique = TRUE, allow.keywords = TRUE, ...)

\S4method{SQLKeywords}{MySQLConnection}(dbObj, ...)

\S4method{isSQLKeyword}{MySQLConnection,character}(dbObj, name,
  keywords = .MySQLKeywords, case = c("lower", "upper", "any")[3], ...)
}
\arguments{
\item{dbObj}{any MySQL object (e.g., \code{MySQLDriver}).}

\item{snames}{a character vector of R/S-Plus
identifiers (symbols) from which we need to make SQL identifiers.}

\item{keywords}{a character vector with SQL keywords, by default it is
\code{.MySQLKeywords} define in \code{RMySQL}. This may be overriden by
users.}

\item{unique}{logical describing whether the resulting set of SQL names
should be unique.  Its default is \code{TRUE}. Following the SQL 92
standard, uniqueness of SQL identifiers is determined regardless of whether
letters are upper or lower case.}

\item{allow.keywords}{logical describing whether SQL keywords should be
allowed in the resulting set of SQL names.  Its default is \code{TRUE}}

\item{...}{Unused, needed for compatibility with generic.}

\item{name}{a character vector of SQL identifiers we want to check against
keywords from the DBMS.}

\item{case}{a character string specifying whether to make the
comparison as lower case, upper case, or any of the two.  it defaults to
\code{any}.}
}
\description{
These methods are straight-forward implementations of the corresponding
generic functions.
}