You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,10 @@
8
8
9
9
This implementation closely follows the original Julia library [FunSQL.jl](https://github.com/MechanicalRabbit/FunSQL.jl/). Thanks to the original authors, Clark Evans and Kyrylo Simonov, who have been refining the idea for some time; you should check their previous work [here](https://querycombinators.org/).
10
10
11
-
The original project does a very good job of motivating the library, there is little point repeating it. The python port retains a similar API, so after reading the original docs, you are good to go.
12
-
11
+
The original project does a very good job of motivating the library. The python port retains a similar API, so there is little point repeating it.
2. A [presentation](https://www.youtube.com/watch?v=rGWwmuvRUYk) from JuliaCon
15
14
16
-
17
15
Below are some notes about how to use the python library, and my understanding of how FunSQL works.
18
16
19
17
### Table of Contents
@@ -32,13 +30,13 @@ _When was the last time each person born between 1930 and 1940 and living in Ill
32
30
33
31
<details><summary>Database Schema</summary>
34
32
35
-

33
+

36
34
37
35
</details>
38
36
39
37
<details><summary>Pipeline Diagram</summary>
40
38
41
-

39
+

42
40
43
41
</details>
44
42
@@ -146,10 +144,14 @@ def get_stats(col):
146
144
## Usage
147
145
148
146
The `docs` directory has examples on how to use the library.
149
-
*`using-nodes.ipynb` - This is the user facing API, and shows how to use FunSQL to construct SQL queries.
147
+
148
+
*`usage-guide.ipynb` - Introduces the verbs available in FunSQL, and how to assmeble queries using them.
149
+
150
+
*`using-nodes.ipynb` - This is the user facing API, and adds more detail about each FunSQL node.
151
+
150
152
*`using-clauses.ipynb` - FunSQL compiles the tree of SQL nodes to something close to the lexical structure of SQL, called clause objects. These directly translate to SQL text, only abstracting over spaces and dialect specific punctuation. When projects like [Substrait](https://substrait.io/) are further along, might be a good idea to use that as a backend instead.
151
153
152
-
The [funsql-examples](https://github.com/ananis25/funsql-examples/) repository has more examples of queries written using FunSQL.
154
+
The [funsql-examples](https://github.com/ananis25/funsql-examples/) repository has more examples of queries/projects written using FunSQL.
0 commit comments