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 f7573f43a7
feat: sql migrator can do down migrations (#22806) 
* feat: sql down migrations

* refactor: different name for up migrations

* chore: update migrations ref in svc tests

* build: add lint step to verify sql migration names match
 		2021-11-01 14:30:18 -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
middleware_logging.go feat(notebooks): add logging and metrics to notebooks service (#22266) 2021-08-19 13:22:52 -06:00
middleware_metrics.go feat(notebooks): add logging and metrics to notebooks service (#22266) 2021-08-19 13:22:52 -06:00
service.go feat(notebooks): add logging and metrics to notebooks service (#22266) 2021-08-19 13:22:52 -06:00
service_test.go feat: sql migrator can do down migrations (#22806) 2021-11-01 14:30:18 -06: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.