]> BookStack Code Mirror - bookstack/commit
DB: Aligned entity structure to a common table
authorDan Brown <redacted>
Sat, 18 Oct 2025 12:14:30 +0000 (13:14 +0100)
committerGitHub <redacted>
Sat, 18 Oct 2025 12:14:30 +0000 (13:14 +0100)
commit4c7d6420ee6ab08c5d1df5221962d84abcb89b21
treedd804d41fc292c09118e4c11e43bb6cbd819e57d
parent146a6c01cc89a355b0d95af0ff22de64a42372b3
DB: Aligned entity structure to a common table

As per PR #5800

* DB: Planned out new entity table format via migrations

* DB: Created entity migration logic

Made some other tweaks/fixes while testing.

* DB: Added change of entity relation columns to suit new entities table

* DB: Got most view queries working for new structure

* Entities: Started logic change to new structure

Updated base entity class, and worked through BaseRepo.
Need to go through other repos next.

Removed a couple of redundant interfaces as part of this since we can
move the logic onto the shared ContainerData model as needed.

* Entities: Been through repos to update for new format

* Entities: Updated repos to act on refreshed clones

Changes to core entity models are now done on clones to ensure clean
state before save, and those clones are returned back if changes are
needed after that action.

* Entities: Updated model classes & relations for changes

* Entities: Changed from *Data to a common "contents" system

Added smart loading from builder instances which should hydrate with
"contents()" loaded via join, while keeping the core model original.

* Entities: Moved entity description/covers to own non-model classes

Added back some interfaces.

* Entities: Removed use of contents system for data access

* Entities: Got most queries back to working order

* Entities: Reverted back to data from contents, fixed various issues

* Entities: Started addressing issues from tests

* Entities: Addressed further tests/issues

* Entities: Been through tests to get all passing in dev

Fixed issues and needed test changes along the way.

* Entities: Addressed phpstan errors

* Entities: Reviewed TODO notes

* Entities: Ensured book/shelf relation data removed on destroy

* Entities: Been through API responses & adjusted field visibility

* Entities: Added type index to massively improve query speed
120 files changed:
app/Access/Mfa/MfaSession.php
app/Console/Commands/UpdateUrlCommand.php
app/Entities/Controllers/BookApiController.php
app/Entities/Controllers/BookshelfApiController.php
app/Entities/Controllers/BookshelfController.php
app/Entities/Controllers/ChapterApiController.php
app/Entities/Controllers/ChapterController.php
app/Entities/Controllers/PageController.php
app/Entities/EntityExistsRule.php [new file with mode: 0644]
app/Entities/Models/Book.php
app/Entities/Models/BookChild.php
app/Entities/Models/Bookshelf.php
app/Entities/Models/Chapter.php
app/Entities/Models/ContainerTrait.php [new file with mode: 0644]
app/Entities/Models/CoverImageInterface.php [deleted file]
app/Entities/Models/Entity.php
app/Entities/Models/EntityContainerData.php [new file with mode: 0644]
app/Entities/Models/EntityPageData.php [new file with mode: 0644]
app/Entities/Models/EntityQueryBuilder.php [new file with mode: 0644]
app/Entities/Models/EntityScope.php [new file with mode: 0644]
app/Entities/Models/HasCoverInterface.php [new file with mode: 0644]
app/Entities/Models/HasDefaultTemplateInterface.php [new file with mode: 0644]
app/Entities/Models/HasDescriptionInterface.php [new file with mode: 0644]
app/Entities/Models/HtmlDescriptionInterface.php [deleted file]
app/Entities/Models/HtmlDescriptionTrait.php [deleted file]
app/Entities/Models/Page.php
app/Entities/Queries/BookQueries.php
app/Entities/Queries/BookshelfQueries.php
app/Entities/Queries/ChapterQueries.php
app/Entities/Queries/EntityQueries.php
app/Entities/Queries/PageQueries.php
app/Entities/Queries/ProvidesEntityQueries.php
app/Entities/Repos/BaseRepo.php
app/Entities/Repos/BookRepo.php
app/Entities/Repos/BookshelfRepo.php
app/Entities/Repos/ChapterRepo.php
app/Entities/Repos/DeletionRepo.php
app/Entities/Repos/PageRepo.php
app/Entities/Repos/RevisionRepo.php
app/Entities/Tools/BookContents.php
app/Entities/Tools/Cloner.php
app/Entities/Tools/EntityCover.php [new file with mode: 0644]
app/Entities/Tools/EntityDefaultTemplate.php [new file with mode: 0644]
app/Entities/Tools/EntityHtmlDescription.php [new file with mode: 0644]
app/Entities/Tools/HierarchyTransformer.php
app/Entities/Tools/MixedEntityListLoader.php
app/Entities/Tools/PageContent.php
app/Entities/Tools/TrashCan.php
app/Exports/ExportFormatter.php
app/Exports/ZipExports/Models/ZipExportBook.php
app/Exports/ZipExports/Models/ZipExportChapter.php
app/Exports/ZipExports/ZipImportRunner.php
app/Permissions/PermissionApplicator.php
app/References/ReferenceFetcher.php
app/References/ReferenceUpdater.php
app/Sorting/BookSorter.php
app/Sorting/SortRule.php
app/Sorting/SortRuleController.php
app/Uploads/Controllers/AttachmentApiController.php
app/Uploads/Controllers/AttachmentController.php
app/Uploads/ImageService.php
app/Users/Controllers/UserApiController.php
app/Users/UserRepo.php
database/factories/Entities/Models/ChapterFactory.php
database/factories/Entities/Models/PageFactory.php
database/migrations/2023_01_24_104625_refactor_joint_permissions_storage.php
database/migrations/2025_09_15_132850_create_entities_table.php [new file with mode: 0644]
database/migrations/2025_09_15_134701_migrate_entity_data.php [new file with mode: 0644]
database/migrations/2025_09_15_134751_update_entity_relation_columns.php [new file with mode: 0644]
database/migrations/2025_09_15_134813_drop_old_entity_tables.php [new file with mode: 0644]
database/seeders/DummyContentSeeder.php
dev/api/responses/books-read.json
dev/api/responses/pages-create.json
dev/api/responses/pages-read.json
dev/api/responses/recycle-bin-list.json
resources/views/books/parts/form.blade.php
resources/views/books/parts/list-item.blade.php
resources/views/books/show.blade.php
resources/views/chapters/show.blade.php
resources/views/entities/grid-item.blade.php
resources/views/exports/book.blade.php
resources/views/exports/chapter.blade.php
resources/views/exports/parts/chapter-item.blade.php
resources/views/form/description-html-input.blade.php
resources/views/shelves/parts/form.blade.php
resources/views/shelves/parts/list-item.blade.php
resources/views/shelves/show.blade.php
tests/Api/ApiAuthTest.php
tests/Api/BooksApiTest.php
tests/Api/ChaptersApiTest.php
tests/Api/ContentPermissionsApiTest.php
tests/Api/PagesApiTest.php
tests/Api/RecycleBinApiTest.php
tests/Api/ShelvesApiTest.php
tests/Auth/MfaConfigurationTest.php
tests/Commands/UpdateUrlCommandTest.php
tests/Entity/BookShelfTest.php
tests/Entity/BookTest.php
tests/Entity/ConvertTest.php
tests/Entity/DefaultTemplateTest.php
tests/Entity/PageDraftTest.php
tests/Entity/PageEditorTest.php
tests/Entity/PageRevisionTest.php
tests/Entity/PageTemplateTest.php
tests/Entity/PageTest.php
tests/Exports/MarkdownExportTest.php
tests/Exports/ZipExportTest.php
tests/Exports/ZipImportRunnerTest.php
tests/Helpers/EntityProvider.php
tests/Meta/OpenGraphTest.php
tests/Permissions/EntityOwnerChangeTest.php
tests/Permissions/EntityPermissionsTest.php
tests/PublicActionTest.php
tests/References/ReferencesTest.php
tests/Settings/RecycleBinTest.php
tests/Sorting/BookSortTest.php
tests/Sorting/MoveTest.php
tests/Sorting/SortRuleTest.php
tests/TestCase.php
tests/User/UserManagementTest.php