add more info on current_user here and there

R/policies.R

@@ -18,6 +18,10 @@ rls_permissions <- function() {
 #' @export
 #' @param con a postgres or redshift connection object
 #' @return the current user, scalar
+#' @references <https://www.postgresql.org/docs/current/functions-info.html>
+#' <https://docs.aws.amazon.com/redshift/latest/dg/r_CURRENT_USER.html>
+#' @details uses PostgreSQL or Redshift `current_user` system information
+#' function
 #' @examplesIf has_postgres()
 #' library(DBI)
 #' library(RPostgres)

R/row_policy.R

@@ -65,6 +65,7 @@ commands <- function(.data, ...) {
 #' if (!dbExistsTable(con, "passwd")) {
 #'    setup_example_table(con, "passwd")
 #' }
+#' # current_user is a special system function
 #' rls_tbl(con, "passwd") %>%
 #'   row_policy("a_good_policy") %>%
 #'   commands(update) %>%
@@ -110,6 +111,7 @@ rows_existing <- function(.data, using = NULL, sql = NULL) {
 #'   rows_new(TRUE) %>%
 #'   to(jane)
 #'
+#' # current_user is a special system function
 #' rls_tbl(con, "passwd") %>%
 #'   row_policy("that_policy") %>%
 #'   commands(update) %>%

vignettes/rls.Rmd

@@ -187,7 +187,7 @@ rls_policies(con)
 ```
 
 `user_mod` = Normal users can update their own records, but limit
-which shells a normal user is allowed to set
+which shells a normal user is allowed to set (Note: `current_user` is a special system function that's part of PostgreSQL and Redshift that returns the current user)
 
 
 ``` r

vignettes/rls.Rmd.og

@@ -140,7 +140,7 @@ rls_policies(con)
 ```
 
 `user_mod` = Normal users can update their own records, but limit
-which shells a normal user is allowed to set
+which shells a normal user is allowed to set (Note: `current_user` is a special system function that's part of PostgreSQL and Redshift that returns the current user)
 
 ```{r}
 policy3 <- rls_tbl(con, "passwd") %>%