File: previewSql.Rd

package info (click to toggle)
r-cran-rstudioapi 0.17.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 916 kB
  • sloc: makefile: 2
file content (23 lines) | stat: -rw-r--r-- 672 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/preview.R
\name{previewSql}
\alias{previewSql}
\title{Preview SQL statement}
\usage{
previewSql(conn, statement, ...)
}
\arguments{
\item{conn}{The 'DBI' connection to be used to execute this statement.}

\item{statement}{The SQL statement to execute. Either a path to a file
containing a SQL statement or the SQL statement itself.}

\item{...}{Additional arguments to be used in \code{dbGetQuery()}.}
}
\description{
Makes use of 'DBI' and \code{dbGetQuery()} to preview a SQL statement for a
given 'DBI' connection.
}
\note{
The \code{previewSql} function was introduced in RStudio 1.2.600
}