Skip to content

Documentation for query execution concepts. #22537

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

Merged
merged 19 commits into from
Oct 24, 2025
Merged

Documentation for query execution concepts. #22537

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
b5f7bf8
First version of docs for query execution concepts.
spuchin Aug 7, 2025
8fb3a83
Minor fixes.
spuchin Aug 8, 2025
c4d25f2
Next iteration.
spuchin Aug 19, 2025
d37aa61
Add workflow chart.
spuchin Aug 19, 2025
0a690ef
Bold captions in wf.
spuchin Aug 19, 2025
5e2880e
Add limitations.
spuchin Aug 19, 2025
57bf688
Update ydb/docs/en/core/concepts/query_execution.md
spuchin Aug 25, 2025
199b3f4
Update ydb/docs/en/core/concepts/query_execution.md
spuchin Aug 25, 2025
e2f6446
Update ydb/docs/en/core/concepts/query_execution.md
spuchin Aug 25, 2025
2ec24af
Update ydb/docs/en/core/concepts/query_execution.md
spuchin Aug 25, 2025
603176a
Update ydb/docs/en/core/concepts/query_execution.md
spuchin Aug 25, 2025
05d4c77
Update ydb/docs/en/core/concepts/query_execution.md
spuchin Aug 25, 2025
9ee4653
Update ydb/docs/en/core/concepts/query_execution.md
spuchin Aug 25, 2025
bd5c4f7
Minor fixes.
spuchin Aug 25, 2025
802d1f7
Add russian version.
spuchin Aug 25, 2025
f550f73
Update chart to ru.
spuchin Aug 26, 2025
2bfa3d3
remove ru version
orange13 Oct 16, 2025
3105deb
small transactions edit
orange13 Oct 16, 2025
723b746
fix after review
orange13 Oct 20, 2025
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
122 changes: 122 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,122 @@
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 YaBrowser/25.6.0.0 Safari/537.36" version="26.1.0">
<diagram name="YDB Query Execution" id="VA4aEMhLpSQhZLtYT9ai">
<mxGraphModel dx="1853" dy="696" 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="M2VwiEWQkAIFONeX4CcQ-71" 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="M2VwiEWQkAIFONeX4CcQ-57" 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="M2VwiEWQkAIFONeX4CcQ-46" 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="M2VwiEWQkAIFONeX4CcQ-19" 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="M2VwiEWQkAIFONeX4CcQ-39" 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="M2VwiEWQkAIFONeX4CcQ-51" 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="M2VwiEWQkAIFONeX4CcQ-44" target="M2VwiEWQkAIFONeX4CcQ-49">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-44" 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="M2VwiEWQkAIFONeX4CcQ-45" 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="M2VwiEWQkAIFONeX4CcQ-54" 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="M2VwiEWQkAIFONeX4CcQ-49" target="M2VwiEWQkAIFONeX4CcQ-53">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-78" 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="M2VwiEWQkAIFONeX4CcQ-49" target="M2VwiEWQkAIFONeX4CcQ-55">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-49" 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="M2VwiEWQkAIFONeX4CcQ-53" 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="M2VwiEWQkAIFONeX4CcQ-80" 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="M2VwiEWQkAIFONeX4CcQ-55" target="M2VwiEWQkAIFONeX4CcQ-63">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-81" 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="M2VwiEWQkAIFONeX4CcQ-55" target="M2VwiEWQkAIFONeX4CcQ-73">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-85" 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="M2VwiEWQkAIFONeX4CcQ-55" target="M2VwiEWQkAIFONeX4CcQ-83">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="-250" y="435" />
<mxPoint x="-295" y="435" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-86" 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="M2VwiEWQkAIFONeX4CcQ-55" target="M2VwiEWQkAIFONeX4CcQ-84">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="-250" y="435" />
<mxPoint x="-205" y="435" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-55" 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="M2VwiEWQkAIFONeX4CcQ-56" 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="M2VwiEWQkAIFONeX4CcQ-69" 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="M2VwiEWQkAIFONeX4CcQ-63" target="M2VwiEWQkAIFONeX4CcQ-68">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-63" 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="M2VwiEWQkAIFONeX4CcQ-70" 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="M2VwiEWQkAIFONeX4CcQ-64" target="M2VwiEWQkAIFONeX4CcQ-67">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-64" 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="M2VwiEWQkAIFONeX4CcQ-67" 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="M2VwiEWQkAIFONeX4CcQ-68" 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="M2VwiEWQkAIFONeX4CcQ-72" 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="M2VwiEWQkAIFONeX4CcQ-73" target="M2VwiEWQkAIFONeX4CcQ-77">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-73" 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="M2VwiEWQkAIFONeX4CcQ-74" 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="M2VwiEWQkAIFONeX4CcQ-75" target="M2VwiEWQkAIFONeX4CcQ-76">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="M2VwiEWQkAIFONeX4CcQ-75" 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="M2VwiEWQkAIFONeX4CcQ-76" 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="M2VwiEWQkAIFONeX4CcQ-77" 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="M2VwiEWQkAIFONeX4CcQ-79" 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="M2VwiEWQkAIFONeX4CcQ-82" 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="M2VwiEWQkAIFONeX4CcQ-83" 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="M2VwiEWQkAIFONeX4CcQ-84" 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>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Binary file added ydb/docs/en/core/concepts/_assets/query_workflow.png
View file
Open in desktop
Copy link
Member

@fomichev3000 fomichev3000 Oct 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

У нас везде должно быть DataShard и ColumnShard. А на картинке написано Datashard и Columnshard.

Могут ли Compute Tasks запускаться на нодах, которые

  1. Не являются entry point
  2. Не содержат CS, DS?
    Мой ответ -- да. Но это не видно

Copy link
Collaborator Author

@spuchin spuchin Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Можно картинку усложнить, я не против, но она все равно схематическая, не думаю что это добавит понимания.

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 @@ -111,6 +111,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