Mroonga

For the release history: News

• 1. The characteristics of Mroonga
  • 1.1. What is Mroonga?
  • 1.2. The successor of Tritonn
  • 1.3. Running as a MySQL plugin
  • 1.4. Faster index update
  • 1.5. Faster search
  • 1.6. Geolocation search
  • 1.7. Sharing the same Groonga storage
  • 1.8. Associate with other storage engines
  • 1.9. Supported platforms
• 2. Install
  • 2.1. Windows
    • 2.1.1. Zip
    • 2.1.2. Build from source with MariaDB
  • 2.2. macOS
    • 2.2.1. Homebrew
  • 2.3. Debian GNU/Linux
    • 2.3.1. bookworm (MariaDB)
    • 2.3.2. bookworm (with the Oracle MySQL 8.0 package)
  • 2.4. Ubuntu
    • 2.4.1. PPA (Personal Package Archive)
  • 2.5. AlmaLinux
    • 2.5.1. AlmaLinux 8 (with the Oracle MySQL 8.0 package)
    • 2.5.2. AlmaLinux 8 (with Percona Server 8.0 package)
    • 2.5.3. AlmaLinux 8 (with MariaDB 10.5 package)
    • 2.5.4. AlmaLinux 8 (with MariaDB 10.6 package)
    • 2.5.5. AlmaLinux 8 (with MariaDB 10.11 package)
    • 2.5.6. AlmaLinux 9 (with the Oracle MySQL 8.0 package)
    • 2.5.7. AlmaLinux 9 (with Percona Server 8.0 package)
    • 2.5.8. AlmaLinux 9 (with MariaDB 10.5 package)
    • 2.5.9. AlmaLinux 9 (with MariaDB 10.6 package)
    • 2.5.10. AlmaLinux 9 (with MariaDB 10.11 package)
  • 2.6. Oracle Linux
    • 2.6.1. Oracle Linux 8 (with the Oracle MySQL 8.0 package)
  • 2.7. Fedora
    • 2.7.1. Fedora 21
  • 2.8. Docker
  • 2.9. Others
    • 2.9.1. Dependencies
    • 2.9.2. Build from source
• 3. Upgrade
• 4. Tutorial
  • 4.1. Installation check
  • 4.2. Mode
  • 4.3. Storage mode
    • 4.3.1. How to use full text search
    • 4.3.2. How to get search score
    • 4.3.3. How to specify the parser for full text search
    • 4.3.4. How to specify the normalizer
    • 4.3.5. How to specify the token filters
    • 4.3.6. How to specify Groonga’s column flags
    • 4.3.7. How to use geolocation search
    • 4.3.8. How to get the record ID
    • 4.3.9. How to get snippet (Keyword in context)
    • 4.3.10. How to use similar search
    • 4.3.11. How to run Groonga command
    • 4.3.12. How to search by regular expression
    • 4.3.13. Logging
    • 4.3.14. Next step
  • 4.4. Wrapper mode
    • 4.4.1. How to use wrapper mode
    • 4.4.2. How to use full text search
    • 4.4.3. How to get search score
    • 4.4.4. How to specify the parser for full text search
    • 4.4.5. How to specify the normalizer
    • 4.4.6. How to get snippet (Keyword in context)
    • 4.4.7. Logging
    • 4.4.8. Next step
• 5. Reference
  • 5.1. Optimizations
    • 5.1.1. Fetching only needed columns
    • 5.1.2. Row count
    • 5.1.3. ORDER BY LIMIT
  • 5.2. SQL commands
    • 5.2.1. List of available SQL commands
    • 5.2.2. List of unavailable SQL commands
    • 5.2.3. I found an unlisted SQL command
  • 5.3. Server variables
    • 5.3.1. mroonga_action_on_fulltext_query_error
    • 5.3.2. mroonga_boolean_mode_syntax_flags
    • 5.3.3. mroonga_database_path_prefix
    • 5.3.4. mroonga_default_parser
    • 5.3.5. mroonga_default_tokenizer
    • 5.3.6. mroonga_default_wrapper_engine
    • 5.3.7. mroonga_dry_write
    • 5.3.8. mroonga_enable_optimization
    • 5.3.9. mroonga_libgroonga_support_lz4
    • 5.3.10. mroonga_libgroonga_support_zlib
    • 5.3.11. mroonga_libgroonga_support_zstd
    • 5.3.12. mroonga_libgroonga_support_mecab
    • 5.3.13. mroonga_libgroonga_version
    • 5.3.14. mroonga_lock_timeout
    • 5.3.15. mroonga_log_file
    • 5.3.16. mroonga_log_level
    • 5.3.17. mroonga_query_log_file
    • 5.3.18. mroonga_match_escalation_threshold
    • 5.3.19. mroonga_max_n_records_for_estimate
    • 5.3.20. mroonga_enable_operations_recording
    • 5.3.21. mroonga_vector_column_delimiter
    • 5.3.22. mroonga_version
    • 5.3.23. mroonga_condition_push_down_type
  • 5.4. Status variables
    • 5.4.1. Mroonga_count_skip
    • 5.4.2. Mroonga_fast_order_limit
    • 5.4.3. Mroonga_condition_push_down
    • 5.4.4. Mroonga_n_pooling_contexts
    • 5.4.5. Mroonga_memory_map_size
  • 5.5. UDF (User Defined Functions)
    • 5.5.1. mroonga_command()
    • 5.5.2. mroonga_escape()
    • 5.5.3. mroonga_highlight_html()
    • 5.5.4. mroonga_last_insert_grn_id()
    • 5.5.5. mroonga_normalize()
    • 5.5.6. mroonga_snippet()
    • 5.5.7. mroonga_snippet_html()
  • 5.6. Limitations
    • 5.6.1. Limitations of table
    • 5.6.2. Limitations of indexing
    • 5.6.3. Limitations about the value of columns
    • 5.6.4. Limitations of column size
  • 5.7. Full text search
    • 5.7.1. Boolean mode
    • 5.7.2. Search and Scoring in Mroonga
• 6. FAQ
  • 6.1. How to avoid “mmap Cannot allocate memory” error?
    • 6.1.1. Short answer
    • 6.1.2. Long answer
• 7. Community
  • 7.1. Mailing List
  • 7.2. Chat room
  • 7.3. Twitter
  • 7.4. Facebook
• 8. How to contribute to Mroonga
  • 8.1. How to report a bug
    • 8.1.1. Submit a bug to the issue tracker
    • 8.1.2. Report a bug with the other ways
  • 8.2. How to collect data for reporting a reproducible bug
  • 8.3. How to contribute in documentation topics
    • 8.3.1. The things you must do at first
    • 8.3.2. The things you need to do every tasks
    • 8.3.3. The things you need to do every files
• 9. Developer’s guide
  • 9.1. How to debug
    • 9.1.1. Building for debugging
    • 9.1.2. More about run-sql-test.sh
  • 9.2. Release procedure
    • 9.2.1. Requirements
    • 9.2.2. Setup build environment
    • 9.2.3. Describe the changes
    • 9.2.4. Check whether you can upload packages
    • 9.2.5. Execute make update-latest-release
    • 9.2.6. Confirm the results of each test
    • 9.2.7. Tagging for release
    • 9.2.8. Upload archive files
    • 9.2.9. Create packages for the release
    • 9.2.10. Update Docker images
    • 9.2.11. Upload documents
    • 9.2.12. Update blog(Mroonga blog)
    • 9.2.13. Announce release for mailing list
    • 9.2.14. Announce release for twitter
    • 9.2.15. Announce release for Facebook
    • 9.2.16. Bump version
  • 9.3. コーディングスタイル
    • 9.3.1. 言語
    • 9.3.2. ファイル名
    • 9.3.3. 名前空間
    • 9.3.4. include ガード
    • 9.3.5. 代入
    • 9.3.6. 文字列
    • 9.3.7. バッファ
    • 9.3.8. 命名規則
    • 9.3.9. コピーコンストラクター
    • 9.3.10. クラスの代入
    • 9.3.11. 引数
    • 9.3.12. 定数
    • 9.3.13. 真偽値
    • 9.3.14. 条件式
    • 9.3.15. 初期化
    • 9.3.16. インクリメント・デクリメント
    • 9.3.17. キャスト
    • 9.3.18. 変数宣言
    • 9.3.19. その他
    • 9.3.20. メモ
  • 9.4. How we are developing
  • 9.5. Roadmap
  • 9.6. Source code management
  • 9.7. Development process
  • 9.8. Development environment
  • 9.9. Contents of the source tree
  • 9.10. Adding and running tests
  • 9.11. Adding and updating documents

Indices

• Index

• Module Index

• Search Page