DBI function

DBI methods

DBI methods

Implementations of pure virtual functions defined in the DBI package. class

## S4 method for signature 'bq_dataset' dbConnect(drv, ...) ## S4 method for signature 'BigQueryDriver' show(object) ## S4 method for signature 'BigQueryDriver' dbGetInfo(dbObj, ...) ## S4 method for signature 'BigQueryDriver' dbIsValid(dbObj, ...) ## S4 method for signature 'BigQueryDriver' dbDataType(dbObj, obj, ...) ## S4 method for signature 'BigQueryConnection' show(object) ## S4 method for signature 'BigQueryConnection' dbIsValid(dbObj, ...) ## S4 method for signature 'BigQueryConnection' dbDisconnect(conn, ...) ## S4 method for signature 'BigQueryConnection,character' dbSendQuery(conn, statement, ..., params = NULL) ## S4 method for signature 'BigQueryConnection,character' dbExecute(conn, statement, ...) ## S4 method for signature 'BigQueryConnection,character' dbQuoteString(conn, x, ...) ## S4 method for signature 'BigQueryConnection,SQL' dbQuoteString(conn, x, ...) ## S4 method for signature 'BigQueryConnection,character' dbQuoteIdentifier(conn, x, ...) ## S4 method for signature 'BigQueryConnection,SQL' dbQuoteIdentifier(conn, x, ...) ## S4 method for signature 'BigQueryConnection,logical' dbQuoteLiteral(conn, x, ...) ## S4 method for signature 'BigQueryConnection' dbDataType(dbObj, obj, ...) ## S4 method for signature 'BigQueryConnection,character,data.frame' dbWriteTable( conn, name, value, ..., overwrite = FALSE, append = FALSE, field.types = NULL, temporary = FALSE, row.names = NA ) ## S4 method for signature 'BigQueryConnection,Id,data.frame' dbWriteTable( conn, name, value, ..., overwrite = FALSE, append = FALSE, field.types = NULL, temporary = FALSE, row.names = NA ) ## S4 method for signature 'BigQueryConnection,AsIs,data.frame' dbWriteTable( conn, name, value, ..., overwrite = FALSE, append = FALSE, field.types = NULL, temporary = FALSE, row.names = NA ) ## S4 method for signature 'BigQueryConnection,character,data.frame' dbAppendTable(conn, name, value, ..., row.names = NULL) ## S4 method for signature 'BigQueryConnection,Id,data.frame' dbAppendTable(conn, name, value, ..., row.names = NULL) ## S4 method for signature 'BigQueryConnection,AsIs,data.frame' dbAppendTable(conn, name, value, ..., row.names = NULL) ## S4 method for signature 'BigQueryConnection' dbCreateTable(conn, name, fields, ..., row.names = NULL, temporary = FALSE) ## S4 method for signature 'BigQueryConnection' dbCreateTable(conn, name, fields, ..., row.names = NULL, temporary = FALSE) ## S4 method for signature 'BigQueryConnection,character' dbReadTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection,Id' dbReadTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection,AsIs' dbReadTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection' dbListTables(conn, ...) ## S4 method for signature 'BigQueryConnection,character' dbExistsTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection,Id' dbExistsTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection,AsIs' dbExistsTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection,character' dbListFields(conn, name, ...) ## S4 method for signature 'BigQueryConnection,Id' dbListFields(conn, name, ...) ## S4 method for signature 'BigQueryConnection,AsIs' dbListFields(conn, name, ...) ## S4 method for signature 'BigQueryConnection,character' dbRemoveTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection,Id' dbRemoveTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection,AsIs' dbRemoveTable(conn, name, ...) ## S4 method for signature 'BigQueryConnection' dbGetInfo(dbObj, ...) ## S4 method for signature 'BigQueryConnection' dbBegin(conn, ...) ## S4 method for signature 'BigQueryConnection' dbCommit(conn, ...) ## S4 method for signature 'BigQueryConnection' dbRollback(conn, ...) ## S4 method for signature 'BigQueryResult' show(object) ## S4 method for signature 'BigQueryResult' dbIsValid(dbObj, ...) ## S4 method for signature 'BigQueryResult' dbClearResult(res, ...) ## S4 method for signature 'BigQueryResult' dbFetch(res, n = -1, ...) ## S4 method for signature 'BigQueryResult' dbHasCompleted(res, ...) ## S4 method for signature 'BigQueryResult' dbGetStatement(res, ...) ## S4 method for signature 'BigQueryResult' dbColumnInfo(res, ...) ## S4 method for signature 'BigQueryResult' dbGetRowCount(res, ...) ## S4 method for signature 'BigQueryResult' dbGetRowsAffected(res, ...) ## S4 method for signature 'BigQueryResult' dbBind(res, params, ...)

Arguments

  • ...: Other arguments to methods.

  • object: Any R object

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

  • obj: An R object whose SQL type we want to determine.

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

  • statement: a character string containing SQL.

  • params: For dbBind(), a list of values, named or unnamed, or a data frame, with one element/column per query parameter. For dbBindArrow(), values as a nanoarrow stream, with one column per query parameter.

  • x: A character vector to quote as string.

  • 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).

  • overwrite: a logical specifying whether to overwrite an existing table or not. Its default is FALSE.

  • append: a logical specifying whether to append to an existing table in the DBMS. Its default is FALSE.

  • field.types, temporary: Ignored. Included for compatibility with generic.

  • 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.

  • fields: Either a character vector or a data frame.

    A named character vector: Names are column names, values are types. Names are escaped with dbQuoteIdentifier(). Field types are unescaped.

    A data frame: field types are generated using dbDataType().

  • res: An object inheriting from DBIResult .

  • 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.

  • Maintainer: Hadley Wickham
  • License: MIT + file LICENSE
  • Last published: 2024-03-14