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

In quinterpriest/DatabaseConnector: Connecting to Various Database Platforms

List field names of a remote table

Description

List field names of a remote table

Usage

## 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()

quinterpriest/DatabaseConnector documentation built on April 20, 2022, 12:48 a.m.