diff --git a/man/board_databricks.Rd b/man/board_databricks.Rd index 5fa5d7d8..2f775e07 100644 --- a/man/board_databricks.Rd +++ b/man/board_databricks.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/board-databricks.R +% Please edit documentation in R/board_databricks.R \name{board_databricks} \alias{board_databricks} \title{Use a Databricks Volume as a board} @@ -14,19 +14,19 @@ board_databricks( } \arguments{ \item{folder_url}{The path to the target folder inside Unity Catalog. The path -will include the catalog, schema and volume name, preceded by the 'Volumes/' -folder. For example: /Volumes/my-catalog/my-schema/my-volume.} +will include the catalog, schema, and volume names, preceded by the 'Volumes/' +folder. For example: \code{"/Volumes/my-catalog/my-schema/my-volume"}.} \item{host}{Your \href{https://docs.databricks.com/en/workspace/workspace-details.html#workspace-url}{Workspace Instance URL}. -If \code{NULL}, it will search for URL in two different environment variables: +If \code{NULL}, it will search for this URL in two different environment +variables, in this order: \itemize{ \item 'DATABRICKS_HOST' \item 'CONNECT_DATABRICKS_HOST' -} - -Defaults to \code{NULL}.} +Defaults to \code{NULL}. +}} -\item{prefix}{Prefix within this bucket that this board will occupy. +\item{prefix}{Prefix within the bucket that this board will occupy. You can use this to maintain multiple independent pin boards within a single Databricks Volume. Make sure to end with '/', so as to take advantage of Databricks Volume directory-like handling.} @@ -38,11 +38,11 @@ downloading files multiple times. The default stores in a standard cache location for your operating system, but you can override if needed.} } \description{ -Pin data to a \href{https://docs.databricks.com/en/sql/language-manual/sql-ref-volumes.html}{Datbricks Volume} +Pin data to a \href{https://docs.databricks.com/en/sql/language-manual/sql-ref-volumes.html}{Databricks Volume} } \section{Authentication}{ -\code{board_databricks()} searches for authentication token in three different -places, in order they are: +\code{board_databricks()} searches for an authentication token in three different +places, in this order: \itemize{ \item 'DATABRICKS_TOKEN' environment variable \item 'CONNECT_DATABRICKS_TOKEN' environment variable @@ -50,15 +50,18 @@ places, in order they are: } In most cases, the authentication will be a Personal Authentication -Token ('PAT') that is saved 'DATABRICKS_TOKEN' environment variable. To -obtain a 'PAT' see: \href{https://docs.databricks.com/en/dev-tools/auth/pat.html}{Databricks personal access token authentication}. +Token ('PAT') that is saved as the 'DATABRICKS_TOKEN' environment variable. +To obtain a 'PAT' see: \href{https://docs.databricks.com/en/dev-tools/auth/pat.html}{Databricks personal access token authentication}. } \section{Details}{ \itemize{ \item The functions in pins do not create a new bucket. -\item The integration with Databricks depends on \code{httr2} which is a -suggested dependency of pins (not required for pins in general). +\item \code{board_databricks()} is powered by the httr2 package, which is a +suggested dependency of pins (not required for pins in general). If +you run into errors when deploying content to a server like +\url{https://www.shinyapps.io} or \href{https://posit.co/products/enterprise/connect/}{Connect}, +add \code{requireNamespace("httr2")} to your app or document for \href{https://docs.posit.co/connect/user/troubleshooting/#render-missing-r-package}{automatic dependency discovery}. } } diff --git a/man/required_pkgs.pins_board.Rd b/man/required_pkgs.pins_board.Rd index 18e15266..e086444e 100644 --- a/man/required_pkgs.pins_board.Rd +++ b/man/required_pkgs.pins_board.Rd @@ -1,11 +1,11 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/board-databricks.R, R/board_azure.R, -% R/board_connect.R, R/board_gcs.R, R/board_gdrive.R, R/board_ms365.R, +% Please edit documentation in R/board_azure.R, R/board_connect.R, +% R/board_databricks.R, R/board_gcs.R, R/board_gdrive.R, R/board_ms365.R, % R/board_s3.R, R/required_pkgs.R -\name{required_pkgs.pins_board_databricks} -\alias{required_pkgs.pins_board_databricks} +\name{required_pkgs.pins_board_azure} \alias{required_pkgs.pins_board_azure} \alias{required_pkgs.pins_board_connect} +\alias{required_pkgs.pins_board_databricks} \alias{required_pkgs.pins_board_gcs} \alias{required_pkgs.pins_board_gdrive} \alias{required_pkgs.pins_board_ms365} @@ -13,12 +13,12 @@ \alias{required_pkgs.pins_board} \title{Determine required packages for a pins board} \usage{ -\method{required_pkgs}{pins_board_databricks}(x, ...) - \method{required_pkgs}{pins_board_azure}(x, ...) \method{required_pkgs}{pins_board_connect}(x, ...) +\method{required_pkgs}{pins_board_databricks}(x, ...) + \method{required_pkgs}{pins_board_gcs}(x, ...) \method{required_pkgs}{pins_board_gdrive}(x, ...)