dbListFields-DatabaseConnectorConnection-character-method: List field names of a remote table

Description Usage Arguments Value See Also

Description

List field names of a remote table

Usage

1
2
3
## S4 method for signature 'DatabaseConnectorConnection,character'
dbListFields(conn, name,
  database = NULL, schema = NULL, ...)

Arguments

conn

A DBIConnection object, as returned by dbConnect().

name

a character string with the name of the remote table.

database

Name of the database.

schema

Name of the schema.

...

Other parameters passed on to methods.

Value

dbListFields() returns a character vector that enumerates all fields in the table in the correct order. This also works for temporary tables if supported by the database. The returned names are suitable for quoting with dbQuoteIdentifier(). If the table does not exist, an error is raised. Invalid types for the name argument (e.g., character of length not equal to one, or numeric) lead to an error. An error is also raised when calling this method for a closed or invalid connection.

See Also

dbColumnInfo() to get the type of the fields.

Other DBIConnection generics: DBIConnection-class, dbAppendTable, dbCreateTable, dbDataType, dbDisconnect, dbExecute, dbExistsTable, dbGetException, dbGetInfo, dbGetQuery, dbIsReadOnly, dbIsValid, dbListObjects, dbListResults, dbListTables, dbReadTable, dbRemoveTable, dbSendQuery, dbSendStatement, dbWriteTable


OHDSI/DatabaseConnector documentation built on Nov. 16, 2018, 6:20 p.m.