change rls_run to rls_perform, fix missing param def for restrictive fun

NAMESPACE

@@ -28,11 +28,11 @@ export(rls_drop_policies)
 export(rls_drop_policy)
 export(rls_enable)
 export(rls_list_roles)
+export(rls_perform)
 export(rls_permissions)
 export(rls_policies)
 export(rls_policy_exists)
 export(rls_privileges)
-export(rls_run)
 export(rls_table_privileges)
 export(rls_tbl)
 export(row_policy)

R/drop.R

@@ -26,13 +26,13 @@
 #' policy1 <- rls_tbl(con, "atable") %>%
 #'   row_policy("hide_confidential") %>%
 #'   rows_existing(TRUE)
-#' rls_run(policy1)
+#' rls_perform(policy1)
 #'
 #' rls_policies(con)
 #' rls_drop_policy(con, policy1)
 #' rls_policies(con)
 #'
-#' rls_run(policy1)
+#' rls_perform(policy1)
 #' rls_policies(con)
 #' rls_drop_policies(con)
 #' rls_policies(con)

R/exists.R

@@ -18,7 +18,7 @@
 #'   rows_existing(TRUE) %>%
 #'   to(jane)
 #' policy
-#' rls_run(policy)
+#' rls_perform(policy)
 #' rls_policies(con)
 #' rls_policy_exists(con, "some_policy")
 #' rls_drop_policy(con, name = "some_policy", table = "attitude")

R/list.R

@@ -17,7 +17,7 @@
 #'   row_policy("all_view") %>%
 #'   commands(select) %>%
 #'   rows_existing(TRUE) %>%
-#'   rls_run()
+#'   rls_perform()
 #' rls_policies(con)
 #' rls_drop_policies(con)
 #' dbRemoveTable(con, "attitude")

R/run.R → R/perform.R

@@ -1,4 +1,4 @@
-#' Run a query
+#' Perform a query
 #'
 #' @export
 #' @param query an s3 object of class `privilege` or `row_policy, required.
@@ -7,7 +7,7 @@
 #' @param con DBI connection object, optional, see `query`
 #' @return error from PostgreSQL or Redshift upon error, or an integer
 #' value
-rls_run <- function(query, con = NULL) {
+rls_perform <- function(query, con = NULL) {
   assert_is(query, c("privilege", "row_policy"))
   con <- as_con(query %||% con)
   is_conn(con)

R/pipeline.R

@@ -75,7 +75,7 @@ pipe_autoexec <- function(toggle) {
   if (isTRUE(info[["is_piped"]])) {
     rls_exit <- function(x) {
       if (inherits(x, c("privilege", "row_policy"))) {
-        rls_run(x, x$data$src$con)
+        rls_perform(x, x$data$src$con)
       } else {
         x
       }

R/policies.R

@@ -51,7 +51,7 @@ rls_current_user <- function(con) {
 #' rls_tbl(con, "passwd") %>%
 #'   grant(select, cols = columns) %>%
 #'   to(sammy) %>%
-#'   rls_run()
+#'   rls_perform()
 #' # Just user sammy
 #' rls_column_privileges(con, "passwd", "sammy")
 #' # All users
@@ -172,7 +172,7 @@ table_privileges_query <- function(con, table, schema, user_role, urtable,
 #'   row_policy(name = "stuff") %>%
 #'   rows_existing(TRUE) %>%
 #'   to(jane) %>% 
-#'   rls_run()
+#'   rls_perform()
 #' 
 #' rls_privileges(con, "passwd", "jane")
 #' 

R/rls_tbl.R

@@ -19,7 +19,7 @@
 #' rls_tbl(con, "passwd") %>%
 #'   grant(select) %>%
 #'   to(ally) %>%
-#'   rls_run()
+#'   rls_perform()
 #' dbExecute(con, "SET SESSION AUTHORIZATION ally")
 #' rls_tbl(con, "passwd")
 #' dbExecute(con, glue::glue("SET SESSION AUTHORIZATION {user}"))

R/row_policy.R

@@ -26,7 +26,7 @@
 #' }
 #' rls_tbl(con, "passwd") %>%
 #'   row_policy("my_policy") %>%
-#'   rls_run()
+#'   rls_perform()
 #' rls_policies(con)
 #'
 #' # cleanup
@@ -166,6 +166,7 @@ express <- function(x) {
 #' Set RLS policy to be restrictive
 #'
 #' @export
+#' @inheritParams grant
 #' @inherit row_policy return
 #' @details By default row level policies are permissive. Permissive policies
 #' are applied using a boolean "OR", so you need permission from only one

tests/testthat/test-rls_drop_policy.R

@@ -9,7 +9,7 @@ test_that("rls_drop_policy", {
       row_policy("hide_confidential") %>%
       rows_existing(TRUE)
 
-    rls_run(the_policy)
+    rls_perform(the_policy)
 
     policies_before <- rls_policies(con)
     out <- rls_drop_policy(con, the_policy)

tests/testthat/test-rls_policies.R

@@ -15,7 +15,7 @@ test_that("rls_policies", {
       commands(select) %>%
       rows_existing(TRUE)
 
-    rls_run(my_policy)
+    rls_perform(my_policy)
 
     policies <- rls_policies(con)