Skip to content

Commit eefda88

Browse files
spuchinblinkovorange13
authored and
github-actions[bot]
committed
Documentation for query execution concepts. (#22537)
Co-authored-by: Ivan Blinkov <[email protected]> Co-authored-by: orange13 <[email protected]> (cherry picked from commit 741b5df)
1 parent 688c4c2 commit eefda88

File tree

5 files changed

+236
-0
lines changed

5 files changed

+236
-0
lines changed

‎ydb/docs/en/core/concepts/_assets/query_workflow.drawio‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 YaBrowser/25.8.0.0 Safari/537.36" version="28.2.7">
2+
<diagram name="YDB Query Execution" id="s03gnwWGhEfyzJxEZV09">
3+
<mxGraphModel dx="2448" dy="955" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
4+
<root>
5+
<mxCell id="0" />
6+
<mxCell id="1" parent="0" />
7+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-1" value="YDB Node" style="dashed=1;rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;verticalAlign=top;" vertex="1" parent="1">
8+
<mxGeometry x="-80" y="352.5" width="210" height="175" as="geometry" />
9+
</mxCell>
10+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-2" value="YDB Node" style="dashed=1;rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;verticalAlign=top;" vertex="1" parent="1">
11+
<mxGeometry x="-80" y="157.5" width="210" height="175" as="geometry" />
12+
</mxCell>
13+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-3" value="YDB Node (Entrypoint)" style="dashed=1;rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;verticalAlign=top;" vertex="1" parent="1">
14+
<mxGeometry x="-350" y="170" width="200" height="345" as="geometry" />
15+
</mxCell>
16+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-4" value="Client Application" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;verticalAlign=top;" vertex="1" parent="1">
17+
<mxGeometry x="-600" y="210" width="160" height="190" as="geometry" />
18+
</mxCell>
19+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-5" value="YDB SDK / Driver" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#FFFFFF;strokeColor=#6c8ebf;verticalAlign=top;" vertex="1" parent="1">
20+
<mxGeometry x="-585" y="250" width="130" height="130" as="geometry" />
21+
</mxCell>
22+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-6" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-7" target="u0HLi7Xi4MvKD0CtP6yi-11">
23+
<mxGeometry relative="1" as="geometry" />
24+
</mxCell>
25+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-7" value="Session" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
26+
<mxGeometry x="-570" y="290" width="100" height="30" as="geometry" />
27+
</mxCell>
28+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-8" value="Session" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
29+
<mxGeometry x="-570" y="330" width="100" height="30" as="geometry" />
30+
</mxCell>
31+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-9" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;dashed=1;endArrow=none;startFill=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-11" target="u0HLi7Xi4MvKD0CtP6yi-12">
32+
<mxGeometry relative="1" as="geometry" />
33+
</mxCell>
34+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-11" target="u0HLi7Xi4MvKD0CtP6yi-17">
35+
<mxGeometry relative="1" as="geometry" />
36+
</mxCell>
37+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-11" value="Query Parser &amp; Optimizer" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
38+
<mxGeometry x="-315" y="285" width="130" height="40" as="geometry" />
39+
</mxCell>
40+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-12" value="Query Plan Cache" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
41+
<mxGeometry x="-315" y="210" width="130" height="40" as="geometry" />
42+
</mxCell>
43+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-13" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-17" target="u0HLi7Xi4MvKD0CtP6yi-20">
44+
<mxGeometry relative="1" as="geometry" />
45+
</mxCell>
46+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-17" target="u0HLi7Xi4MvKD0CtP6yi-26">
47+
<mxGeometry relative="1" as="geometry" />
48+
</mxCell>
49+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-17" target="u0HLi7Xi4MvKD0CtP6yi-33">
50+
<mxGeometry relative="1" as="geometry">
51+
<Array as="points">
52+
<mxPoint x="-250" y="435" />
53+
<mxPoint x="-295" y="435" />
54+
</Array>
55+
</mxGeometry>
56+
</mxCell>
57+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-16" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-17" target="u0HLi7Xi4MvKD0CtP6yi-34">
58+
<mxGeometry relative="1" as="geometry">
59+
<Array as="points">
60+
<mxPoint x="-250" y="435" />
61+
<mxPoint x="-205" y="435" />
62+
</Array>
63+
</mxGeometry>
64+
</mxCell>
65+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-42" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-17" target="u0HLi7Xi4MvKD0CtP6yi-35">
66+
<mxGeometry relative="1" as="geometry" />
67+
</mxCell>
68+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-17" value="Query Execution Engine" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
69+
<mxGeometry x="-315" y="375" width="130" height="40" as="geometry" />
70+
</mxCell>
71+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-18" value="(GRpc Call)" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;" vertex="1" connectable="0" parent="1">
72+
<mxGeometry x="-418.5" y="320" width="50" as="geometry" />
73+
</mxCell>
74+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-19" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-20" target="u0HLi7Xi4MvKD0CtP6yi-24">
75+
<mxGeometry relative="1" as="geometry" />
76+
</mxCell>
77+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-20" value="Compute&lt;br&gt;Task" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
78+
<mxGeometry x="-60" y="272.5" width="70" height="40" as="geometry" />
79+
</mxCell>
80+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-21" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-22" target="u0HLi7Xi4MvKD0CtP6yi-23">
81+
<mxGeometry relative="1" as="geometry" />
82+
</mxCell>
83+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-22" value="Compute&lt;br&gt;Task" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
84+
<mxGeometry x="40" y="272.5" width="70" height="40" as="geometry" />
85+
</mxCell>
86+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-23" value="ColumnShards" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
87+
<mxGeometry x="30" y="192.5" width="90" height="40" as="geometry" />
88+
</mxCell>
89+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-24" value="DataShards" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
90+
<mxGeometry x="-70" y="192.5" width="90" height="40" as="geometry" />
91+
</mxCell>
92+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-25" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-26" target="u0HLi7Xi4MvKD0CtP6yi-30">
93+
<mxGeometry relative="1" as="geometry" />
94+
</mxCell>
95+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-26" value="Compute&lt;br&gt;Task" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
96+
<mxGeometry x="-60" y="467.5" width="70" height="40" as="geometry" />
97+
</mxCell>
98+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-27" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="u0HLi7Xi4MvKD0CtP6yi-28" target="u0HLi7Xi4MvKD0CtP6yi-29">
99+
<mxGeometry relative="1" as="geometry" />
100+
</mxCell>
101+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-28" value="Compute&lt;br&gt;Task" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
102+
<mxGeometry x="40" y="467.5" width="70" height="40" as="geometry" />
103+
</mxCell>
104+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-29" value="ColumnShards" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
105+
<mxGeometry x="30" y="387.5" width="90" height="40" as="geometry" />
106+
</mxCell>
107+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-30" value="DataShards" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
108+
<mxGeometry x="-70" y="387.5" width="90" height="40" as="geometry" />
109+
</mxCell>
110+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-31" value="Query Plan" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;" vertex="1" connectable="0" parent="1">
111+
<mxGeometry x="-240" y="337.5" width="60" height="15" as="geometry" />
112+
</mxCell>
113+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-32" value="YQL" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;" vertex="1" connectable="0" parent="1">
114+
<mxGeometry x="-420" y="292.5" width="53" as="geometry" />
115+
</mxCell>
116+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-33" value="Compute&lt;br&gt;Task" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
117+
<mxGeometry x="-330" y="452.5" width="70" height="40" as="geometry" />
118+
</mxCell>
119+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-34" value="Compute&lt;br&gt;Task" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
120+
<mxGeometry x="-240" y="452.5" width="70" height="40" as="geometry" />
121+
</mxCell>
122+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-35" value="YDB Node" style="dashed=1;rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;verticalAlign=top;" vertex="1" parent="1">
123+
<mxGeometry x="-80" y="550" width="210" height="90" as="geometry" />
124+
</mxCell>
125+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-37" value="Compute&lt;br&gt;Task" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
126+
<mxGeometry x="-60" y="584" width="70" height="40" as="geometry" />
127+
</mxCell>
128+
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-39" value="Compute&lt;br&gt;Task" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
129+
<mxGeometry x="40" y="584" width="70" height="40" as="geometry" />
130+
</mxCell>
131+
</root>
132+
</mxGraphModel>
133+
</diagram>
134+
</mxfile>

‎ydb/docs/en/core/concepts/_assets/query_workflow.png‎

53 KB
Loading

‎ydb/docs/en/core/concepts/glossary.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,9 @@ The term **interactive transactions** refers to transactions that are split into
115115
1. Update some data in the database.
116116
1. Commit the transaction in a separate query.
117117

118+
### Sessions
119+
120+
Logical "connections" to the database that maintains the context needed to execute queries and manage transactions. They are explained in more detail in [{#T}](query_execution.md#sessions).
118121

119122
### Multi-version concurrency control {#mvcc}
120123

0 commit comments

Comments
 (0)