Skip to content

Commit 91aebb2

Browse files
committed
document the debug component
1 parent 7f2e1f8 commit 91aebb2

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

examples/official-site/documentation.sql

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ SELECT my_column_1 AS row_level_parameter_1, my_column_2 AS row_level_parameter_
3030
3131
This page documents all the components provided by default in SQLPage and their parameters.
3232
Use this as a reference when building your SQL application.
33+
If at any point you need help, you can ask for it on the [SQLPage forum](https://github.com/lovasoa/SQLpage/discussions).
3334
3435
If you have some frontend development experience, you can also create your own components, by placing
3536
[`.handlebars`](https://handlebarsjs.com/guide/) files in a folder called `sqlpage/templates` at the root of your server.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
-- Insert the http_header component into the component table
2+
INSERT INTO component (name, description, icon)
3+
VALUES (
4+
'debug',
5+
'Display all of the row-level parameters passed to the component. Useful for debugging: just replace the name of the component you want to debug with ''debug''.',
6+
'bug'
7+
);
8+
-- Insert an example usage of the http_header component into the example table
9+
INSERT INTO example (component, description, properties)
10+
VALUES (
11+
'debug',
12+
'At any time, if you are confused about what data you are passing to a component, just replace the component name with ''debug'' to see all the parameters that are passed to it.',
13+
JSON('[{"component": "debug"}, {"x": "y", "z": 42}, {"a": "b", "c": null}]')
14+
);

0 commit comments

Comments
 (0)