Skip to content

[Backport stable-25-2] Documentation for query execution concepts. #27631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: stable-25-2
Choose a base branch
from
Open

[Backport stable-25-2] Documentation for query execution concepts. #27631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions ydb/docs/en/core/concepts/_assets/query_workflow.drawio
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<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">
<diagram name="YDB Query Execution" id="s03gnwWGhEfyzJxEZV09">
<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">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-1" value="YDB Node" style="dashed=1;rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;verticalAlign=top;" vertex="1" parent="1">
<mxGeometry x="-80" y="352.5" width="210" height="175" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-2" value="YDB Node" style="dashed=1;rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;verticalAlign=top;" vertex="1" parent="1">
<mxGeometry x="-80" y="157.5" width="210" height="175" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-350" y="170" width="200" height="345" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-4" value="Client Application" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;verticalAlign=top;" vertex="1" parent="1">
<mxGeometry x="-600" y="210" width="160" height="190" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-585" y="250" width="130" height="130" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-7" value="Session" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="-570" y="290" width="100" height="30" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-8" value="Session" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="-570" y="330" width="100" height="30" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-11" value="Query Parser &amp; Optimizer" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="-315" y="285" width="130" height="40" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-12" value="Query Plan Cache" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="-315" y="210" width="130" height="40" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="-250" y="435" />
<mxPoint x="-295" y="435" />
</Array>
</mxGeometry>
</mxCell>
<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">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="-250" y="435" />
<mxPoint x="-205" y="435" />
</Array>
</mxGeometry>
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-17" value="Query Execution Engine" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="-315" y="375" width="130" height="40" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-418.5" y="320" width="50" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-60" y="272.5" width="70" height="40" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<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">
<mxGeometry x="40" y="272.5" width="70" height="40" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-23" value="ColumnShards" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="30" y="192.5" width="90" height="40" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-24" value="DataShards" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="-70" y="192.5" width="90" height="40" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-60" y="467.5" width="70" height="40" as="geometry" />
</mxCell>
<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">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<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">
<mxGeometry x="40" y="467.5" width="70" height="40" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-29" value="ColumnShards" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="30" y="387.5" width="90" height="40" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-30" value="DataShards" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="-70" y="387.5" width="90" height="40" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-240" y="337.5" width="60" height="15" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-32" value="YQL" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;" vertex="1" connectable="0" parent="1">
<mxGeometry x="-420" y="292.5" width="53" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-330" y="452.5" width="70" height="40" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-240" y="452.5" width="70" height="40" as="geometry" />
</mxCell>
<mxCell id="u0HLi7Xi4MvKD0CtP6yi-35" value="YDB Node" style="dashed=1;rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;verticalAlign=top;" vertex="1" parent="1">
<mxGeometry x="-80" y="550" width="210" height="90" as="geometry" />
</mxCell>
<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">
<mxGeometry x="-60" y="584" width="70" height="40" as="geometry" />
</mxCell>
<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">
<mxGeometry x="40" y="584" width="70" height="40" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Binary file added ydb/docs/en/core/concepts/_assets/query_workflow.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions ydb/docs/en/core/concepts/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@ The term **interactive transactions** refers to transactions that are split into
1. Update some data in the database.
1. Commit the transaction in a separate query.

### Sessions

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).

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

Expand Down
Loading