dbComment: Comment table/view/schema.

In rpostgis: R Interface to a 'PostGIS' Database

Comment table/view/schema.

Description

Comment on a table, a view or a schema.

Usage

dbComment(
  conn,
  name,
  comment,
  type = c("table", "view", "schema"),
  display = TRUE,
  exec = TRUE
)

Arguments

conn	A connection object.
name	A character string specifying a PostgreSQL table, view or schema name.
comment	A character string specifying the comment.
type	The type of the object to comment, either "table", "view", or "schema"
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 comment was successfully applied.

Author(s)

Mathieu Basille [e-mail]

See Also

The PostgreSQL documentation: http://www.postgresql.org/docs/current/static/sql-comment.html

Examples

## examples use a dummy connection from DBI package
conn <- DBI::ANSI()
dbComment(conn, name = c("schema", "table"), comment = "Comment on a view.",
    type = "view", exec = FALSE)
dbComment(conn, name = "test_schema", comment = "Comment on a schema.", type = "schema",
    exec = FALSE)

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