dbDrop: Drop table/view/schema.

In rpostgis: R Interface to a 'PostGIS' Database

Drop table/view/schema.

Description

Drop a table, a view or a schema.

Usage

dbDrop(
  conn,
  name,
  type = c("table", "schema", "view", "materialized view"),
  ifexists = FALSE,
  cascade = FALSE,
  display = TRUE,
  exec = TRUE
)

Arguments

conn	A connection object.
name	A character string specifying a PostgreSQL table, schema, or view name.
type	The type of the object to drop, either "table", "schema", "view", or "materialized view".
ifexists	Do not throw an error if the object does not exist. A notice is issued in this case.
cascade	Automatically drop objects that depend on the object (such as views).
display	Logical. Whether to display the query (defaults to TRUE).
exec	Logical. Whether to execute the query (defaults to TRUE).

Value

If exec = TRUE, returns TRUE if the table/schema/view was successfully dropped.

Author(s)

Mathieu Basille [e-mail]

See Also

The PostgreSQL documentation: http://www.postgresql.org/docs/current/static/sql-droptable.html, http://www.postgresql.org/docs/current/static/sql-dropview.html, http://www.postgresql.org/docs/current/static/sql-dropschema.html

Examples

## examples use a dummy connection from DBI package
conn <- DBI::ANSI()
dbDrop(conn, name = c("schema", "view_name"), type = "view", exec = FALSE)
dbDrop(conn, name = "test_schema", type = "schema", cascade = "TRUE", exec = FALSE)

rpostgis documentation built on Nov. 20, 2023, 5:07 p.m.