Trait/Object

polynote.server.repository

NotebookRepository

Related Docs: object NotebookRepository | package repository

Permalink

trait NotebookRepository extends AnyRef

A Notebook Repository operates on notebooks stored by path. The path of a notebook should be a forward-slash separated path with no leading slash. Such paths must be passed wherever paths are expected and returned wherever paths are returned (including in a Notebook's path field).

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NotebookRepository
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copyNotebook(path: String, newPath: String): RIO[BaseEnv with GlobalEnv, String]

    Permalink
  2. abstract def createAndOpen(path: String, notebook: Notebook, version: Int = 0): RIO[BaseEnv with GlobalEnv, NotebookRef]

    Permalink
  3. abstract def createNotebook(path: String, maybeContent: Option[String]): RIO[BaseEnv with GlobalEnv, String]

    Permalink

    Create a notebook at the given path, optionally creating it from the given content string.

    Create a notebook at the given path, optionally creating it from the given content string.

    TODO: Server no longer imports. Need to implement this on the client side.

  4. abstract def deleteNotebook(path: String): RIO[BaseEnv with GlobalEnv, Unit]

    Permalink
  5. abstract def initStorage(): RIO[BaseEnv with GlobalEnv, Unit]

    Permalink

    Initialize the storage for this repository (i.e.

    Initialize the storage for this repository (i.e. create directory if it doesn't exist)

  6. abstract def listNotebooks(): RIO[BaseEnv with GlobalEnv, List[String]]

    Permalink

    returns

    A list of notebook paths that exist in this repository

  7. abstract def loadNotebook(path: String): RIO[BaseEnv with GlobalEnv, Notebook]

    Permalink

    returns

    The notebook at the specified path

  8. abstract def notebookExists(path: String): RIO[BaseEnv with GlobalEnv, Boolean]

    Permalink

    returns

    Whether a notebook exists at the specified path

  9. abstract def notebookURI(path: String): RIO[BaseEnv with GlobalEnv, Option[URI]]

    Permalink

    returns

    The location of the notebook (must be absolute)

  10. abstract def openNotebook(path: String): RIO[BaseEnv with GlobalEnv, NotebookRef]

    Permalink
  11. abstract def renameNotebook(path: String, newPath: String): RIO[BaseEnv with GlobalEnv, String]

    Permalink
  12. abstract def saveNotebook(nb: Notebook): RIO[BaseEnv with GlobalEnv, Unit]

    Permalink

    Save the given notebook to the specified path

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped