db_dbfs_create: DBFS Create

In brickster: R Toolkit for 'Databricks'

DBFS Create

Description

Open a stream to write to a file and returns a handle to this stream.

Usage

db_dbfs_create(
  path,
  overwrite = FALSE,
  host = db_host(),
  token = db_token(),
  perform_request = TRUE
)

Arguments

path	The path of the new file. The path should be the absolute DBFS path (for example ⁠/mnt/my-file.txt⁠).
overwrite	Boolean, specifies whether to overwrite existing file or files.
host	Databricks workspace URL, defaults to calling db_host().
token	Databricks workspace token, defaults to calling db_token().
perform_request	If TRUE (default) the request is performed, if FALSE the httr2 request is returned without being performed.

Details

There is a 10 minute idle timeout on this handle. If a file or directory already exists on the given path and overwrite is set to FALSE, this call throws an exception with RESOURCE_ALREADY_EXISTS.

Value

Handle which should subsequently be passed into db_dbfs_add_block() and db_dbfs_close() when writing to a file through a stream.

Typical File Upload Flow

• Call create and get a handle via db_dbfs_create()

• Make one or more db_dbfs_add_block() calls with the handle you have

• Call db_dbfs_close() with the handle you have

See Also

Other DBFS API: db_dbfs_add_block(), db_dbfs_close(), db_dbfs_delete(), db_dbfs_get_status(), db_dbfs_list(), db_dbfs_mkdirs(), db_dbfs_move(), db_dbfs_put(), db_dbfs_read()

brickster documentation built on April 12, 2025, 1:21 a.m.