Skip to content

Commit 62ea6f1

Browse files
note on examples
1 parent 36d1da1 commit 62ea6f1

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

developer-guide/20-User interface/04-adding-datasets.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,23 @@ display_name: A lovely name which shows up in the UI
1313
has_experiment: true # does your SQL table have an experiment column.?
1414
has_unit: true # does your SQL table have an pioreactor_unit column.?
1515
source: app
16-
table: the_target_table # see also query below
16+
table: the_target_table # optional: see note below
1717
timestamp_columns:
1818
- timestamp
1919
always_partition_by_unit: false
20-
query: SELECT * FROM the_target_table WHERE reading < 4 AND ... # optional: you can specify a query.
20+
query: SELECT * FROM the_target_table WHERE reading < 4 AND ... # optional: see note below
2121
```
2222
23+
:::note
24+
Either `table` or `query` is required. If you provide a `table`, the `query` field is ignored. The usecase for `query` is when you need to join multiple tables, use `WHERE` clauses, or do some other complex SQL operation.
25+
:::
26+
2327
After adding this file, visit the Export Page in the UI.
2428

29+
You can see more examples [here](
30+
:::
31+
32+
33+
After adding this file, visit the Export Page in the UI.
2534

26-
You can see more examples [here](https://github.com/Pioreactor/CustoPiZer/tree/pioreactor/workspace/scripts/files/pioreactor/exportable_datasets).
35+
You can see more examples [here](https://github.com/Pioreactor/CustoPiZer/tree/pioreactor/workspace/scripts/files/pioreactor/exportable_datasets) and [here](https://github.com/Pioreactor/spectrometer-reading-plugin/tree/main/spectrometer_reading_plugin/exportable_datasets)

0 commit comments

Comments
 (0)