chore(edit-docs): move Markdown documentation outside src for now
|
After Width: | Height: | Size: 668 B |
|
After Width: | Height: | Size: 542 B |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 635 B |
|
After Width: | Height: | Size: 508 B |
|
After Width: | Height: | Size: 134 KiB |
|
After Width: | Height: | Size: 35 KiB |
@@ -0,0 +1,42 @@
|
||||
# Manually altering the database
|
||||
There are some situations where modifying the SQLite database that Trilium uses is desirable.
|
||||
|
||||
If you are doing any advanced development or troubleshooting where you manually modify the database, you might want to consider creating backups of your `document.db` file.
|
||||
|
||||
## Modifying it internally using the SQL Console
|
||||
|
||||
The SQL Console is Trilium's built-in database editor.
|
||||
|
||||
See [SQL Console](Manually%20altering%20the%20database/SQL%20Console.md).
|
||||
|
||||
## Externally modifying the database
|
||||
|
||||
Sometimes the SQL Console cannot be used (for example if the application cannot start).
|
||||
|
||||
When making external modifications, consider closing the desktop application. If modifying the server database, then stop the service or Docker container.
|
||||
|
||||
### Using DB Browser for SQLite
|
||||
|
||||
DB Browser for SQLite is a cross-platform editor that can be used to alter the database using a graphical user interface.
|
||||
|
||||
To do so:
|
||||
|
||||
1. In the main menu, select File → Open database… and navigate to the database in the [Data directory](../../Installation%20%26%20Setup/Data%20directory.md).
|
||||
2. Select the _Execute SQL_ tab.
|
||||
3. Type in the desired SQL statement.
|
||||
4. Press the "Play" button in the toolbar underneath the "Execute SQL" tab (or F5 key).
|
||||
5. Press "Write Changes" in the main toolbar.
|
||||
6. Close the application or close the database.
|
||||
|
||||

|
||||
|
||||
### Using the SQLite CLI
|
||||
|
||||
First, start the SQLite 3 CLI by specifying the path to the database:
|
||||
|
||||
```sh
|
||||
sqlite3 ~/.local/share/trilium-data/document.db
|
||||
```
|
||||
|
||||
* In the prompt simply type the statement and make sure it ends with a `;` character.
|
||||
* To exit, simply type `.quit` and enter.
|
||||
|
After Width: | Height: | Size: 542 B |
|
After Width: | Height: | Size: 508 B |
|
After Width: | Height: | Size: 35 KiB |
@@ -0,0 +1,25 @@
|
||||
# SQL Console
|
||||
The SQL Console is Trilium's built-in database editor.
|
||||
|
||||
It can be accessed by going to the [global menu](../../../Basic%20Concepts/UI%20Elements) → Advanced → Open SQL Console.
|
||||
|
||||

|
||||
|
||||
### Interaction
|
||||
|
||||
* Hovering the mouse over one of the tables listed at the top of the document will show the columns and their data type.
|
||||
* Only one SQL statement can be run at once.
|
||||
* To run the statement, press the icon.
|
||||
* For queries that return a result, the data will displayed in a table.
|
||||
|
||||

|
||||
|
||||
|
||||
### Saved SQL console
|
||||
|
||||
SQL queries or commands can be saved into a dedicated note.
|
||||
|
||||
To do so, simply write the query and press the button. Once saved, the note will appear in [Day Notes](../../Advanced%20Showcases/Day%20Notes.md).
|
||||
|
||||
* 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.
|
||||
|
After Width: | Height: | Size: 30 KiB |