dbListObjects {DBI} | R Documentation |
Returns the names of remote objects accessible through this connection
as a data frame.
This should include temporary objects, but not all database backends
(in particular RMariaDB and RMySQL) support this.
Compared to dbListTables()
, this method also enumerates tables and views
in schemas, and returns fully qualified identifiers to access these objects.
This allows exploration of all database objects available to the current
user, including those that can only be accessed by giving the full
namespace.
dbListObjects(conn, prefix = NULL, ...)
conn |
A DBIConnection object, as returned by
|
prefix |
A fully qualified path in the database's namespace, or |
... |
Other parameters passed on to methods. |
dbListObjects()
returns a data frame
with columns
table
and is_prefix
(in that order),
optionally with other columns with a dot (.
) prefix.
The table
column is of type list.
Each object in this list is suitable for use as argument in dbQuoteIdentifier()
.
The is_prefix
column is a logical.
This data frame contains one row for each object (schema, table
and view)
accessible from the prefix (if passed) or from the global namespace
(if prefix is omitted).
Tables added with dbWriteTable()
are part of the data frame,
including temporary objects if supported by the database.
As soon a table is removed from the database,
it is also removed from the data frame of database objects.
The returned names are suitable for quoting with dbQuoteIdentifier()
.
An error is raised when calling this method for a closed
or invalid connection.
TBD: temporary = NA
This must be provided as named argument. See the "Specification" section for details on their usage.
Other DBIConnection generics: DBIConnection-class
,
dbDataType
, dbDisconnect
,
dbExecute
, dbExistsTable
,
dbGetException
, dbGetInfo
,
dbGetQuery
, dbIsValid
,
dbListFields
, dbListResults
,
dbListTables
, dbReadTable
,
dbRemoveTable
, dbSendQuery
,
dbSendStatement
, dbWriteTable
con <- dbConnect(RSQLite::SQLite(), ":memory:") dbListObjects(con) dbWriteTable(con, "mtcars", mtcars) dbListObjects(con) dbDisconnect(con)