@graphenedata/cli 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli.ts +0 -5
- package/dist/cli/cli.js +1863 -21
- package/dist/docs/graphene.md +9 -9
- package/package.json +1 -1
package/dist/docs/graphene.md
CHANGED
|
@@ -39,7 +39,7 @@ table users (
|
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
Syntax notes
|
|
42
|
-
- `table foo (...)` defines a Graphene table based on the database table `foo`.
|
|
42
|
+
- `table foo (...)` defines a Graphene table based on the database table `foo`.
|
|
43
43
|
- The allowed join types are `join_one` and `join_many`. All joins are left outer joins. There is no inner, right, or cross join.
|
|
44
44
|
- `join_one` is used if there are many rows in the **left** table for each row in the **right** table.
|
|
45
45
|
- `join_many` is used if there are many rows in the **right** table for each row in the **left** table.
|
|
@@ -67,7 +67,7 @@ limit 10
|
|
|
67
67
|
select
|
|
68
68
|
month(date),
|
|
69
69
|
average(users.age), -- in normal SQL this would fan-out in the join; in Graphene it smartly de-duplicates the fan-out when computing aggregates
|
|
70
|
-
from orders
|
|
70
|
+
from orders
|
|
71
71
|
```
|
|
72
72
|
|
|
73
73
|
Syntax notes
|
|
@@ -112,11 +112,11 @@ The following components are available:
|
|
|
112
112
|
|
|
113
113
|
## Using the Graphene CLI
|
|
114
114
|
These are the available commands:
|
|
115
|
-
- `npm run
|
|
116
|
-
- `npm run
|
|
117
|
-
- `npm run
|
|
118
|
-
- `npm run
|
|
119
|
-
- `npm run
|
|
115
|
+
- `npm run graphene check` - Checks the syntax for the entire Graphene project.
|
|
116
|
+
- `npm run graphene compile "<GSQL>"` - Shows how GSQL is translated into the underlying database SQL.
|
|
117
|
+
- `npm run graphene run "<GSQL>"` - Runs a GSQL query. The tables and semantics defined in all .gsql files in the project are available for the query to use.
|
|
118
|
+
- `npm run graphene serve` - Starts (or restarts) the dev server, which allows the user to view their Graphene app on localhost.
|
|
119
|
+
- `npm run graphene view <mdPath>` - Captures a screenshot of a given .md file, along with any errors encountered.
|
|
120
120
|
|
|
121
121
|
## AGENT INSTRUCTIONS
|
|
122
122
|
Follow these guidelines when working in a Graphene project.
|
|
@@ -125,5 +125,5 @@ Follow these guidelines when working in a Graphene project.
|
|
|
125
125
|
- Because all joins in Graphene are left outer joins, be mindful about your `from` table selection.
|
|
126
126
|
- When adding a component to a .md file, read the associated documentation page first in /docs/data_apps/components so you understand all the available configurations.
|
|
127
127
|
- Do not try to search the web for Graphene-specific info; you will not find anything. All the documentation is in /docs.
|
|
128
|
-
- If you write to a .gsql file, run a syntax check with `npm run
|
|
129
|
-
- If you write to a .md file, run a syntax check with `npm run
|
|
128
|
+
- If you write to a .gsql file, run a syntax check with `npm run graphene check`.
|
|
129
|
+
- If you write to a .md file, run a syntax check with `npm run graphene check`. Once there are no syntax errors, do a visual check by running `npm run graphene view <mdPath>` and looking at the .png it generates.
|