Skip to main content

MySQL-based store for tiddlyweb

Project description

A plugin for TiddlyWeb subclassing tiddlywebplugins.sqlalchemy3 with mysql specifics.

The main additions to sqlalchemy3 are:

* Optionally provide a reasonable search interface using mysql's fulltext.
* Provide field based searches of tiddler attributes and fields.
* Support finding tiddlers that have geo.lat and geo.long fields
near a location.
* Provide an index_query method to allow the plugin to be used as
an 'indexer' for filters and determine_bag_for_tiddler.

NOTES

MySQL 5.5 or beyond is required for full Unicode support.

It is important to set some mysql my.cnf variables if you are using
the fulltext indexing otherwise searches will likely fail.

[mysqld]
ft_min_word_len = 3
ft_stopword_file = ''

You will need to create a database. I use one called 'tiddlyweb':

create database tiddlyweb \
character set = utf8mb4 \
collate = utf8mb4_bin;

Make sure you GRANT appropriate PRIVILEGES on the database.

Add the following to tiddlywebconfig.py:

'server_store': ['tiddlywebplugins.mysql', {
'db_config': 'mysql:///tiddlyweb?charset=utf8mb4'}],
'indexer': 'tiddlywebplugins.mysql',

If you want to use the fulltext indexing capability you will need to
create the fulltext index:

CREATE FULLTEXT INDEX tiddlytext ON text(text);

Also set 'mysql.fulltext' to True in tiddlywebconfig.py. This makes
sure the text table is MyISAM.

Note that even if fulltext is not turned on, text searches will still
work, but not as flexibly.

Thanks to Adrian Hosey <http://adrianhosey.blogspot.com/> for help over
some SQL humps.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tiddlywebplugins.mysql3, version 3.0.13
Filename, size File type Python version Upload date Hashes
Filename, size tiddlywebplugins.mysql3-3.0.13.tar.gz (33.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page