Comment table/view/schema.

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 (invisibly) TRUE if the comment was successfully applied.

See also

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

Author

Mathieu Basille mathieu@basille.org

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)
#> ℹ COMMENT ON VIEW "schema"."table" IS 'Comment on a view.';
#> ✖ Query not executed
dbComment(conn, name = "test_schema", comment = "Comment on a schema.", type = "schema",
    exec = FALSE)
#> ℹ COMMENT ON SCHEMA "test_schema" IS 'Comment on a schema.';
#> ✖ Query not executed