Package: notebookutils 1.6.2

runtimeexp

notebookutils: Dummy R APIs Used in 'Azure Synapse Analytics' for Local Developments

This is a pure dummy interfaces package which mirrors 'MsSparkUtils' APIs <https://learn.microsoft.com/en-us/azure/synapse-analytics/spark/microsoft-spark-utilities?pivots=programming-language-r> of 'Azure Synapse Analytics' <https://learn.microsoft.com/en-us/azure/synapse-analytics/> for R users, customer of Azure Synapse can download this package from CRAN for local development.

Authors:runtimeexp [aut, cre], Microsoft [cph]

notebookutils_1.6.2.tar.gz
notebookutils_1.6.2.zip(r-4.7-any)notebookutils_1.6.2.zip(r-4.6-any)
notebookutils_1.6.2.tar.gz(r-4.7-any)notebookutils_1.6.2.tar.gz(r-4.6-any)
notebookutils_1.6.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
notebookutils/json (API)

# Install 'notebookutils' in R:

install.packages('notebookutils', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

On CRAN:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

2.04 score 11 scripts 299 downloads 138 exports 0 dependencies

Last updated from:2ef13a90dd. Checks:6 OK. Indexed: yes.

Target	Result	Time
linux-devel	OK	116
source / vignettes	OK	284
linux-release	OK	124
windows-devel	OK	78
windows-release	OK	67
wasm-release	OK	93

Dependencies:

notebookutils-tutorial

Rendered fromnotebookutils-tutorial.Rmdusingknitr::rmarkdown

Last update: 2026-01-26
Started: 2023-02-20

Citation

Readme and manuals

Help Manual

Help page	Topics
Set the dataframe info which needs to be visualized.	display
Set the chart config metadata for current dataframe (set by 'display') which needs to be visualized.	display.config
Set the visualizer custom options related to the current dataframe, it will be consumed when executing 'display'.	display.configCustomOptions
Construct an specific html fragment to synapse notebook front-end for rendering based on user-input html content.	displayHTML
Take linked service name as input and return connection string or credentials depending on the configuration of the linked service.	mssparkutils.credentials.getConnectionStringOrCreds
Take linked service name as input and return full connection string with credentials.	mssparkutils.credentials.getFullConnectionString
Return all the properties of a given linked service in string format.	mssparkutils.credentials.getPropertiesAll
Return AKV secret.	mssparkutils.credentials.getSecret
Return AKV secret using linkedService.	mssparkutils.credentials.getSecretWithLS
Get AAD token for a resource.	mssparkutils.credentials.getToken
Get help message.	mssparkutils.credentials.help
Returns true if the input token is valid (i.e, hasn't expired).	mssparkutils.credentials.isValidToken
Put AKV secret using with or without linkedService.	mssparkutils.credentials.putSecret
Put AKV secret using linkedService.	mssparkutils.credentials.putSecretWithLS
Get cluster id.	mssparkutils.env.getClusterId
Get job Id.	mssparkutils.env.getJobId
Get pool name.	mssparkutils.env.getPoolName
Get user Id.	mssparkutils.env.getUserId
Get user name.	mssparkutils.env.getUserName
Get workspace name.	mssparkutils.env.getWorkspaceName
Get help message.	mssparkutils.env.help
Append the given String to a file, encoded in UTF-8.	mssparkutils.fs.append
Copies a file or directory, possibly across FileSystems.	mssparkutils.fs.cp
Check if a file or directory exists.	mssparkutils.fs.exists
Copies a file or directory via azcopy, possibly across FileSystems.	mssparkutils.fs.fastcp
Gets the local path of the mount point.	mssparkutils.fs.getMountPath
Returns up to the first 'maxBytes' bytes of the given file as a String encoded in UTF-8.	mssparkutils.fs.head
mssparkutils.fs provides utilities for working with various FileSystems.	mssparkutils.fs.help
Lists the contents of a directory.	mssparkutils.fs.ls
Creates the given directory if it does not exist, also creating any necessary parent * directories.	mssparkutils.fs.mkdirs
Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)	mssparkutils.fs.mount
Show information about what is mounted. Any credentials used to mount the mount points listed will not be displayed.	mssparkutils.fs.mounts
Attach remote storage (Blob, Gen2, Azure File Share) to driver node	mssparkutils.fs.mountToDriverNode
Moves a file or directory, possibly across FileSystems. For intra-FileSystem, it is implemented by hadoop fs rename operation. For inter-FileSystem, This is implemented as a copy followed by delete.	mssparkutils.fs.mv
Writes the given String out to a file, encoded in UTF-8.	mssparkutils.fs.put
Refresh workspace level mount points.	mssparkutils.fs.refreshMounts
Removes a file or directory.	mssparkutils.fs.rm
Removes a mount point.	mssparkutils.fs.unmount
Removes a mount point from driver node.	mssparkutils.fs.unmountFromDriverNode
Get help message for this module.	mssparkutils.help
Create a lakehouse	mssparkutils.lakehouse.create
Delete a lakehouse	mssparkutils.lakehouse.delete
Get a lakehouse	mssparkutils.lakehouse.get
The lakehouse module.	mssparkutils.lakehouse.help
List all lakehouses	mssparkutils.lakehouse.list
Update a lakehouse	mssparkutils.lakehouse.update
Gets the local path of the notebook resource.	mssparkutils.nbResPath
This method lets you exit a notebook with a value.	mssparkutils.notebook.exit
The notebook module.	mssparkutils.notebook.help
Runs a notebook and returns its exit value. The notebook will run in the current livy session context by default.	mssparkutils.notebook.run
Runs multiple notebooks concurrently with support for dependency relationships. Details can be found in mssparkutils.notebook.help("runMultiple").	mssparkutils.notebook.runMultiple
provide a way to make people can update the endpoint	mssparkutils.notebook.updateNBSEndpoint
Check if the DAG is correctly defined, if the syntax is correct, and if notebooks are found in the workspace without actual execution. Details can be found in mssparkutils.notebook.help("validateDAG").	mssparkutils.notebook.validateDAG
Get runtime properties	mssparkutils.runtime.context
Set runtime high concurrency mode repl id	mssparkutils.runtime.setHcReplId
Stop an interactive session	mssparkutils.session.stop
Get a config value	notebookutils.conf.get
Set a config key/value	notebookutils.conf.set
Get credential for a connection	notebookutils.connections.getCredential
Get help string for a method.	notebookutils.connections.getHelpString
Take linked service name as input and return connection string or credentials depending on the configuration of the linked service.	notebookutils.credentials.getConnectionStringOrCreds
Take linked service name as input and return full connection string with credentials.	notebookutils.credentials.getFullConnectionString
Return all the properties of a given linked service in string format.	notebookutils.credentials.getPropertiesAll
Return AKV secret.	notebookutils.credentials.getSecret
Return AKV secret using linkedService.	notebookutils.credentials.getSecretWithLS
Get AAD token for a resource.	notebookutils.credentials.getToken
Get help message.	notebookutils.credentials.help
Returns true if the input token is valid (i.e, hasn't expired).	notebookutils.credentials.isValidToken
Put AKV secret using with or without linkedService.	notebookutils.credentials.putSecret
Put AKV secret using linkedService.	notebookutils.credentials.putSecretWithLS
Get cluster id.	notebookutils.env.getClusterId
Get job Id.	notebookutils.env.getJobId
Get pool name.	notebookutils.env.getPoolName
Get user Id.	notebookutils.env.getUserId
Get user name.	notebookutils.env.getUserName
Get workspace name.	notebookutils.env.getWorkspaceName
Get help message.	notebookutils.env.help
Send a DELETE request to Fabric.	notebookutils.fabricClient.delete
Send a GET request to Fabric.	notebookutils.fabricClient.get
Get help string for a method.	notebookutils.fabricClient.help
List all capacities in the workspace.	notebookutils.fabricClient.listCapacities
Send a PATCH request to Fabric.	notebookutils.fabricClient.patch
Send a POST request to Fabric.	notebookutils.fabricClient.post
Send a PUT request to Fabric.	notebookutils.fabricClient.put
Append the given String to a file, encoded in UTF-8.	notebookutils.fs.append
Copies a file or directory, possibly across FileSystems.	notebookutils.fs.cp
Check if a file or directory exists.	notebookutils.fs.exists
Copies a file or directory via azcopy, possibly across FileSystems.	notebookutils.fs.fastcp
Gets the local path of the mount point.	notebookutils.fs.getMountPath
Returns up to the first 'maxBytes' bytes of the given file as a String encoded in UTF-8.	notebookutils.fs.head
notebookutils.fs provides utilities for working with various FileSystems.	notebookutils.fs.help
Lists the contents of a directory.	notebookutils.fs.ls
Creates the given directory if it does not exist, also creating any necessary parent * directories.	notebookutils.fs.mkdirs
Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)	notebookutils.fs.mount
Show information about what is mounted. Any credentials used to mount the mount points listed will not be displayed.	notebookutils.fs.mounts
Attach remote storage (Blob, Gen2, Azure File Share) to driver node	notebookutils.fs.mountToDriverNode
Moves a file or directory, possibly across FileSystems. For intra-FileSystem, it is implemented by hadoop fs rename operation. For inter-FileSystem, This is implemented as a copy followed by delete.	notebookutils.fs.mv
Writes the given String out to a file, encoded in UTF-8.	notebookutils.fs.put
Refresh workspace level mount points.	notebookutils.fs.refreshMounts
Removes a file or directory.	notebookutils.fs.rm
Removes a mount point.	notebookutils.fs.unmount
Removes a mount point from driver node.	notebookutils.fs.unmountFromDriverNode
Get help message for this module.	notebookutils.help
Initialize notebookutils, using in pre-run code	notebookutils.initialize
Create a lakehouse	notebookutils.lakehouse.create
Delete a lakehouse	notebookutils.lakehouse.delete
Get a lakehouse	notebookutils.lakehouse.get
Get the definition of a lakehouse	notebookutils.lakehouse.getDefinition
Get the info of a Lakehouse with properties.	notebookutils.lakehouse.getWithProperties
The lakehouse module.	notebookutils.lakehouse.help
List all lakehouses	notebookutils.lakehouse.list
List all tables in a Lakehouse.	notebookutils.lakehouse.listTables
Starts a load table operation.	notebookutils.lakehouse.loadTable
Update a lakehouse	notebookutils.lakehouse.update
Get the definition of a lakehouse	notebookutils.lakehouse.updateDefinition
Gets the local path of the notebook resource.	notebookutils.nbResPath
Create a notebook	notebookutils.notebook.create
Delete a notebook	notebookutils.notebook.delete
This method lets you exit a notebook with a value.	notebookutils.notebook.exit
Get a notebook	notebookutils.notebook.get
The notebook module.	notebookutils.notebook.help
List all notebooks	notebookutils.notebook.list
Runs a notebook and returns its exit value. The notebook will run in the current livy session context by default.	notebookutils.notebook.run
Update a notebook	notebookutils.notebook.update
Get the definition of a notebook	notebookutils.notebook.updateDefinition
provide a way to make people can update the endpoint	notebookutils.notebook.updateNBSEndpoint
Check if the DAG is correctly defined, if the syntax is correct, and if notebooks are found in the workspace without actual execution. Details can be found in mssparkutils.notebook.help("validateDAG").	notebookutils.notebook.validateDAG
Get runtime properties	notebookutils.runtime.context
notebookutils.runtime is a utility to manage runtime context. context() returns the runtime context as a list.	notebookutils.runtime.help
Set runtime high concurrency mode repl id	notebookutils.runtime.setHcReplId
Stop an interactive session	notebookutils.session.stop
Get UDF functions metadata.	notebookutils.udf.getFunctions
Get help string for a method.	notebookutils.udf.getHelpString
Get help string for a method.	notebookutils.udf.help
Run a User data functions (UDF).	notebookutils.udf.run
Get a variable value	notebookutils.variableLibrary.get
Get help string for a method.	notebookutils.variableLibrary.getHelpString
Get a variable library	notebookutils.variableLibrary.getLibrary

Package: notebookutils 1.6.2

notebookutils: Dummy R APIs Used in 'Azure Synapse Analytics' for Local Developments

Citation

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)