gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2026-02-12 08:44:26 +01:00
Code Issues Actions 14 Packages Projects Releases Wiki Activity

docs(user): update SQL console based on new interaction

Browse Source
This commit is contained in:
Elian Doran 2026-01-18 18:06:30 +02:00
parent 57d894e765
commit 4a82bbb035
No known key found for this signature in database
3 changed files with 57 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.html generated vendored
View File

@ -11,20 +11,44 @@
<li>Only one SQL statement can be run at once.</li>
<li>To run the statement, press the <em>Execute</em> icon.</li>
<li>For queries that return a result, the data will displayed in a table.</li>
<li
>For statements (e.g. <code spellcheck="false">INSERT</code>, <code spellcheck="false">UPDATE</code>),
the number of affected rows is displayed.</li>
</ul>
<figure class="image">
<img style="aspect-ratio:1124/571;" src="2_SQL Console_image.png"
width="1124" height="571">
</figure>
<h3>Interacting with the table</h3>
<p>After executing a query, a table with the results will be displayed:</p>
<ul>
<li>
<p>Clicking on a column allows sorting ascending or descending.</p>
</li>
<li>
<p>Underneath each column there is an input field which allows filtering
by text.</p>
</li>
<li>
<p>Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to copy the current cell to clipboard.</p>
</li>
<li>
<p>Multiple cells can be selected by dragging or by holding <kbd>Shift</kbd> +
arrow keys</p>
</li>
<li>
<p>Results are paginated for performance reasons. The controls at the bottom
of the table can be used to navigate through pages.</p>
</li>
</ul>
<h3>Saved SQL console</h3>
<p>SQL queries or commands can be saved into a dedicated note.</p>
<p>To do so, simply write the query and press the
<img src="1_SQL Console_image.png">button. Once saved, the note will appear in&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/5668rwcirq1t/_help_l0tKav7yLHGF">Day Notes</a>.</p>
<ul>
<li>The SQL expression will not be displayed by default, but it can still
be viewed by going to the note context menu and selecting <em>Note source</em>.</li>
<li
>The expression cannot be modified. If needed, recreate it by copying the
statement back into the SQL console and then saving it again.</li>
</ul>
<p>The note can be locked for editing by pressing the <em>Lock</em> button
in the note actions section near the title bar (on the&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_IjZS7iK5EXtb">New Layout</a>,
or in the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;area
if using the old layout). When editing is locked, the SQL statement is
hidden from view.</p>

14
docs/User Guide/!!!meta.json vendored
View File

@ -14227,6 +14227,20 @@
"value": "x3i7MxGccDuM",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "IjZS7iK5EXtb",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "XpOYSgsLkTJy",
"isInheritable": false,
"position": 80
}
],
"format": "markdown",

14
docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md vendored
View File

@ -11,14 +11,24 @@ It can be accessed by going to the <a class="reference-link" href="../../../Bas
* Only one SQL statement can be run at once.
* To run the statement, press the _Execute_ icon.
* For queries that return a result, the data will displayed in a table.
* For statements (e.g. `INSERT`, `UPDATE`), the number of affected rows is displayed.
<figure class="image"><img style="aspect-ratio:1124/571;" src="2_SQL Console_image.png" width="1124" height="571"></figure>
### Interacting with the table
After executing a query, a table with the results will be displayed:
* Clicking on a column allows sorting ascending or descending.
* Underneath each column there is an input field which allows filtering by text.
* Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to copy the current cell to clipboard.
* Multiple cells can be selected by dragging or by holding <kbd>Shift</kbd> + arrow keys
* Results are paginated for performance reasons. The controls at the bottom of the table can be used to navigate through pages.
### Saved SQL console
SQL queries or commands can be saved into a dedicated note.
To do so, simply write the query and press the ![](1_SQL%20Console_image.png) button. Once saved, the note will appear in <a class="reference-link" href="../../Advanced%20Showcases/Day%20Notes.md">Day Notes</a>.
* The SQL expression will not be displayed by default, but it can still be viewed by going to the note context menu and selecting _Note source_.
* The expression cannot be modified. If needed, recreate it by copying the statement back into the SQL console and then saving it again.
The note can be locked for editing by pressing the _Lock_ button in the note actions section near the title bar (on the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/New%20Layout.md">New Layout</a>, or in the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> area if using the old layout). When editing is locked, the SQL statement is hidden from view.