R: Read a database table

dbReadTable,SQLiteConnection,character-method {RSQLite} | R Documentation

## Read a database table

### Description

Returns the contents of a database table given by name as a data frame.

### Usage

    ## S4 method for signature 'SQLiteConnection,character'
    dbReadTable(conn, name, ...,
      row.names = NA, check.names = TRUE, select.cols = "*")

### Arguments

`conn` | a `SQLiteConnection` object, produced by `DBI::dbConnect()`
`name` | a character string specifying a table name. SQLite table names are not case sensitive, e.g., table names `ABC` and `abc` are considered equal.
`...` | Needed for compatibility with generic. Otherwise ignored.
`row.names` | Either `TRUE`, `FALSE`, `NA` or a string. If `TRUE`, always translate row names to a column called "row_names". If `FALSE`, never translate row names. If `NA`, translate rownames only if they're a character vector. A string is equivalent to `TRUE`, but allows you to override the default name. For backward compatibility, `NULL` is equivalent to `FALSE`.
`check.names` | If `TRUE`, the default, column names will be converted to valid R identifiers.
`select.cols` | A SQL expression (in the form of a character vector of length 1) giving the columns to select. E.g. `"*"` selects all columns, `"x, y, z"` selects three columns named as listed.

### Details

Note that the data frame returned by `dbReadTable()` only has primitive data, e.g., it does not coerce character data to factors.

### Value

A data frame.

### See Also

The corresponding generic function `DBI::dbReadTable()`.

### Examples

    library(DBI)
    db <- RSQLite::datasetsDb()
    dbReadTable(db, "mtcars")
    dbReadTable(db, "mtcars", row.names = FALSE)
    dbReadTable(db, "mtcars", select.cols = "cyl, gear")
    dbReadTable(db, "mtcars", select.cols = "row_names, cyl, gear")
    dbDisconnect(db)

[Package RSQLite version 1.1-2 Index]