Optimize Datasette performance behind a caching proxy
When you open a database file in immutable mode using the
-i option, Datasette calculates a SHA-256 hash of the contents of that file on startup.
This content hash can then optionally be used to create URLs that are guaranteed to change if the contents of the file changes in the future.
The result is pages that can be cached indefinitely by both browsers and caching proxies - providing a significant performance boost.
A demo of this plugin is running at https://datasette-hashed-urls.vercel.app/
Install this plugin in the same environment as Datasette.
$ datasette install datasette-hashed-urls
Once installed, this plugin will act on any immutable database files that are loaded into Datasette:
datasette -i fixtures.db
The database will automatically be renamed to incorporate a hash of the contents of the SQLite file - so the above database would be served as:
Every page that accesss that database, including JSON endpoints, will be served with the following far-future cache expiry header:
cache-control: max-age=31536000, public
max-age=31536000 is the number of seconds in a year.
A caching proxy such as Cloudflare can then be used to cache and accelerate content served by Datasette.
When the database file is updated and the server is restarted, the hash will change and content will be served from a new URL. Any hits to the previous hashed URLs will be automatically redirected.
If you run Datasette using the
--crossdb option to enable cross-database queries the
_memory database will also have a hash added to its URL - in this case, the hash will be a combination of the hashes of the other attached databases.
You can use the
max_age plugin configuration setting to change the cache duration specified in the
cache-control HTTP header.
To set the cache expiry time to one hour you would add this to your Datasette
metadata.json configuration file:
This functionality used to ship as part of Datasette itself, as a feature called Hashed URL mode.
That feature has been deprecated and will be removed in Datasette 1.0. This plugin should be used as an alternative.
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
python3 -mvenv venv
Or if you are using
Now install the dependencies and test dependencies:
pip install -e '.[test]'
To run the tests: