AdbiConnection-class: Class AdbiConnection (and methods)

In adbi: 'DBI' Compliant Database Access Using 'ADBC'

Class AdbiConnection (and methods)

Description

AdbiConnection objects are created by passing adbi() as first argument to DBI::dbConnect(). They are a superclass of the DBIConnection class. The "Usage" section lists the class methods overridden by adbi.

Usage

## S4 method for signature 'AdbiConnection'
dbAppendTable(conn, name, value, ..., row.names = NULL)

## S4 method for signature 'AdbiConnection'
dbBegin(conn, ...)

## S4 method for signature 'AdbiConnection'
dbCommit(conn, ...)

## S4 method for signature 'AdbiConnection'
dbDataType(dbObj, obj, ...)

## S4 method for signature 'AdbiConnection,Id'
dbExistsTable(conn, name, ...)

## S4 method for signature 'AdbiConnection,SQL'
dbExistsTable(conn, name, ...)

## S4 method for signature 'AdbiConnection,character'
dbExistsTable(conn, name, ...)

## S4 method for signature 'AdbiConnection'
dbGetInfo(dbObj, ...)

## S4 method for signature 'AdbiConnection'
dbIsValid(dbObj, ...)

## S4 method for signature 'AdbiConnection,Id'
dbListFields(conn, name, ...)

## S4 method for signature 'AdbiConnection,SQL'
dbListFields(conn, name, ...)

## S4 method for signature 'AdbiConnection,character'
dbListFields(conn, name, ...)

## S4 method for signature 'AdbiConnection'
dbListTables(conn, ...)

## S4 method for signature 'AdbiConnection,character'
dbQuoteIdentifier(conn, x, ...)

## S4 method for signature 'AdbiConnection,character'
dbQuoteLiteral(conn, x, ...)

## S4 method for signature 'AdbiConnection,character'
dbQuoteString(conn, x, ...)

## S4 method for signature 'AdbiConnection,character'
dbRemoveTable(conn, name, ..., temporary = FALSE, fail_if_missing = TRUE)

## S4 method for signature 'AdbiConnection,Id'
dbRemoveTable(conn, name, ..., temporary = FALSE, fail_if_missing = TRUE)

## S4 method for signature 'AdbiConnection'
dbRollback(conn, ...)

## S4 method for signature 'AdbiConnection'
dbUnquoteIdentifier(conn, x, ...)

## S4 method for signature 'AdbiConnection,Id,data.frame'
dbWriteTable(
  conn,
  name,
  value,
  overwrite = FALSE,
  append = FALSE,
  ...,
  field.types = NULL,
  row.names = NULL,
  temporary = FALSE
)

## S4 method for signature 'AdbiConnection,SQL,data.frame'
dbWriteTable(conn, name, value, ...)

## S4 method for signature 'AdbiConnection,character,data.frame'
dbWriteTable(conn, name, value, ...)

## S4 method for signature 'AdbiConnection'
show(object)

Arguments

conn	A DBIConnection object, as returned by dbConnect().
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"')
value	A data.frame (or coercible to data.frame).
...	Other parameters passed on to methods.
row.names	A logical specifying whether the row.names should be output to the output DBMS table; if TRUE, an extra field whose name will be whatever the R identifier "row.names" maps to the DBMS (see DBI::make.db.names()). If NA will add rows names if they are characters, otherwise will ignore.
dbObj	A object inheriting from DBIDriver or DBIConnection
obj	An R object whose SQL type we want to determine.
x	A character vector, SQL or Id object to quote as identifier.
temporary	a logical specifying whether the new table should be temporary. Its default is FALSE.
fail_if_missing	If FALSE, dbRemoveTable() succeeds if the table doesn't exist.
overwrite	Allow overwriting the destination table. Cannot be TRUE if append is also TRUE.
append	Allow appending to the destination table. Cannot be TRUE if overwrite is also TRUE.
field.types	character vector of named SQL field types where the names are the names of new table's columns. If missing, types inferred with DBI::dbDataType()).
object	Any R object

See Also

The corresponding generic functions DBI::dbSendQuery(), DBI::dbGetQuery(), DBI::dbSendStatement(), DBI::dbExecute(), DBI::dbExistsTable(), DBI::dbListTables(), DBI::dbListFields(), DBI::dbRemoveTable(), and DBI::sqlData().

adbi documentation built on May 29, 2024, 7:12 a.m.