SQLite as an Application File Format
117 points
by gjvc
13 hours ago
| 19 comments
| sqlite.org
| HN
incanus77
4 hours ago
[-]
I did this for MBTiles, for storing (at the time, raster) map tiles at Mapbox. I was working on the iPad wing of R&D early in the company and we were focusing on offline mapping for the iPad. Problem was, moving lots of tiny map tiles (generally 256px square PNGs) was tedious over USB and network. We had a thing called Maps on a Stick for moving things around by USB, but it just didn’t scale well to the iPad interface & file transfer needs.

Bundled the tiles into SQLite (I was inspired by seeing Dr. Hipp speak at a conference) and voila, things both easy to move and to checksum. Tiles were identified by X & Y offset at a given (Z)oom level, which made for super easy indexing in a relational DB like SQLite. On the iPad, it was then easy to give map bundles an application icon, associated datatype from file extension, metadata in a table, etc. At the time, I was fairly intimidated by the idea of creating a file format, but databases, I knew. And then making some CLI tools for working with the files in any language was trivial after that.

reply
jeffypoo
4 hours ago
[-]
absolutely adore the mbtiles format! thank you for creating that.
reply
joelwallis
5 hours ago
[-]
SQLite is abolutely amazing as an app format! I couldn't list how many tools are available to read SQLite data, or how easy and friendly they are. Even its CLI does wonders when you're dealing with data with it. SQLite has been around for 20+ years and is one of the most heavily tested softwares in the world.

SQLite is very simple, yet very reliable and powerful. Using SQLite as file format might be the best decision an engineer can take when it comes to future-proofing preservation of data.

reply
renegat0x0
6 hours ago
[-]
I think I use SQLite like that (to some extent):

- https://github.com/rumca-js/Internet-Places-Database

For UI I use HTML, because it already provides components with bootrap, and everybody can use it without installation of any software.

All data comes from a single SQLite that is easy read, and returns data.

My database is really big, so it takes time to browse it, I wanted to provide more meaningful way to limit scope of searching

reply
scary-size
5 hours ago
[-]
Actually used it for a desktop blogging app a few years ago. It was great! I could set up a blog skeleton, send the file to a family member. They could focus on writing content and hitting deploy.

https://blog.project-daily.com/pages/file-format_3705.html

reply
stavarotti
9 hours ago
[-]
reply
ianberdin
48 minutes ago
[-]
Sold. Absolutely.

I always wonder when people can sell ideas or products so effectively.

reply
kianN
5 hours ago
[-]
This approach has really helped me out in my work. I do something very similar using DuckDB to slurp output files anytime I write a custom hierarchical model. The single sql queryable file simplified my storage and analytics pipeline. I imagine SQLite would be especially ideal where long term data preservation is critical.
reply
spdegabrielle
4 hours ago
[-]
I think the developers had the same idea https://fossil-scm.org/
reply
lateforwork
4 hours ago
[-]
Most application's file formats are structured as a tree, not as flat tables. If your application's data is flat tables or name-value pairs then SQLite is an obvious choice. But if it is tree structured then it is less obvious. You can still save your tree in JSON format as a blob in a SQLite table but in this case the benefits are fewer. But if in addition to the JSON you have images or other binary data then once again SQLite offers benefits, because each of those binary files can be additional rows in the SQLite table. This is far easier to handle than storing them in ZIP format.
reply
packetlost
4 hours ago
[-]
Maybe not as obvious for those without formal education in """database normalization""" but it's pretty trivial to convert from a tree structure to a flat table structure using foreign key relations. Recursive queries aren't even that difficult in SQLite, so self-referential data can be represented cleanly too, if not a bit more difficult to write. IME most applications "tree structures" aren't self-referential and are better formalized as distinct entities with one-to-one relationships (ie. a subtree gets a table).

There's always the lazy approach of storing JSON blobs in TEXT fields, but I personally shy away from that because you lose out on a huge part of the benefits of using a SQL DB in the first place, most importantly migrations and querying/indexing.

reply
somat
4 hours ago
[-]
I am not really classically trained on the subject but I think this is the idea behind relational storage, it is to have better extraction options, you don't have to treat your data as a single document at a time.

Naively, most data looks hierarchical and the instinctive reaction is to make your file format match. But if you think of this as a set of documents stacked on top of each other if you take the data as a bunch of 90 degree slices down through the stack now your data is relational, you loose the nice native hierarchical format, but you gain all sorts of interesting analysis and extraction options.

It is too bad relational data types tend to be so poorly represented in our programming languages, generally everything has to be mapped back to a hierarchical type.

reply
robrenaud
4 hours ago
[-]
I had some json data that I wanted an annotation interface for. So I asked codex to put it into sqlite and make a little annotation webserver. It worked quickly/easily and without hassle. Sqlite supports queries over json-like objects.

Maybe a very simple document oriented db would have been better?

My biggest gripe is that the sqlite cli is brutally minimal (makes sense given design), but I probably should have been using a nicer cli.

reply
fauigerzigerk
3 hours ago
[-]
What do you mean by "json-like objects"?

My issue with SQLite's JSON implementation is that it cannot index arrays. SQLite indexes can only contain a single value per row (except for fulltext indexes but that's not what I want most of the time). SQLite has nothing like GIN indexes in Postgres.

reply
elephantum
4 hours ago
[-]
You do know, that you can create more than one table in SQLite and have references from one to another? Even recursive references work
reply
SoKamil
1 hour ago
[-]
I remember when I was a child I used to open WinRAR and try to open random files in games and programs to find some „hidden” assets.
reply
abhashanand1501
5 hours ago
[-]
We are developing using sqlite to transfer configurations from uat to production environment. Since the configurations are already saved in a postgres table in uat, moving some configs from uat to production an sqlite file is very easy. since it's a binary format, we are also saved from any inadvertent edits by people doing production deployment.

Also, another usecase is to export data from production to uat for testing some scenarios, it can be easily encoded in a sqlite file.

reply
ejstembler
4 hours ago
[-]
The Acorn macOS app uses SQLite in a similar way: https://flyingmeat.com/acorn/docs/technotes/ACTN002.html
reply
itopaloglu83
3 hours ago
[-]
Recently reverse engineered the Money Pro backup format, it's a binary file with SQLite with some additional XML information backed in. It feels like they're purposefully making it harder for users to export their data in a useful format, especially after the changes they made to their financial model.
reply
incanus77
3 hours ago
[-]
Yes! Gus (the developer) also has made & maintained FMDB for many years, a nice Cocoa wrapper for the SQLite bindings.

https://github.com/ccgus/fmdb

reply
jansommer
5 hours ago
[-]
Something to consider when using SQLite as a file format is compression (correct me if I'm wrong!). You might end up with a large file unless you consider this, and can't/won't just gz the entire db. Nothing is compressed by default.
reply
lateforwork
5 hours ago
[-]
It can be compressed, see https://sqlite.org/sqlar.html
reply
nh2
3 hours ago
[-]
Please do not use second resolution mtime (cannot represent the high accuracy mtime that modern OSs use, so packing and unpacking , or causes differences eg in rsync), or build anything new using DEFLATE (it is slow and cannot really be made fast).
reply
jansommer
4 hours ago
[-]
Archive Files is for blobs as far as I understand. All your other data remains uncompressed?
reply
euroderf
4 hours ago
[-]
There seems to be no single software solution "out there" for mounting an SQLite DB (or an SQLite archive) as a file system, with or without per-record relative paths.
reply
forgotpwd16
4 hours ago
[-]
There's FUSE-using Sqlitefs & WebDAV-using Wddbfs.
reply
euroderf
2 hours ago
[-]
FUSE on Mac seems to be a kernel/permissions mess.
reply
spdegabrielle
4 hours ago
[-]
Is there a software solution to mounting any DB as a filesystem?
reply
rtyu1120
6 hours ago
[-]
Bit unrelated rant but I'm still not sure why ZIP has been adopted as an Application File Format rather than anything else. It is a remanent of a DOS era with questionable choices, why would you pick it over anything else?
reply
amiga386
6 hours ago
[-]
- archiver format to stow multiple files in one; your actual files (in your choice of format(s)) go inside

- files can be individually extracted, in any order, from the archive

- thousands of implementations available, in every language and every architecture. no more than 32KiB RAM needed for decompression

- absolutely no possibility of patent challenges

reply
HelloNurse
5 hours ago
[-]
Also architecturally suitable for the common case of collecting heterogeneous files in existing and new formats into a single file, as opposed to designing a database schema or a complex container structure from scratch.

Any multi-file archive format would do, but ZIP is very portable and random access.

reply
crazygringo
5 hours ago
[-]
If all you need is a bag of named blobs and you just want quick reasonable compression supported across all platforms, why not?

If you don't need any table/relational data and are always happy to rewrite the entire file on every save, ZIP is a perfectly fine choice.

It's easier than e.g. a SQLite file with a bunch of individually gzipped blobs.

reply
tetraca
6 hours ago
[-]
Because Windows can view and extract them out of the box without installing any additional applications. If it supported anything better out of the box I'd guess people would use that instead.
reply
lvh
6 hours ago
[-]
"The operating system makes it easy to mess with" doesn't seem like a particularly useful property for application file formats.
reply
TeMPOraL
5 hours ago
[-]
It was, back when software development was run by hackers and not suits and security people. Easy access was a feature for users, too; back in those days, software was a tool that worked on data, it didn't try to own the data.
reply
dahart
4 hours ago
[-]
ZIP isn’t an application format, it’s a container, no? You store files with any format in a .zip, and that’s what applications do - they read files with other formats out of the .zip. What are your goals; what else would you pick, and why? What are the questionable choices you refer to?
reply
amiga386
4 hours ago
[-]
I suspect he means the choices of putting the central directory headers at the end of the file, as well as having local file headers as you read through the file, which allows for ambiguity.

Alternatively, he could mean that, for the purposes of archiving, ZIP is very far behind the state of the art (no solid compression, old algorithms, small windows, file size limits without the ZIP64 extensions, and so on, most of which are not relevant to using ZIP as a container format)

reply
dahart
2 hours ago
[-]
Thanks, makes sense. Are the headers even an issue when using ZIP as a container? Are there superior alternatives in practice?

I’ve reached for ZIP for application containers because it’s really easy, not because of design choices that affect me. Typically the compression is a convenient byproduct but not a requirement, and file size limits could be an issue, perhaps, but isn’t something I’ve ever hit when using ZIP for application data. File size limits is something I’ve hit when trying to archive lots of files.

Using ZIP for build pipelines that produce a large number of small files is handy since it’s often faster than direct file I/O, even on SSDs. In the past was much faster than spinning media, especially DVDs. These days in Python you can unzip to RAM and treat it like a small file system - and for that file size limits aren’t an issue in practice.

reply
thijson
4 hours ago
[-]
AMD/Xilinx Vivado uses ZIP format to compress design checkpoints. They just give them a .dcp extension though.
reply
mikkupikku
6 hours ago
[-]
It works well enough. What could, for instance, epubs gain by having another base format instead?
reply
gus_massa
6 hours ago
[-]
I think most format use "gzip" instead of "zip".
reply
johannes1234321
4 hours ago
[-]
gzip and tar+gzip aren't good options for application data compared to zip.

zip is used for Java jar files, OpenOffice documents and other cases.

The benefit is that individual files in the archive can be acces individually. A tgz file is a stream which can (without extra trickery) only be extracted from begin to end with no seeking to a specific record and no way to easily replace a single file without rewriting everything.

tgz is good enough for distributing packages which are supposed to be extracted at once (a software distribution)

reply
conradludgate
5 hours ago
[-]
gzip is not an archive container. You're thinking of .tar.gz which is a "tape archive" format which is compressed using gzip. Zip is by itself both a compression and an archive format, and is what documents like epub or docx use
reply
gus_massa
5 hours ago
[-]
You are right, but other documents like .ggb (GeoGebra files) or .mbz (Moodle backups) use the .tar.gz method. I even wrote programs to opened them, make a few tweaks and save the new version in another compatible file.
reply
psnehanshu
5 hours ago
[-]
I see no downside in using sqlite as an application file format.
reply
seanalltogether
5 hours ago
[-]
I remember someone mentioning the Acorn image editor on Mac uses sql files to store image data. It probably makes backwards compatibility much easier to work with.
reply
dchest
5 hours ago
[-]
It does, here's a schema from an image I just saved with the latest version. Pretty simple.

  CREATE TABLE image_attributes ( name text, value blob);
  CREATE TABLE layers (id text, parent_id text, sequence integer, uti text, name text, data blob);
  CREATE TABLE layer_attributes ( id text, name text, value blob);
Also, document-based apps that use Apple's Core Data framework (kinda ORM) usually use SQLite files for storage.
reply
setr
4 hours ago
[-]
Messages uses it too on Mac; was using it to do some convoluted text search on my history
reply
dchest
27 minutes ago
[-]
Not as an application file format discussed in the link, though. Lots of software use it as a database (as intended) it's also a base for Apple's Core Data.
reply
jrochkind1
7 hours ago
[-]
Searched for this topic:

> and is backwards compatible to its inception in 2004 and which promises to continue to be compatible in decades to come.

That is pretty amazing. You could do a lot worse.

reply
dist-epoch
7 hours ago
[-]
Same as .zip, .xml, .json and many others.

Doesn't mean that whatever the app stores inside will remain backward compatible which is the harder problem to solve.

reply
QuadrupleA
6 hours ago
[-]
Still helpful!
reply
born-jre
4 hours ago
[-]
i am taking it to new new extreme > https://github.com/blue-monads/potatoverse
reply
actionfromafar
4 hours ago
[-]
Planning on putting a license on it? I habitually ignore repos without a LICENSE file in them.
reply
born-jre
3 hours ago
[-]
oh yeah, added now
reply
askl
6 hours ago
[-]
Somehow my first thought from the title was using sqlite as a format for applications. So like a replacement for ELF. I think this idea is both fascinating and horrifying.
reply
trws
6 hours ago
[-]
I worked @fzakaria on developing that idea. It actually worked surprisingly well. The benefits are mostly in the ability to analyze the binary afterward though rather than any measurable benefit in load time or anything like that though. I don’t have the repo for the musl-based loader handy, but here’s the one for the virtual table plugin for SQLite to read from raw ELF files: https://github.com/fzakaria/sqlelf
reply
giancarlostoro
5 hours ago
[-]
Forget elf, imagine having a SQLite file that stores elf, exe and DMG binaries. I would not mind working on something like this.
reply
actionfromafar
4 hours ago
[-]
Not that at all, but interesting in its own right - https://pypi.org/project/sqlelf/ explore ELF via SQL.
reply
yread
5 hours ago
[-]
Or a replacement for Access
reply
actionfromafar
3 hours ago
[-]
reply
gjvc
6 hours ago
[-]
wonder if this would make hot-swap functions easier, if every function had its own section and every section was in the db
reply
kstrauser
5 hours ago
[-]
I think we could call it Library Internal Sequel Procedures.
reply