Notebooks
The following is an overview of the Notebooks Screen within the Dataset Management UI in Nexus.
🏗️ Public Preview Release 🚧
This documentation, as well as the Notebooks screen itself, is currently in public preview.
This page and its accompanying documentation will see updates as we continue to update our functionality. Check back soon!
Overview
Notebooks are an organizational tool for users to capture our interactions with a dataset. Using a Notebook you can run & save queries and transactions alongside accompanying markdown text, making it easy to document your own work and share it with others.
Create Notebook
You can create a new Notebook by expanding the Notebook icon on the left panel of your Dataset page, and seelcting the + icon, highlighted in yellow, to create a new notebook.
Rename Notebook
To rename your notebook, select the Save button highlighted in red below:
Type in the new name of your notebook. When you are finished, hit the Save button.
Adding Cells
Add a cell by selecting the blue Add Cell button (highlighted in red below):
Users will be prompted with three options for cell types: Markdown, SPARQL, and FlureeQL. The following is an overview of the specifics of each cell type. For a full list of options available in all cells, check out our section on Cell Icons below.
Markdown
Markdown cells allow users to use the Markdown markup langauge to format text, images, code snippetts, links and more. You can reference the markdown documentation for additional reference on utilizing markdown in Notebook cells.
Each Markdown cell contains a "done" button: and a "cancel" button: (both highlighted in blue below) which you can use to either save or discard changes to your cell.
FlureeQL
FlureeQL is a JSON-based query language for retrieving Fluree data. It is modeled as a JSON-representation of the W3C SPARQL standard. You can use FlureeQL cells to create ledgers, query, and transact data. For more information, check out our documentation on FlureeQL Query Syntax.
One of the NIFTIEST things about FlureeQL cells is that, based on the contents of your syntax, the Notebook can anticipate if you are attempting to query a ledger, highlighting the "play" icon:
Or attempting a transaction, highlighting the "bolt" icon:
And by clicking your respective button, the results will be shown in an additional Results cell, highlighted in green, below.
The mermaid icon: , which is highlighted in the image above, also appears as an option to visualize your query results.
SPARQL
Notebooks also give the option for SPARQL cells, currently we only support SPARL queries, thus you will notice the only option is for the "play" icon:
Cell Icons
The following icons appear in each cell and enable the following functionality:
Will automatically format your cells contents.
Copies contents of your cell into a clipboard.
Duplicates current cell.
Inserts new cell above.
Inserts new cell below.
Shifts cell up.
Shifts cell down.
Delete cell.