Skip to main content

MySQL-based store for tiddlyweb

Project description

tiddlywebplugins.mysql3
=======================

_A plugin for [TiddlyWeb](http://tiddlyweb.com) subclassing
[tiddlywebplugins.sqlalchemy3](https://github.com/cdent/tiddlywebplugins.sqlalchemy)
with MySQL specifics._

The main additions to sqlalchemy3 are:

* Optionally extend the search interface using mysql's fulltext.
* Support finding tiddlers that have geo.lat and geo.long fields
near a location.

Setup
-----

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:

```
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', # optional
```

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 will be `MyISAM`.

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

See <http://tiddlyweb-sql.tiddlyspace.com/> for additional documentation and
assistance.

Thanks
------

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.

Source Distribution

tiddlywebplugins.mysql3-3.1.2.tar.gz (29.9 kB view details)

Uploaded Source

File details

Details for the file tiddlywebplugins.mysql3-3.1.2.tar.gz.

File metadata

File hashes

Hashes for tiddlywebplugins.mysql3-3.1.2.tar.gz
Algorithm Hash digest
SHA256 e38fb265a3557be33372b5c5b22330cb1f59bdf14105e44ec5531ec3310e3c34
MD5 cf4e3cd2e80c3b8203ca786ff05b436b
BLAKE2b-256 54f54023b9be7fa23a04d5598046262f2bc5b3549d11d7023f23507e12319146

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page