Learn R Programming
odbc (version 1.6.0)

OdbcConnection-class: Odbc Connection Methods

Description

Implementations of pure virtual functions defined in the DBI package for OdbcConnection objects.

Usage

# S4 method for OdbcConnection
show(object)
# S4 method for OdbcConnection
dbIsValid(dbObj, ...)
# S4 method for OdbcConnection
dbDisconnect(conn, ...)
# S4 method for OdbcConnection,character
dbSendQuery(conn, statement, params = NULL, ..., immediate = FALSE)
# S4 method for OdbcConnection,character
dbExecute(conn, statement, params = NULL, ..., immediate = is.null(params))
# S4 method for OdbcConnection,character
dbSendStatement(conn, statement, params = NULL, ..., immediate = FALSE)
# S4 method for OdbcConnection,ANY
dbDataType(dbObj, obj, ...)
# S4 method for OdbcConnection,data.frame
dbDataType(dbObj, obj, ...)
# S4 method for OdbcConnection,character
dbQuoteIdentifier(conn, x, ...)
# S4 method for OdbcConnection,SQL
dbQuoteIdentifier(conn, x, ...)
# S4 method for OdbcConnection
dbGetInfo(dbObj, ...)
# S4 method for OdbcConnection,character
dbGetQuery(
  conn,
  statement,
  n = -1,
  params = NULL,
  immediate = is.null(params),
  ...
)
# S4 method for OdbcConnection
dbBegin(conn, ...)
# S4 method for OdbcConnection
dbCommit(conn, ...)
# S4 method for OdbcConnection
dbRollback(conn, ...)
# S4 method for OdbcConnection,Id
dbListFields(conn, name, ...)
# S4 method for OdbcConnection,SQL
dbListFields(conn, name, ...)
# S4 method for OdbcConnection,character
dbListFields(
  conn,
  name,
  catalog_name = NULL,
  schema_name = NULL,
  column_name = NULL,
  ...
)
# S4 method for OdbcConnection,Id
dbExistsTable(conn, name, ...)
# S4 method for OdbcConnection,SQL
dbExistsTable(conn, name, ...)
# S4 method for OdbcConnection,character
dbExistsTable(conn, name, ...)
# S4 method for OdbcConnection,character
dbRemoveTable(conn, name, ...)

Arguments

object

Any R object

dbObj

An object inheriting from DBIObject, i.e. DBIDriver, DBIConnection, or a DBIResult.

...

Other arguments to methods.

conn

A DBI::DBIConnection object, as returned by dbConnect().

statement

a character string containing SQL.

params

Query parameters to pass to DBI::dbBind(). See DBI::dbBind() for details.

immediate

If TRUE, SQLExecDirect will be used instead of SQLPrepare, and the params argument is ignored

obj

An R object whose SQL type we want to determine.

x

A character vector, SQL or Id object to quote as identifier.

n

maximum number of records to retrieve per fetch. Use n = -1 or n = Inf to retrieve all pending records. Some implementations may recognize other special values.

name

The table name, passed on to dbQuoteIdentifier(). Options are:

  • a character string with the unquoted DBMS table name, e.g. "table_name",

  • a call to Id() with components to the fully qualified table name, e.g. Id(schema = "my_schema", table = "table_name")

  • a call to SQL() with the quoted and fully qualified table name given verbatim, e.g. SQL('"my_schema"."table_name"')

catalog_name

Catalog where table is located.

schema_name

Schema where table is located.

column_name

The name of the column to return, the default returns all columns.