Documentation

Overview of notebooks

Learn how notebooks can help to streamline and simplify your day-to-day business processes.

See an overview of notebook concepts, notebook controls, and notebook cell types also know as the basic building blocks of a notebook.

Notebook concepts

You can think of an InfluxDB notebook as a collection of sequential data processing steps. Each step is represented by a “cell” that performs an action such as querying, visualizing, processing, or writing data to your buckets. Notebooks help you do the following:

  • Create snippets of live code, equations, visualizations, and explanatory notes.
  • Create alerts or scheduled tasks.
  • Downsample and normalize data.
  • Build runbooks to share with your teams.
  • Output data to buckets.

Notebook controls

The following options appear at the top of each notebook.

Run

Select Run (or press Control+Enter) to display results of each cell and write data to the selected bucket.

Save Notebook (appears before first save)

Select Save Notebook to save all notebook cells. Once you’ve saved the notebook, this button disappears and the notebook automatically saves as subsequent changes are made.

Saving the notebook does not save cell results. When you open a saved notebook, click Run to update cell results.

Local or UTC timezone

Click the timezone drop-down list to select a timezone to use for the notebook. Select either the local time (default) or UTC.

Time range

Select from the options in the dropdown list or select Custom Time Range to enter a custom time range with precision up to nanoseconds, and then click Apply Time Range.

Share notebook

To generate a URL for the notebook, click the icon. For more detail, see how to share a notebook.

Notebook cell types

The following cell types are available for your notebook:

Data source

At least one data source (input) cell is required in a notebook for other cells to run.

  • Query Builder: Build a query with the Flux query builder.

  • Flux Script: Enter a raw Flux script.

    Data source cells work like the Query Builder or Script Editor in Data Explorer. For more information, see how to query data with Flux and the Data Explorer.

Visualization

  • Table: View your data in a table.
  • Graph: View your data in a graph.
  • Note: Create explanatory notes or other information for yourself or your team members.

Action


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following:

InfluxDB Cloud powered by TSM