Please support sqlite #311

Open
opened 2026-02-04 18:24:50 +03:00 by OVERLORD · 14 comments
Owner

Originally created by @jvoisin on GitHub (Apr 23, 2017).

It would be great to support sqlite as database backend:

  • It's already a dependency, for search
  • My small instance doesn't need (nor want) a complete MySQL server
  • It'll ease the backups
  • It shouldn't have an impact on performances
  • It'll ease the installation process
Originally created by @jvoisin on GitHub (Apr 23, 2017). It would be great to support sqlite as database backend: - It's already a dependency, for search - My small instance doesn't need (nor want) a complete MySQL server - It'll ease the backups - It shouldn't have an impact on performances - It'll ease the installation process
OVERLORD added the 🛠️ Enhancement Open to discussion💿 Database labels 2026-02-04 18:24:50 +03:00
Author
Owner

@ssddanbrown commented on GitHub (Apr 23, 2017):

Hi @jvoisin, Sqllite is not currently a dependency, even for search. I can see how sqlite may be better for smaller instances though. The new changes to the search system makes support for sqlite much more possible now.

I just had a go (b30ee10699c3c96c17c78fba5642e201087fa5a3) but it is going to take some additional care to implement, Don't really want to do this right before a release. Need to also consider the additional amount of work and support this will need going forward. It's close similarities to MySQL helps though.

@ssddanbrown commented on GitHub (Apr 23, 2017): Hi @jvoisin, Sqllite is not currently a dependency, even for search. I can see how sqlite may be better for smaller instances though. The new changes to the search system makes support for sqlite much more possible now. I just had a go (b30ee10699c3c96c17c78fba5642e201087fa5a3) but it is going to take some additional care to implement, Don't really want to do this right before a release. Need to also consider the additional amount of work and support this will need going forward. It's close similarities to MySQL helps though.
Author
Owner

@jvoisin commented on GitHub (Apr 23, 2017):

Damn, I misread the ticket about the possibility of using sqlite for plain-text search, sorry.

Thank you for considering this ♥

@jvoisin commented on GitHub (Apr 23, 2017): Damn, I misread the ticket about the possibility of using sqlite for plain-text search, sorry. Thank you for considering this ♥
Author
Owner

@ssddanbrown commented on GitHub (Feb 2, 2018):

Just in-case someone is interested in this feature, More in-depth conversions about non-MySQL support can be found in #76.

@ssddanbrown commented on GitHub (Feb 2, 2018): Just in-case someone is interested in this feature, More in-depth conversions about non-MySQL support can be found in #76.
Author
Owner

@partoneoftwo commented on GitHub (Feb 3, 2020):

What would be the first steps to developing SQLite support?

@partoneoftwo commented on GitHub (Feb 3, 2020): What would be the first steps to developing SQLite support?
Author
Owner

@ssddanbrown commented on GitHub (Feb 3, 2020):

@partoneoftwo In regards to the technical aspect, It'd be a case of adding in the sqllite part of the default laravel config into the similar BookStack file, updating the config to point at a sqllite db, then migrate and fix any issues from there.

In regards to getting support into the project, It would require my faith in a longer term contributor. I've detailed my feelings for additional DB support here:
https://github.com/BookStackApp/BookStack/issues/76#issuecomment-494956958

My feelings remain much the same.

@ssddanbrown commented on GitHub (Feb 3, 2020): @partoneoftwo In regards to the technical aspect, It'd be a case of adding in the [sqllite part of the default laravel config](https://github.com/laravel/laravel/blob/v6.12.0/config/database.php#L38) into the [similar BookStack file](https://github.com/BookStackApp/BookStack/blob/v0.27.5/app/Config/database.php), updating the config to point at a sqllite db, then migrate and fix any issues from there. In regards to getting support into the project, It would require my faith in a longer term contributor. I've detailed my feelings for additional DB support here: https://github.com/BookStackApp/BookStack/issues/76#issuecomment-494956958 My feelings remain much the same.
Author
Owner

@partoneoftwo commented on GitHub (Feb 3, 2020):

Thanks for the thoughts.
This does not seem like an unfeasible set of steps.

About the error messages:
Regarding the error messages listed in #617, to me do not seem severe. Curiously and interestingly the SQLite errors are the same as the errors which were encountered when trying out MSSQL #1493. Solve that one, and it's one step closer to just having the Laravel Db-Migration take care of the persisting to the data layer.

Sidenote:
I just had a slightly nasty DB issue, owning to myself sort of not paying attention to my webhosting for almost a year. Bad idea! Since the data in my BookStack instance is so critical, I spend a lot of energy trying to get it to work. My hunch is that this would have been a lot simpler on SQLite. And of course it would be much lighter to host.

@partoneoftwo commented on GitHub (Feb 3, 2020): Thanks for the thoughts. This does not seem like an unfeasible set of steps. **About the error messages:** Regarding the error messages listed in #617, to me do not seem severe. Curiously and interestingly the SQLite errors are the same as the errors which were encountered when trying out MSSQL #1493. Solve that one, and it's one step closer to just having the Laravel Db-Migration take care of the persisting to the data layer. **Sidenote:** I just had a slightly nasty DB issue, owning to myself sort of not paying attention to my webhosting for almost a year. Bad idea! Since the data in my BookStack instance is so critical, I spend a lot of energy trying to get it to work. My hunch is that this would have been a lot simpler on SQLite. And of course it would be much lighter to host.
Author
Owner

@RGdevz commented on GitHub (Jan 28, 2024):

+1

@RGdevz commented on GitHub (Jan 28, 2024): +1
Author
Owner

@Codefor4learn commented on GitHub (Apr 11, 2024):

May I ask if we are still considering supporting sqlite

@Codefor4learn commented on GitHub (Apr 11, 2024): May I ask if we are still considering supporting sqlite
Author
Owner

@mac641 commented on GitHub (Aug 1, 2024):

+1

@mac641 commented on GitHub (Aug 1, 2024): +1
Author
Owner

@virtadpt commented on GitHub (Aug 1, 2024):

Diversity in database back-ends is good.

@virtadpt commented on GitHub (Aug 1, 2024): Diversity in database back-ends is good.
Author
Owner

@Evan0000000000 commented on GitHub (Mar 18, 2025):

Would like to register my interest/support for this as well; sqlite support is probably the difference between being able to use this in my department and not (which is obnoxious, but remains the case)

(To be clear I've reviewed Dan's remarks in other threads about support burden vs implementation and so forth, but this thread seems to be open to upvote/support so I'm doing that)

@Evan0000000000 commented on GitHub (Mar 18, 2025): Would like to register my interest/support for this as well; sqlite support is probably the difference between being able to use this in my department and not (which is obnoxious, but remains the case) (To be clear I've reviewed Dan's remarks in other threads about support burden vs implementation and so forth, but this thread seems to be open to upvote/support so I'm doing that)
Author
Owner

@stinkbrain commented on GitHub (Mar 19, 2025):

I would also love to see sqlite support. I'm now using Bookstack for journaling, creative writing, sysadmin notes, and tracking the progress of an ongoing D&D campaign. Bookstack is fantastic for all of this stuff. However, the lack of a formal backup process is unsettling as I commit more content to the platform. Sqlite would make reliable backups as easy as an automated zip or rsync command.

I'm not in a position to contribute code but I can contribute some $ if that would help.

@stinkbrain commented on GitHub (Mar 19, 2025): I would also love to see sqlite support. I'm now using Bookstack for journaling, creative writing, sysadmin notes, and tracking the progress of an ongoing D&D campaign. Bookstack is fantastic for all of this stuff. However, the lack of a formal backup process is unsettling as I commit more content to the platform. Sqlite would make reliable backups as easy as an automated zip or rsync command. I'm not in a position to contribute code but I can contribute some $ if that would help.
Author
Owner

@AstroStucky commented on GitHub (Mar 19, 2025):

Just piling on the support for this because I would begin using BookStack right now on my home server if only it supported Sqlite. I hope the development time can be found to make this possible, and thank you BookStack contributors for your hard work. 🙏🏻

@AstroStucky commented on GitHub (Mar 19, 2025): Just piling on the support for this because I would begin using BookStack _right now_ on my home server if only it supported Sqlite. I hope the development time can be found to make this possible, and thank you BookStack contributors for your hard work. 🙏🏻
Author
Owner

@pcnate commented on GitHub (Apr 2, 2025):

since NodeJS 22.5.0, SQLite is built into node. Not saying bookstack can easily implement or that existing queries are compatible

@pcnate commented on GitHub (Apr 2, 2025): since NodeJS 22.5.0, [SQLite is built into node](https://nodejs.org/api/sqlite.html). Not saying bookstack can easily implement or that existing queries are compatible
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#311