Skip to content

Commit 2c5c98c

Browse files
committed
docs: update formatting of schema_changes page
1 parent 8cef5e5 commit 2c5c98c

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

docs/updates/schema_changes.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ icon: material/database-edit
44

55
# :material-database-edit: Save Format Changes
66

7-
This page outlines the various changes made to the TagStudio save file format over time, sometimes referred to as the "database" or "database file".
7+
This page outlines the various changes made to the TagStudio library save file format over time, sometimes referred to as the "database" or "database file".
88

99
---
1010

1111
## JSON
1212

13+
Legacy (JSON) library save format versions were tied to the release version of the program itself. This number was stored in a `version` key inside the JSON file.
14+
15+
### Versions 1.0.0 - 9.4.2
16+
1317
| Used From | Used Until | Format | Location |
1418
| --------- | ----------------------------------------------------------------------- | ------ | --------------------------------------------- |
1519
| v1.0.0 | [v9.4.2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.4.2) | JSON | `<Library Folder>`/.TagStudio/ts_library.json |
@@ -20,42 +24,52 @@ Replaced by the new SQLite format introduced in TagStudio [v9.5.0 Pre-Release 1]
2024

2125
---
2226

23-
## DB_VERSION 6
27+
## SQLite
28+
29+
Starting with TagStudio [v9.5.0-pr1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1), the library save format has been moved to a [SQLite](https://sqlite.org) format. Legacy JSON libraries are migrated (with the user's consent) to the new format when opening in current versions of the program. The save format versioning is now separate from the program's versioning number and stored inside a `DB_VERSION` attribute inside the SQLite file.
30+
31+
### Versions 1 - 5
32+
33+
These versions were used while developing the new SQLite file format, outside any official or recommended release. These versions **were never supported** in any official capacity and were actively warned against using for real libraries.
34+
35+
---
36+
37+
### Version 6
2438

2539
| Used From | Used Until | Format | Location |
2640
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
27-
| [v9.5.0-PR1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | [v9.5.0-PR1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
41+
| [v9.5.0-pr1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | [v9.5.0-pr1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
2842

2943
The first public version of the SQLite save file format.
3044

3145
Migration from the legacy JSON format is provided via a walkthrough when opening a legacy library in TagStudio [v9.5.0 Pre-Release 1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) or later.
3246

3347
---
3448

35-
## DB_VERSION 7
49+
### Version 7
3650

3751
| Used From | Used Until | Format | Location |
3852
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
39-
| [v9.5.0-PR2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr2) | [v9.5.0-PR3](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr3) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
53+
| [v9.5.0-pr2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr2) | [v9.5.0-pr3](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr3) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
4054

4155
- Repairs "Description" fields to use a TEXT_LINE key instead of a TEXT_BOX key.
4256
- Repairs tags that may have a disambiguation_id pointing towards a deleted tag.
4357

4458
---
4559

46-
## DB_VERSION 8
60+
### Version 8
4761

4862
| Used From | Used Until | Format | Location |
4963
| ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
50-
| [v9.5.0-PR4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr4) | [v9.5.1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
64+
| [v9.5.0-pr4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr4) | [v9.5.1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
5165

5266
- Adds the `color_border` column to the `tag_colors` table. Used for instructing the [secondary color](../library/tag_color.md#secondary-color) to apply to a tag's border as a new optional behavior.
5367
- Adds three new default colors: "Burgundy (TagStudio Shades)", "Dark Teal (TagStudio Shades)", and "Dark Lavender (TagStudio Shades)".
5468
- Updates Neon colors to use the new `color_border` property.
5569

5670
---
5771

58-
## DB_VERSION 9
72+
### Version 9
5973

6074
| Used From | Used Until | Format | Location |
6175
| ----------------------------------------------------------------------- | ---------- | ------ | ----------------------------------------------- |

0 commit comments

Comments
 (0)