`weaver fabric notebook`¶

`weaver fabric notebook push`¶

Synopsis¶

weaver fabric notebook push [-h] [--name NAME] [--description DESCRIPTION] [--json] [--non-interactive] [--workspace WORKSPACE] [--workspace-config WORKSPACE_CONFIG] [--environment ENVIRONMENT] source

Positional arguments¶

source: Local .py or .ipynb notebook source.

Options¶

-h, --help: show this help message and exit
--name NAME: Fabric display name. Defaults to the filename.
--description DESCRIPTION: No description is provided by the parser.
--json: No description is provided by the parser.
--non-interactive: Do not read stdin, wait for a keypress or open browser sign-in. Missing authorisation or required input is an error.
--workspace WORKSPACE: Fabric Workspace name.
--workspace-config WORKSPACE_CONFIG: Workspace configuration file.
--environment ENVIRONMENT: Fabric Environment name or Workspace/Environment reference.

`weaver fabric notebook run`¶

Synopsis¶

weaver fabric notebook run [-h] [--lakehouse LAKEHOUSE] [--no-wait] [--timeout TIMEOUT] [--poll-interval POLL_INTERVAL] [--json] [--non-interactive] [--workspace WORKSPACE] [--workspace-config WORKSPACE_CONFIG] [--environment ENVIRONMENT] [--catalogue CATALOGUE] name

Positional arguments¶

name: Fabric Notebook display name.

Options¶

-h, --help: show this help message and exit
--lakehouse LAKEHOUSE: Default Lakehouse for the notebook session.
--no-wait: No description is provided by the parser.
--timeout TIMEOUT: No description is provided by the parser.
--poll-interval POLL_INTERVAL: No description is provided by the parser.
--json: No description is provided by the parser.
--non-interactive: Do not read stdin, wait for a keypress or open browser sign-in. Missing authorisation or required input is an error.
--workspace WORKSPACE: Fabric Workspace name.
--workspace-config WORKSPACE_CONFIG: Workspace configuration file.
--environment ENVIRONMENT: Fabric Environment name or Workspace/Environment reference.
--catalogue CATALOGUE: Where the Weaver catalogue lives, for example Warehouse/Weaver.

Responsibility and selection¶

fabric notebook push selects a local .py or .ipynb file and a Fabric workspace. A .py input is a Fabric notebook-source export, not an arbitrary Python script. --name overrides the filename stem used as the Fabric display name.

fabric notebook run selects a deployed notebook by display name. It requires a default Lakehouse and a Fabric Environment. --lakehouse supplies the physical Lakehouse name; when omitted, exactly one configured Lakehouse is selected automatically. The Environment comes from --environment or workspace configuration and may be qualified as Workspace/Environment.

Execution¶

Push¶

If the named notebook does not exist, push creates it and applies --description when supplied. If it exists, push replaces its notebook definition; it does not update the existing description. Only the .py or .ipynb definition is transported, not local notebook Resources.

Run¶

run starts a Spark notebook job with the selected Lakehouse as its default and the selected Environment attached. By default it polls until Fabric reports a terminal result. --timeout sets the maximum wait in seconds, and --poll-interval sets the polling interval in seconds.

--no-wait returns after Fabric accepts the job. It does not report the eventual notebook result.

Interaction¶

Neither command asks for destructive confirmation or accepts --yes. --non-interactive prevents browser sign-in; configured unattended credentials must then be sufficient.

Output and exit behaviour¶

By default, push reports whether it created or updated the notebook, plus the notebook ID and local source path. run reports the status and job URL, and includes the notebook exit value when Fabric returns one.

--json writes one result document to stdout. Treat it as command output, not as a versioned schema guarantee.

push exits 0 after Fabric creates or updates the definition. run exits 0 after a successful waited result or after job acceptance with --no-wait. A failed or cancelled waited job, missing item, invalid source, missing Lakehouse or Environment, timeout, authentication error or Fabric error produces a non-zero status.

Examples¶

Create or update a notebook definition:

weaver fabric notebook push notebooks/ParcelRefresh.py \
  --name ParcelRefresh \
  --workspace "Parcel Development"

Run it and wait for completion:

weaver fabric notebook run ParcelRefresh \
  --workspace-config workspace-development.yml \
  --lakehouse ParcelLanding_Dev \
  --timeout 3600 \
  --poll-interval 15

Push and run a Fabric notebook¶

Use the notebook commands to deploy a local .py or .ipynb definition and start it as a Fabric Spark job. The run receives an explicit default Lakehouse and Fabric Environment.

This route manages the Notebook item itself. It does not Build Weaver documents, publish an Environment or move a local notebook's Resources.

Prerequisites¶

A Fabric workspace containing the default Lakehouse.
A published Fabric Environment available to the workspace running the notebook.
A local Fabric notebook-source .py export or an .ipynb notebook definition.
Credentials that can create or update Notebook items and start notebook jobs.

Bind the workspace, Lakehouse and Environment in a workspace configuration:

workspace: Parcel Operations
catalogue: Warehouse/ParcelCatalogueDev
environment: ParcelRuntime

targets:
  Lakehouse/Landing: ParcelLandingDev

The catalogue is not used as the notebook's default Lakehouse. fabric notebook run uses --lakehouse when supplied; otherwise it selects the one configured Lakehouse only when the configuration contains exactly one.

If ParcelRuntime does not yet exist or its definition changed, publish it before the notebook run. Configure workspaces and Fabric Environments covers that boundary.

Push the notebook definition¶

A Fabric notebook-source .py file starts with the # Fabric notebook source prologue. # CELL and # MARKDOWN markers divide cells, while each # METADATA section contains JSON represented by # META lines. A normal .py module without that structure is not a Fabric notebook definition.

This is the complete checked fixture at examples/parcel-notebook/notebooks/ParcelRefresh.py:

# Fabric notebook source

# METADATA ********************

# META {
# META   "kernel_info": {
# META     "name": "synapse_pyspark"
# META   }
# META }

# MARKDOWN ********************

# # Parcel refresh
#
# This cell is deliberately small so the deployed definition can be smoke-tested.

# CELL ********************

print("Parcel refresh notebook started")

# METADATA ********************

# META {
# META   "language": "python",
# META   "language_group": "synapse_pyspark"
# META }

Use a .py definition exported by Fabric or copied from Fabric Git when the notebook already exists. Keep .ipynb when that is the source format you maintain; push accepts it directly and does not require conversion to .py.

Deploy the checked Fabric notebook source:

weaver fabric notebook push examples/parcel-notebook/notebooks/ParcelRefresh.py \
  --name ParcelRefresh \
  --description "Refresh parcel landing data" \
  --workspace-config workspace-development.yml

The filename stem becomes the Fabric display name when --name is omitted. If that name does not exist, Weaver creates the Notebook and applies the optional description. If it exists, Weaver replaces the notebook definition; it does not update that item's existing description.

Push transports only the .py or .ipynb notebook definition. It does not turn an ordinary Python file into a notebook, and local Notebook Resources are not included. If a Weaver project lives in the notebook's built-in Resources, move that project separately with Fabric Git and enable Resources-folder support there. Portable execution between desktop and Fabric covers that project transport. Put required Python packages in the attached Environment and make other inputs available through Fabric items or services the notebook can access.

The command reports whether it created or updated the item, its Fabric ID and the local source path. Treat a successful push as deployment evidence, not execution evidence.

Run and wait for the result¶

Start the deployed notebook with an explicit Lakehouse when the configuration could be ambiguous:

weaver fabric notebook run ParcelRefresh \
  --workspace-config workspace-development.yml \
  --lakehouse ParcelLandingDev \
  --timeout 3600 \
  --poll-interval 15

Weaver resolves the Notebook and default Lakehouse in Parcel Operations, resolves ParcelRuntime, submits a Spark notebook job and polls until Fabric reports a terminal result. A successful waited run prints the terminal status and job URL, plus the notebook exit value when Fabric returns one.

--timeout limits how long the CLI waits; it does not set a notebook runtime limit or cancel the remote job. If waiting times out, use the reported Fabric context to inspect the job before starting another run.

A failed or cancelled terminal result makes the command fail and includes the provider's reported reason when one is available. Correct the notebook, Lakehouse, Environment, permissions or capacity condition named by that result, push a changed definition when necessary, and start a new run.

Submit without waiting¶

For an external scheduler that tracks the Fabric job URL, submit and return after Fabric accepts it:

weaver fabric notebook run ParcelRefresh \
  --workspace-config workspace-development.yml \
  --lakehouse ParcelLandingDev \
  --no-wait \
  --non-interactive \
  --json

--no-wait reports acceptance, not completion. The command can exit successfully while the remote job later fails or is cancelled. Persist the returned job URL and add a separate completion check in the scheduler; do not treat process exit alone as the notebook outcome.

--non-interactive prevents browser sign-in. It does not supply credentials, change the Lakehouse or publish the Environment. Configure an unattended credential path before using the command from a scheduler.

Use an Environment from another workspace¶

An Environment binding can be qualified as Workspace/Environment:

environment: Shared Runtimes/ParcelRuntime

The notebook and its default Lakehouse still run in the workspace selected for the command. Fabric must allow the consumer workspace to attach the qualified Environment, and the caller needs access to both workspaces. Qualifying the Environment does not make the Notebook or Lakehouse cross-workspace.

See weaver fabric notebook for complete options and output behaviour. See Session and runtime behaviour for attached-workspace and cross-workspace execution rules.

weaver fabric notebook¶

weaver fabric notebook¶

weaver fabric notebook push¶

Synopsis¶

Positional arguments¶

Options¶

weaver fabric notebook run¶

Synopsis¶

Positional arguments¶

Options¶

Responsibility and selection¶

Execution¶

Push¶

Run¶

Interaction¶

Output and exit behaviour¶

Examples¶

Push and run a Fabric notebook¶

Prerequisites¶

Push the notebook definition¶

Run and wait for the result¶

Submit without waiting¶

Use an Environment from another workspace¶

`weaver fabric notebook`¶

`weaver fabric notebook`¶

`weaver fabric notebook push`¶

`weaver fabric notebook run`¶