db_workspace_export: Export Notebook or Directory (Workspaces)

In zacdav-db/brickster: R Toolkit for 'Databricks'

Export Notebook or Directory (Workspaces)

Description

Export Notebook or Directory (Workspaces)

Usage

db_workspace_export(
  path,
  format = c("AUTO", "SOURCE", "HTML", "JUPYTER", "DBC", "R_MARKDOWN"),
  host = db_host(),
  token = db_token(),
  output_path = NULL,
  direct_download = FALSE,
  perform_request = TRUE
)

Arguments

path	Absolute path of the notebook or directory.
format	One of AUTO, SOURCE, HTML, JUPYTER, DBC, R_MARKDOWN. Default is SOURCE.
host	Databricks workspace URL, defaults to calling db_host().
token	Databricks workspace token, defaults to calling db_token().
output_path	Path to export file to, ensure to include correct suffix.
direct_download	Boolean (default: FALSE), if TRUE download file contents directly to file. Must also specify output_path.
perform_request	If TRUE (default) the request is performed, if FALSE the httr2 request is returned without being performed.

Details

Export a notebook or contents of an entire directory. If path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST.

You can export a directory only in DBC format. If the exported data exceeds the size limit, this call returns an error MAX_NOTEBOOK_SIZE_EXCEEDED. This API does not support exporting a library.

At this time we do not support the direct_download parameter and returns a base64 encoded string.

See More.

Value

base64 encoded string

See Also

Other Workspace API: db_workspace_delete(), db_workspace_get_status(), db_workspace_import(), db_workspace_list(), db_workspace_mkdirs()

zacdav-db/brickster documentation built on Feb. 25, 2025, 8:21 a.m.