dbComment: Comment table/view/schema.

Description Usage Arguments Value Author(s) See Also Examples

View source: R/all_db_wrapper_fns.R

Description

Comment on a table, a view or a schema.

Usage

1
2
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

TRUE if the comment was successfully applied.

Author(s)

Mathieu Basille [email protected]

See Also

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

Examples

1
2
3
4
5
6
## 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 July 4, 2017, 9:32 a.m.