R: List field names of a remote table

dbListFields,OdbcConnection,character-method {odbc} | R Documentation

## List field names of a remote table

### Description

List field names of a remote table

### Usage

    ## S4 method for signature 'OdbcConnection,character'
    dbListFields(
      conn,
      name,
      catalog_name = NULL,
      schema_name = NULL,
      column_name = NULL,
      ...
    )

### Arguments

`conn` | A DBIConnection object, as returned by `dbConnect()`.
`name` | a character string with the name of the remote table.
`catalog_name` | The name of the catalog to return, the default returns all catalogs.
`schema_name` | The name of the schema to return, the default returns all schemas.
`column_name` | The name of the column to return, the default returns all columns.
`...` | Other parameters passed on to methods.

### Details

`%` can be used as a wildcard in any of the search parameters to match 0 or more characters. `_` can be used to match any single character.

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

### Specification

The `name` argument can be

- a string

- the return value of `dbQuoteIdentifier()`

- a value from the `table` column from the return value of `dbListObjects()` where `is_prefix` is `FALSE`

A column named `row_names` is treated like any other column.

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

### Examples

    con <- dbConnect(RSQLite::SQLite(), ":memory:")

    dbWriteTable(con, "mtcars", mtcars)
    dbListFields(con, "mtcars")

    dbDisconnect(con)

[Package odbc version 1.3.2 Index]