Up
This commit is contained in:
Hassan Abedi
parent
8ddfce6d38
commit
8eb7c6f49f
@ -16,6 +16,12 @@ The operators are: atom scan, semijoin, and natural join.
|
||||
| `Relation` | struct | Holds rows over named columns and is the type produced by every operator. Construct it with `Relation::new(columns)` or `Relation::from_rows(columns, rows)`. Column names within a single relation must be unique. |
|
||||
| `Value` | enum | Represents a single cell value stored in a `Table` or `Relation`. A value is either `Int(i64)` or `Str(String)`. |
|
||||
|
||||
<div align="center">
|
||||
<picture>
|
||||
<img alt="Types" src="docs/diagrams/types.svg" height="70%" width="70%">
|
||||
</picture>
|
||||
</div>
|
||||
|
||||
### Example
|
||||
|
||||
The rule below returns the authors of every bestseller along with the book's price.
|
||||
@ -96,6 +102,12 @@ fn main() {
|
||||
}
|
||||
```
|
||||
|
||||
<div align="center">
|
||||
<picture>
|
||||
<img alt="Types" src="docs/diagrams/architecture.svg" height="70%" width="70%">
|
||||
</picture>
|
||||
</div>
|
||||
|
||||
### Test
|
||||
|
||||
```sh
|
||||
|
||||
60
crates/query-ops/docs/diagrams/types.dot
Normal file
60
crates/query-ops/docs/diagrams/types.dot
Normal file
@ -0,0 +1,60 @@
|
||||
digraph QueryOpsTypes {
|
||||
fontname = "Helvetica,Arial,sans-serif"
|
||||
layout = dot
|
||||
rankdir = TB
|
||||
ranksep = 0.7;
|
||||
nodesep = 0.7;
|
||||
splines = true;
|
||||
bgcolor = "white"
|
||||
|
||||
node [
|
||||
fontname = "Helvetica,Arial,sans-serif",
|
||||
shape = box,
|
||||
style = "filled,rounded",
|
||||
color = "#555555",
|
||||
fillcolor = "white",
|
||||
penwidth = 1.5
|
||||
]
|
||||
edge [
|
||||
fontname = "Helvetica,Arial,sans-serif",
|
||||
color = "#333333",
|
||||
fontsize = 9,
|
||||
fontcolor = "#555555",
|
||||
penwidth = 1.2
|
||||
]
|
||||
|
||||
table_node [label = <<table border="0" cellborder="0" cellspacing="0" cellpadding="4">
|
||||
<tr><td align="center"><b>Table</b> (struct)</td></tr>
|
||||
<tr><td align="left" balign="left">arity: usize</td></tr>
|
||||
<tr><td align="left" balign="left">rows: Vec<Vec<Value>></td></tr>
|
||||
</table>>, fillcolor = "#E8F4FD", color = "#2196F3"]
|
||||
|
||||
relation_node [label = <<table border="0" cellborder="0" cellspacing="0" cellpadding="4">
|
||||
<tr><td align="center"><b>Relation</b> (struct)</td></tr>
|
||||
<tr><td align="left" balign="left">columns: Vec<String></td></tr>
|
||||
<tr><td align="left" balign="left">rows: Vec<Vec<Value>></td></tr>
|
||||
</table>>, fillcolor = "#ECEFF1", color = "#607D8B"]
|
||||
|
||||
atom_pattern_node [label = <<table border="0" cellborder="0" cellspacing="0" cellpadding="4">
|
||||
<tr><td align="center"><b>AtomPattern</b> (struct)</td></tr>
|
||||
<tr><td align="left" balign="left">columns: Vec<Term></td></tr>
|
||||
</table>>, fillcolor = "#F3E5F5", color = "#9C27B0"]
|
||||
|
||||
term_node [label = <<table border="0" cellborder="0" cellspacing="0" cellpadding="4">
|
||||
<tr><td align="center"><b>Term</b> (enum)</td></tr>
|
||||
<tr><td align="left" balign="left">Var(String)</td></tr>
|
||||
<tr><td align="left" balign="left">Lit(Value)</td></tr>
|
||||
</table>>, fillcolor = "#F3E5F5", color = "#9C27B0"]
|
||||
|
||||
value_node [label = <<table border="0" cellborder="0" cellspacing="0" cellpadding="4">
|
||||
<tr><td align="center"><b>Value</b> (enum)</td></tr>
|
||||
<tr><td align="left" balign="left">Int(i64)</td></tr>
|
||||
<tr><td align="left" balign="left">Str(String)</td></tr>
|
||||
</table>>, fillcolor = "#FFF3E0", color = "#FF9800"]
|
||||
|
||||
// composition edges: arrow X -> Y reads "X contains Y"
|
||||
atom_pattern_node -> term_node [label = "Vec<Term>"]
|
||||
term_node -> value_node [label = "Lit(Value)"]
|
||||
table_node -> value_node [label = "Vec<Vec<Value>>"]
|
||||
relation_node -> value_node [label = "Vec<Vec<Value>>"]
|
||||
}
|
||||
85
crates/query-ops/docs/diagrams/types.svg
Normal file
85
crates/query-ops/docs/diagrams/types.svg
Normal file
@ -0,0 +1,85 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
|
||||
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<!-- Generated by graphviz version 12.2.1 (0)
|
||||
-->
|
||||
<!-- Title: QueryOpsTypes Pages: 1 -->
|
||||
<svg width="584pt" height="391pt"
|
||||
viewBox="0.00 0.00 583.50 391.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 387)">
|
||||
<title>QueryOpsTypes</title>
|
||||
<polygon fill="white" stroke="none" points="-4,4 -4,-387 579.5,-387 579.5,4 -4,4"/>
|
||||
<!-- table_node -->
|
||||
<g id="node1" class="node">
|
||||
<title>table_node</title>
|
||||
<path fill="#e8f4fd" stroke="#2196f3" stroke-width="1.5" d="M159.75,-253.5C159.75,-253.5 12,-253.5 12,-253.5 6,-253.5 0,-247.5 0,-241.5 0,-241.5 0,-170.5 0,-170.5 0,-164.5 6,-158.5 12,-158.5 12,-158.5 159.75,-158.5 159.75,-158.5 165.75,-158.5 171.75,-164.5 171.75,-170.5 171.75,-170.5 171.75,-241.5 171.75,-241.5 171.75,-247.5 165.75,-253.5 159.75,-253.5"/>
|
||||
<text text-anchor="start" x="43.88" y="-233.2" font-family="Helvetica,Arial,sans-serif" font-weight="bold" font-size="14.00">Table</text>
|
||||
<text text-anchor="start" x="78.38" y="-233.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">  (struct)</text>
|
||||
<text text-anchor="start" x="12" y="-203.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">arity: usize</text>
|
||||
<text text-anchor="start" x="12" y="-174.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">rows: Vec<Vec<Value>></text>
|
||||
</g>
|
||||
<!-- value_node -->
|
||||
<g id="node5" class="node">
|
||||
<title>value_node</title>
|
||||
<path fill="#fff3e0" stroke="#ff9800" stroke-width="1.5" d="M351.38,-95C351.38,-95 264.38,-95 264.38,-95 258.38,-95 252.38,-89 252.38,-83 252.38,-83 252.38,-12 252.38,-12 252.38,-6 258.38,0 264.38,0 264.38,0 351.38,0 351.38,0 357.38,0 363.38,-6 363.38,-12 363.38,-12 363.38,-83 363.38,-83 363.38,-89 357.38,-95 351.38,-95"/>
|
||||
<text text-anchor="start" x="264.38" y="-74.7" font-family="Helvetica,Arial,sans-serif" font-weight="bold" font-size="14.00">Value</text>
|
||||
<text text-anchor="start" x="300.38" y="-74.7" font-family="Helvetica,Arial,sans-serif" font-size="14.00">  (enum)</text>
|
||||
<text text-anchor="start" x="264.38" y="-44.7" font-family="Helvetica,Arial,sans-serif" font-size="14.00">Int(i64)</text>
|
||||
<text text-anchor="start" x="264.38" y="-15.7" font-family="Helvetica,Arial,sans-serif" font-size="14.00">Str(String)</text>
|
||||
</g>
|
||||
<!-- table_node->value_node -->
|
||||
<g id="edge3" class="edge">
|
||||
<title>table_node->value_node</title>
|
||||
<path fill="none" stroke="#333333" stroke-width="1.2" d="M152.48,-158.04C181.05,-137.9 214.32,-114.45 242.73,-94.42"/>
|
||||
<polygon fill="#333333" stroke="#333333" stroke-width="1.2" points="244.53,-97.44 250.68,-88.82 240.49,-91.72 244.53,-97.44"/>
|
||||
<text text-anchor="middle" x="240.66" y="-124.95" font-family="Helvetica,Arial,sans-serif" font-size="9.00" fill="#555555">Vec<Vec<Value>></text>
|
||||
</g>
|
||||
<!-- relation_node -->
|
||||
<g id="node2" class="node">
|
||||
<title>relation_node</title>
|
||||
<path fill="#eceff1" stroke="#607d8b" stroke-width="1.5" d="M381.75,-253.5C381.75,-253.5 234,-253.5 234,-253.5 228,-253.5 222,-247.5 222,-241.5 222,-241.5 222,-170.5 222,-170.5 222,-164.5 228,-158.5 234,-158.5 234,-158.5 381.75,-158.5 381.75,-158.5 387.75,-158.5 393.75,-164.5 393.75,-170.5 393.75,-170.5 393.75,-241.5 393.75,-241.5 393.75,-247.5 387.75,-253.5 381.75,-253.5"/>
|
||||
<text text-anchor="start" x="256.5" y="-233.2" font-family="Helvetica,Arial,sans-serif" font-weight="bold" font-size="14.00">Relation</text>
|
||||
<text text-anchor="start" x="309.75" y="-233.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">  (struct)</text>
|
||||
<text text-anchor="start" x="234" y="-203.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">columns: Vec<String></text>
|
||||
<text text-anchor="start" x="234" y="-174.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">rows: Vec<Vec<Value>></text>
|
||||
</g>
|
||||
<!-- relation_node->value_node -->
|
||||
<g id="edge4" class="edge">
|
||||
<title>relation_node->value_node</title>
|
||||
<path fill="none" stroke="#333333" stroke-width="1.2" d="M307.88,-158.04C307.88,-141.95 307.88,-123.74 307.88,-106.86"/>
|
||||
<polygon fill="#333333" stroke="#333333" stroke-width="1.2" points="311.38,-107.24 307.88,-97.24 304.38,-107.24 311.38,-107.24"/>
|
||||
<text text-anchor="middle" x="345" y="-124.95" font-family="Helvetica,Arial,sans-serif" font-size="9.00" fill="#555555">Vec<Vec<Value>></text>
|
||||
</g>
|
||||
<!-- atom_pattern_node -->
|
||||
<g id="node3" class="node">
|
||||
<title>atom_pattern_node</title>
|
||||
<path fill="#f3e5f5" stroke="#9c27b0" stroke-width="1.5" d="M563.5,-383C563.5,-383 432.25,-383 432.25,-383 426.25,-383 420.25,-377 420.25,-371 420.25,-371 420.25,-329 420.25,-329 420.25,-323 426.25,-317 432.25,-317 432.25,-317 563.5,-317 563.5,-317 569.5,-317 575.5,-323 575.5,-329 575.5,-329 575.5,-371 575.5,-371 575.5,-377 569.5,-383 563.5,-383"/>
|
||||
<text text-anchor="start" x="432.25" y="-362.7" font-family="Helvetica,Arial,sans-serif" font-weight="bold" font-size="14.00">AtomPattern</text>
|
||||
<text text-anchor="start" x="514" y="-362.7" font-family="Helvetica,Arial,sans-serif" font-size="14.00">  (struct)</text>
|
||||
<text text-anchor="start" x="432.25" y="-332.7" font-family="Helvetica,Arial,sans-serif" font-size="14.00">columns: Vec<Term></text>
|
||||
</g>
|
||||
<!-- term_node -->
|
||||
<g id="node4" class="node">
|
||||
<title>term_node</title>
|
||||
<path fill="#f3e5f5" stroke="#9c27b0" stroke-width="1.5" d="M539.88,-253.5C539.88,-253.5 455.88,-253.5 455.88,-253.5 449.88,-253.5 443.88,-247.5 443.88,-241.5 443.88,-241.5 443.88,-170.5 443.88,-170.5 443.88,-164.5 449.88,-158.5 455.88,-158.5 455.88,-158.5 539.88,-158.5 539.88,-158.5 545.88,-158.5 551.88,-164.5 551.88,-170.5 551.88,-170.5 551.88,-241.5 551.88,-241.5 551.88,-247.5 545.88,-253.5 539.88,-253.5"/>
|
||||
<text text-anchor="start" x="455.88" y="-233.2" font-family="Helvetica,Arial,sans-serif" font-weight="bold" font-size="14.00">Term</text>
|
||||
<text text-anchor="start" x="488.88" y="-233.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">  (enum)</text>
|
||||
<text text-anchor="start" x="455.88" y="-203.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">Var(String)</text>
|
||||
<text text-anchor="start" x="455.88" y="-174.2" font-family="Helvetica,Arial,sans-serif" font-size="14.00">Lit(Value)</text>
|
||||
</g>
|
||||
<!-- atom_pattern_node->term_node -->
|
||||
<g id="edge1" class="edge">
|
||||
<title>atom_pattern_node->term_node</title>
|
||||
<path fill="none" stroke="#333333" stroke-width="1.2" d="M497.88,-316.78C497.88,-301.61 497.88,-283.04 497.88,-265.52"/>
|
||||
<polygon fill="#333333" stroke="#333333" stroke-width="1.2" points="501.38,-265.73 497.88,-255.73 494.38,-265.73 501.38,-265.73"/>
|
||||
<text text-anchor="middle" x="520.75" y="-283.45" font-family="Helvetica,Arial,sans-serif" font-size="9.00" fill="#555555">Vec<Term></text>
|
||||
</g>
|
||||
<!-- term_node->value_node -->
|
||||
<g id="edge2" class="edge">
|
||||
<title>term_node->value_node</title>
|
||||
<path fill="none" stroke="#333333" stroke-width="1.2" d="M443.43,-160.15C421.36,-141.97 395.69,-120.83 372.66,-101.87"/>
|
||||
<polygon fill="#333333" stroke="#333333" stroke-width="1.2" points="375,-99.25 365.05,-95.6 370.54,-104.65 375,-99.25"/>
|
||||
<text text-anchor="middle" x="428.07" y="-124.95" font-family="Helvetica,Arial,sans-serif" font-size="9.00" fill="#555555">Lit(Value)</text>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 7.3 KiB |
Loading…
x
Reference in New Issue
Block a user