Extending Unity Catalog Functions (Catalogs, Schemas, Volumes, Tables) (#80)

* Exporting UC table management endpoints.

* Exporting list/get functions for catalogs/schemas.

* Adding and exporting volume management functions.
Minor tweaks to docs for UC functions to group into families.

* fixing minor docs issues for R CMD CHECK

---------

Co-authored-by: Zac Davies <[email protected]>

Author: zacdav-db

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: brickster
 Title: R Toolkit for 'Databricks'
-Version: 0.2.6
+Version: 0.2.7
 Authors@R: 
   c(
     person(given = "Zac",

NAMESPACE

@@ -110,6 +110,20 @@ export(db_sql_warehouse_list)
 export(db_sql_warehouse_start)
 export(db_sql_warehouse_stop)
 export(db_token)
+export(db_uc_catalogs_get)
+export(db_uc_catalogs_list)
+export(db_uc_schemas_get)
+export(db_uc_schemas_list)
+export(db_uc_tables_delete)
+export(db_uc_tables_exists)
+export(db_uc_tables_get)
+export(db_uc_tables_list)
+export(db_uc_tables_summaries)
+export(db_uc_volumes_create)
+export(db_uc_volumes_delete)
+export(db_uc_volumes_get)
+export(db_uc_volumes_list)
+export(db_uc_volumes_update)
 export(db_volume_delete)
 export(db_volume_dir_create)
 export(db_volume_dir_delete)

NEWS.md

@@ -1,4 +1,12 @@
+# brickster 0.2.7
+
+* Exporting UC table functions (`db_uc_table*`) (#72)
+* Adding support for `direct_download` option in `db_workspace_export()`
+* Exporting UC Catalog/Schema get/list functions (#72)
+* Adding support for UC Volume management (#72)
+
 # brickster 0.2.6
+
 * Fixing `db_volume_delete()` function (#73, @vladimirobucina)
 * Adjustments to ensure {httr2} changes don't break things (#75, @hadley)
 

R/connection-pane.R

@@ -298,6 +298,9 @@ get_table_data <- function(catalog, schema, table, host, token, metadata = TRUE)
     catalog = catalog,
     schema = schema,
     table = table,
+    omit_columns = FALSE,
+    omit_properties = FALSE,
+    omit_username = FALSE,
     host = host,
     token = token,
   )

R/dbfs.R

@@ -429,7 +429,7 @@ db_dbfs_put <- function(path, file = NULL, contents = NULL, overwrite = FALSE,
 
   body <- list(
     path = path,
-    overwrite = ifelse(overwrite, "true", "false") # doesn't like bool :(
+    overwrite = from_logical(overwrite)
   )
 
   # file takes priority, so don't bother if file is also specified

R/request-helpers.R

@@ -123,3 +123,9 @@ db_request_json <- function(req) {
     NULL
   }
 }
+
+# some endpoints don't play nice and except strings 'true' and 'false'
+from_logical <- function(x) {
+  stopifnot(is.logical(x))
+  ifelse(x, "true", "false")
+}

R/uc-catalogs.R

@@ -0,0 +1,74 @@
+#' List Catalogs (Unity Catalog)
+#'
+#' @param max_results Maximum number of catalogs to return (default: 1000).
+#' @param include_browse Whether to include catalogs in the response for which
+#' the principal can only access selective metadata for.
+#' @inheritParams auth_params
+#' @inheritParams db_sql_query_history
+#' @inheritParams db_sql_warehouse_create
+#'
+#' @family Unity Catalog Management
+#'
+#' @returns List
+#' @export
+db_uc_catalogs_list <- function(max_results = 1000,
+                                include_browse = TRUE,
+                                page_token = NULL,
+                                host = db_host(), token = db_token(),
+                                perform_request = TRUE) {
+
+  stopifnot(max_results <= 1000)
+
+  body <- list(
+    max_results = max_results,
+    include_browse = include_browse,
+    page_token = page_token
+  )
+
+  req <- db_request(
+    endpoint = "unity-catalog/catalogs",
+    method = "GET",
+    version = "2.1",
+    host = host,
+    token = token,
+    body = body
+  )
+
+  if (perform_request) {
+    db_perform_request(req)$catalogs
+  } else {
+    req
+  }
+}
+
+
+#' Get Catalog (Unity Catalog)
+#'
+#' @param catalog The name of the catalog.
+#' @inheritParams auth_params
+#' @inheritParams db_sql_query_history
+#' @inheritParams db_sql_warehouse_create
+#'
+#' @family Unity Catalog Management
+#'
+#' @returns List
+#' @export
+db_uc_catalogs_get <- function(catalog,
+                               host = db_host(), token = db_token(),
+                               perform_request = TRUE) {
+
+  req <- db_request(
+    endpoint = "unity-catalog/catalogs/",
+    method = "GET",
+    version = "2.1",
+    host = host,
+    token = token
+  ) |>
+    httr2::req_url_path_append(catalog)
+
+  if (perform_request) {
+    db_perform_request(req)
+  } else {
+    req
+  }
+}

R/uc-schemas.R

@@ -0,0 +1,81 @@
+#' List Schemas (Unity Catalog)
+#'
+#' @param catalog Parent catalog for schemas of interest.
+#' @param max_results Maximum number of schemas to return (default: 1000).
+#' @inheritParams auth_params
+#' @inheritParams db_sql_query_history
+#' @inheritParams db_sql_warehouse_create
+#'
+#' @family Unity Catalog Management
+#'
+#' @returns List
+#' @export
+db_uc_schemas_list <- function(catalog,
+                               max_results = 1000,
+                               page_token = NULL,
+                               host = db_host(), token = db_token(),
+                               perform_request = TRUE) {
+
+  stopifnot(max_results <= 1000)
+
+  body <- list(
+    max_results = max_results,
+    page_token = page_token
+  )
+
+  req <- db_request(
+    endpoint = "unity-catalog/schemas",
+    method = "GET",
+    version = "2.1",
+    host = host,
+    token = token,
+    body = body
+  ) |>
+    httr2::req_url_query(catalog_name = catalog)
+
+  if (perform_request) {
+    db_perform_request(req)$schemas
+  } else {
+    req
+  }
+}
+
+
+#' Get Schema (Unity Catalog)
+#'
+#' @param catalog Parent catalog for schema of interest.
+#' @param schema Schema of interest.
+#' @inheritParams auth_params
+#' @inheritParams db_sql_query_history
+#' @inheritParams db_uc_catalogs_list
+#'
+#' @family Unity Catalog Management
+#'
+#' @returns List
+#' @export
+db_uc_schemas_get <- function(catalog, schema,
+                              include_browse = TRUE,
+                              host = db_host(), token = db_token(),
+                              perform_request = TRUE) {
+
+  body <- list(
+    include_browse = include_browse
+  )
+
+  req <- db_request(
+    endpoint = "unity-catalog/schemas/",
+    method = "GET",
+    version = "2.1",
+    host = host,
+    token = token,
+    body = body
+  ) |>
+    httr2::req_url_path_append(paste(catalog, schema, sep = "."))
+
+  if (perform_request) {
+    db_perform_request(req)
+  } else {
+    req
+  }
+}
+