Giter Club home page Giter Club logo

omeka-s-module-mroonga-search's Introduction

Mroonga search (module for Omeka S)

Mroonga search is a module for Omeka S that enables CJK-ready full-text search by activating the Mroonga 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 for further information.

From ZIP

See the release page 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 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.

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.

omeka-s-module-mroonga-search's People

Contributors

fukuchi avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.