Learn R Programming

notebookutils (version 1.5.3)

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

Description

This is a pure dummy interfaces package which mirrors 'MsSparkUtils' APIs of 'Azure Synapse Analytics' for R users, customer of Azure Synapse can download this package from CRAN for local development.

Copy Link

Version

Install

install.packages('notebookutils')

Monthly Downloads

262

Version

1.5.3

License

MIT + file LICENSE

Maintainer

runtimeexp

Last Published

April 8th, 2024

Functions in notebookutils (1.5.3)

mssparkutils.fs.append

Append the given String to a file, encoded in UTF-8.

mssparkutils.fs.cp

Copies a file or directory, possibly across FileSystems.

mssparkutils.fs.unmount

Removes a mount point.

mssparkutils.fs.unmountFromDriverNode

Removes a mount point from driver node.

mssparkutils.fs.mount

Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)

mssparkutils.fs.mkdirs

Creates the given directory if it does not exist, also creating any necessary parent * directories.

mssparkutils.fs.refreshMounts

Refresh workspace level mount points.

mssparkutils.fs.rm

Removes a file or directory.

mssparkutils.fs.getMountPath

Gets the local path of the mount point.

mssparkutils.credentials.isValidToken

Returns true if the input token is valid (i.e, hasn't expired).

mssparkutils.notebook.runMultiple

Runs multiple notebooks concurrently with support for dependency relationships. Details can be found in mssparkutils.notebook.help("runMultiple").

mssparkutils.credentials.putSecret

Put AKV secret using with or without linkedService.

mssparkutils.fs.head

Returns up to the first 'maxBytes' bytes of the given file as a String encoded in UTF-8.

mssparkutils.lakehouse.delete

Delete a lakehouse

mssparkutils.lakehouse.get

Get a lakehouse

mssparkutils.env.getUserId

mssparkutils.session.stop

Stop an interactive session

mssparkutils.notebook.updateNBSEndpoint

provide a way to make people can update the endpoint

notebookutils.credentials.getConnectionStringOrCreds

Take linked service name as input and return connection string or credentials depending on the configuration of the linked service.

notebookutils.env.help

Get help message.

notebookutils.env.getWorkspaceName

Get workspace name.

mssparkutils.env.getUserName

mssparkutils.notebook.help

The notebook module.

notebookutils.credentials.isValidToken

Returns true if the input token is valid (i.e, hasn't expired).

mssparkutils.notebook.run

Runs a notebook and returns its exit value. The notebook will run in the current livy session context by default.

mssparkutils.fs.exists

Check if a file or directory exists.

mssparkutils.fs.fastcp

Copies a file or directory via azcopy, possibly across FileSystems.

mssparkutils.notebook.exit

This method lets you exit a notebook with a value.

mssparkutils.fs.put

Writes the given String out to a file, encoded in UTF-8.

notebookutils.credentials.getPropertiesAll

Return all the properties of a given linked service in string format.

mssparkutils.fs.mv

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.fabricClient.listCapacities

List all capacities in the workspace.

mssparkutils.env.getWorkspaceName

Get workspace name.

notebookutils.env.getUserName

notebookutils.env.getUserId

notebookutils.fs.exists

Check if a file or directory exists.

notebookutils.credentials.getFullConnectionString

Take linked service name as input and return full connection string with credentials.

notebookutils.fabricClient.help

Get help string for a method.

mssparkutils.fs.mounts

Show information about what is mounted. Any credentials used to mount the mount points listed will not be displayed.

mssparkutils.fs.help

mssparkutils.fs provides utilities for working with various FileSystems.

mssparkutils.fs.mountToDriverNode

Attach remote storage (Blob, Gen2, Azure File Share) to driver node

mssparkutils.env.help

Get help message.

mssparkutils.lakehouse.help

The lakehouse module.

mssparkutils.fs.ls

Lists the contents of a directory.

mssparkutils.lakehouse.list

List all lakehouses

notebookutils.fs.fastcp

Copies a file or directory via azcopy, possibly across FileSystems.

notebookutils.fs.cp

Copies a file or directory, possibly across FileSystems.

notebookutils.fs.rm

Removes a file or directory.

notebookutils.fs.getMountPath

Gets the local path of the mount point.

notebookutils.fs.unmount

Removes a mount point.

notebookutils.env.getClusterId

Get cluster id.

notebookutils.fabricClient.put

Send a PUT request to Fabric.

notebookutils.credentials.putSecretWithLS

Put AKV secret using linkedService.

notebookutils.fs.append

Append the given String to a file, encoded in UTF-8.

mssparkutils.help

Get help message for this module.

notebookutils.lakehouse.update

Update a lakehouse

notebookutils.lakehouse.loadTable

Starts a load table operation.

mssparkutils.runtime.context

Get runtime properties

notebookutils.fs.help

notebookutils.fs provides utilities for working with various FileSystems.

notebookutils.warehouse.create

Create a warehouse

notebookutils.fs.head

Returns up to the first 'maxBytes' bytes of the given file as a String encoded in UTF-8.

notebookutils.credentials.getToken

Get AAD token for a resource.

notebookutils.fs.mkdirs

Creates the given directory if it does not exist, also creating any necessary parent * directories.

mssparkutils.lakehouse.update

Update a lakehouse

mssparkutils.runtime.setHcReplId

Set runtime high concurrency mode repl id

notebookutils.fabricClient.patch

Send a PATCH request to Fabric.

notebookutils.fabricClient.post

Send a POST request to Fabric.

notebookutils.fs.ls

Lists the contents of a directory.

mssparkutils.lakehouse.create

Create a lakehouse

notebookutils.notebook.update

Update a notebook

notebookutils.workspace.unassignFromCapacity

Unassign a workspace from a capacity

notebookutils.notebook.exit

This method lets you exit a notebook with a value.

notebookutils.notebook.delete

Delete a notebook

notebookutils.session.stop

Stop an interactive session

notebookutils.notebook.updateDefinition

Get the definition of a notebook

notebookutils.fs.mounts

Show information about what is mounted. Any credentials used to mount the mount points listed will not be displayed.

notebookutils.fs.mv

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.notebook.list

List all notebooks

notebookutils.fs.unmountFromDriverNode

Removes a mount point from driver node.

notebookutils.workspace.update

Update a workspace

notebookutils.runtime.setHcReplId

Set runtime high concurrency mode repl id

notebookutils.credentials.getSecret

Return AKV secret.

notebookutils.credentials.getSecretWithLS

Return AKV secret using linkedService.

notebookutils.fs.put

Writes the given String out to a file, encoded in UTF-8.

notebookutils.fs.refreshMounts

Refresh workspace level mount points.

notebookutils.lakehouse.list

List all lakehouses

notebookutils.workspace.get

Get a workspace

notebookutils.notebook.help

The notebook module.

notebookutils.help

Get help message for this module.

notebookutils.notebook.get

notebookutils.workspace.help

The workspace module.

notebookutils.env.getPoolName

notebookutils.env.getJobId

notebookutils.fabricClient.get

Send a GET request to Fabric.

notebookutils.fabricClient.delete

Send a DELETE request to Fabric.

notebookutils.workspace.list

List all workspaces

notebookutils.warehouse.getDefinition

Get the definition of a warehouse

notebookutils.notebook.run

Runs a notebook and returns its exit value. The notebook will run in the current livy session context by default.

notebookutils.warehouse.help

The warehouse module.

notebookutils.lakehouse.help

The lakehouse module.

notebookutils.lakehouse.get

Get a lakehouse

notebookutils.warehouse.get

Get a warehouse

notebookutils.lakehouse.getWithProperties

Get the info of a Lakehouse with properties.

notebookutils.lakehouse.getDefinition

Get the definition of a lakehouse

notebookutils.credentials.putSecret

Put AKV secret using with or without linkedService.

notebookutils.credentials.help

Get help message.

notebookutils.runtime.help

notebookutils.runtime is a utility to manage runtime context. context() returns the runtime context as a list.

notebookutils.workspace.listArtifacts

List the specified artifacts in the workspace

notebookutils.warehouse.delete

Delete a warehouse

notebookutils.fs.mount

Attach remote storage (Blob, Gen2, Azure File Share) to all working nodes (driver node and worker nodes)

notebookutils.lakehouse.create

Create a lakehouse

notebookutils.fs.mountToDriverNode

Attach remote storage (Blob, Gen2, Azure File Share) to driver node

notebookutils.lakehouse.delete

Delete a lakehouse

notebookutils.lakehouse.updateDefinition

Get the definition of a lakehouse

notebookutils.workspace.create

Create a workspace

notebookutils.warehouse.list

List all warehouses

notebookutils.workspace.delete

Delete a workspace

notebookutils.runtime.context

Get runtime properties

notebookutils.notebook.updateNBSEndpoint

provide a way to make people can update the endpoint

notebookutils.warehouse.update

Update a warehouse

notebookutils.lakehouse.listTables

List all tables in a Lakehouse.

notebookutils.warehouse.updateDefinition

Get the definition of a warehouse

notebookutils.notebook.create

Create a notebook

notebookutils.workspace.assignToCapacity

Assign a workspace to a capacity

mssparkutils.credentials.getConnectionStringOrCreds

Take linked service name as input and return connection string or credentials depending on the configuration of the linked service.

Set the dataframe info which needs to be visualized.

Set the chart config metadata for current dataframe (set by display) which needs to be visualized.

mssparkutils.credentials.help

Get help message.

mssparkutils.credentials.getToken

Get AAD token for a resource.

mssparkutils.credentials.getSecret

Return AKV secret.

Construct an specific html fragment to synapse notebook front-end for rendering based on user-input html content.

mssparkutils.credentials.getPropertiesAll

Return all the properties of a given linked service in string format.

mssparkutils.credentials.getFullConnectionString

Take linked service name as input and return full connection string with credentials.

mssparkutils.credentials.getSecretWithLS

Return AKV secret using linkedService.

mssparkutils.credentials.putSecretWithLS

Put AKV secret using linkedService.

mssparkutils.env.getClusterId

Get cluster id.

mssparkutils.env.getJobId

mssparkutils.env.getPoolName