Skip to main content
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.

Release files for tiddlywebplugins.mysql3 3.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tiddlywebplugins.mysql3 3.1.2
File Size Uploaded
tiddlywebplugins.mysql3-3.1.2.tar.gz 29.9 kB Details

Release files / tiddlywebplugins.mysql3-3.1.2.tar.gz

Download URL tiddlywebplugins.mysql3-3.1.2.tar.gz
Size 29.9 kB
Tags Source
SHA-256 checksum
How to use checksums
e38fb265a3557be33372b5c5b22330cb1f59bdf14105e44ec5531ec3310e3c34
BLAKE2b-256 checksum
How to use checksums
54f54023b9be7fa23a04d5598046262f2bc5b3549d11d7023f23507e12319146
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

3.1.2 This release

1 release file

3.1.1

1 release file

3.1.0

1 release file

3.0.13

1 release file

3.0.12

1 release file

3.0.11

1 release file

3.0.10

1 release file

3.0.9

1 release file

3.0.8

1 release file

3.0.7

1 release file

3.0.6

1 release file

3.0.5

1 release file

3.0.4

1 release file

3.0.3

1 release file

3.0.2

1 release file

3.0.1

1 release file

3.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page