Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
influxdb/notebooks
History
William Baker 11e5ce0dd3
feat: enable notebooks and annotations (#21972) 
* feat: remove notebooks feature flags

* feat: turn on annotations feature flag

* chore: removed unused UI feature flags

* docs: add line to CHANGELOG about notebooks and annotations

* chore: update CHANGELOG
 		2021-07-29 16:32:12 -06:00
..
transport feat: enable notebooks and annotations (#21972) 2021-07-29 16:32:12 -06:00
README.md docs: README for annotations, notebooks, and sqlite (#21832) 2021-07-12 12:18:12 -05:00
service.go fix: empty notebooks list returns empty array (#21588) 2021-06-02 14:33:37 -04:00
service_test.go feat: use go embed for sqlite migrations (#21653) 2021-06-10 18:40:57 -04:00

README.md

Notebooks

This package provides an HTTP API for interacting with InfluxDB notebooks. The HTTP handlers are located in the transport folder. The code for interacting with the sqlite datastore is located in the service.go file. Definitions for the basic types & interfaces associated with notebooks used throughout the platform are located in the top-level influxdb package, in the notebook.go file.

Anatomy

The backend representation of a notebook is very simple: An object with an ID, Name, associated organization ID, created/modified times, and a "spec". The "spec" is a mechanism for storing a JSON string defined entirely by the frontend UI. The notebook spec will likely be further defined in the future as the notebooks feature is developed and more sophisticated backend behaviors are required.

Use

Basic CRUD actions are available for interacting with notebooks through the API. Notebooks are persisted in the relational sqlite database, although they currently do not make use of any relational features. Again, it is likely that the more advanced features of the datastore will be utilized in the future as the notebooks feature evolves.