trait NotebookUtils extends Serializable with WithHelpMethods
The notebook module.
- Alphabetic
- By Inheritance
- NotebookUtils
- WithHelpMethods
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def exit(value: String): Unit
This method lets you exit a notebook with a value.
This method lets you exit a notebook with a value.
- value
the value to return when exiting
- abstract def getContext(): CommandContext
- abstract def help(moduleOrMethod: String): Unit
- Definition Classes
- WithHelpMethods
- abstract def help(): Unit
- Definition Classes
- WithHelpMethods
- abstract def run(path: String, timeoutSeconds: Int, arguments: Map[String, String] = Map.empty, __databricksInternalClusterSpec: String = null): String
This method runs a notebook and returns its exit value.
This method runs a notebook and returns its exit value. The notebook will run in the current cluster by default.
- path
relative path to the notebook, e.g. ../path/to/notebook
- timeoutSeconds
timeout in seconds for the called notebook. If the run failed to finish within this time, this method will throw an exception. Note that currently, if the Databricks web application is down for more than 10 minutes, the run will fail regardless of this parameter.
- arguments
string map of arguments to pass to the notebook
- returns
the string returned by dbutils.notebook.exit() or null
- Exceptions thrown
WorkflowExceptionif the notebook run did not complete successfully
- abstract def setContext(ctx: CommandContext): Unit
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def apply(): NotebookUtils.this.type
- Definition Classes
- WithHelpMethods
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()