https://github.com/fukuchi/omeka-s-module-mroonga-search
Omeka S module enabling Mroonga engine for CJK-ready full-text search.
https://github.com/fukuchi/omeka-s-module-mroonga-search
Last synced: 11 months ago
JSON representation
Omeka S module enabling Mroonga engine for CJK-ready full-text search.
- Host: GitHub
- URL: https://github.com/fukuchi/omeka-s-module-mroonga-search
- Owner: fukuchi
- License: mit
- Created: 2020-02-07T04:14:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-23T15:02:23.000Z (almost 5 years ago)
- Last Synced: 2025-03-24T14:46:27.993Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 17.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Mroonga search (module for Omeka S)
===================================
Mroonga search is a module for [Omeka S](https://omeka.org/s/) that enables
CJK-ready full-text search by activating the [Mroonga](https://mroonga.org/)
plugin of MySQL or MariaDB.
The default installation of the full-text search feature of the Omeka S is not
CJK (Chinese, Japanese, Korean) ready because of the limitation of the database
engine (MySQL or MariaDB). The Mroonga plugin extends the database to achieve
CJK-ready search. This module simply activates this plugin by modifying the
table information that used by Omeka S.
Installation
------------
### Preparation
First of all, **back up your database**. This module modifies the table schema,
and that may cause unrecoverable failure.
Before installing this module, install and configure the Mroonga plugin to
enable the Mroonga storage engine. For example, if you use MariaDB on Debian or
Ubuntu machine, install 'mariadb-plugin-mroonga' package. Please read the
[official document](https://mroonga.org/docs/install.html) for further
information.
### From ZIP
See the [release page](https://github.com/fukuchi/Omeka-S-module-mroonga-search/releases)
and download the latest `MroongaSearch.zip` from the list. Then unzip it in the
`modules` directory of Omeka S, then enable the module from the admin
dashboard. Read the
[user manual of Omeka S](https://omeka.org/s/docs/user-manual/modules/)
for further information.
### From GitHub
Please do not forget to rename the directory from `Omeka-S-mroonga-search` to
`MroongaSearch` in the `modules` directory.
### Configuration
No configuration is needed. Once installed, the database will be updated,
enabling full-text search.
### Uninstall
Simply uninstall this module to remove Mroonga settings from your database.
No additional work is needed.
Notes
-----
This module highly depends on the database structure of Omeka S 3.x. If you are
upgrading Omeka S from 3.x to 4.x or later, we highly recommend you uninstall
this module **before upgrading**.
We have not heavily tested the Mroonga engine with large-sized data yet. For
an advanced full-text search, we recommend that you check the
[Solr module](https://omeka.org/s/modules/Solr/).
Currently, this module uses the default N-gram parser. MeCab or any parsers are
not supported yet.
### Technical note
MroongaSearch module changes the storage engine of the fulltext\_search table
of your Omeka S instance from InnoDB to Mroonga. This enables CJK-friendly fast
full-text search while it increases the size of the database.
TODOs
-----
* Enabling synonyms
Licensing information
---------------------
Copyright (c) 2020, 2021 Kentaro Fukuchi
This module is released under the MIT License. See the `LICENSE` file for the
details.