folioci/mod-search

FOLIO - mod-search

镜像概述

mod-search是FOLIO图书馆服务平台的核心搜索模块，提供数据索引和搜索查询功能。该模块通过Kafka消费inventory（实例、holdings记录、项目等）和authorities数据事件，将数据索引至Elasticsearch，并响应搜索查询请求。代码仓库：https://github.com/folio-org/mod-search

核心功能与特性

核心功能

• Kafka事件处理：消费inventory（instance、holdings-record、item等）和authorities主题事件，实现数据变更同步
• Elasticsearch索引管理：将消费的事件数据构建为搜索索引，支持索引重建、延迟索引和批量处理
• 搜索查询服务：处理搜索请求，支持主题、贡献者、分类和索书号等多维度浏览与检索
• 多源数据整合：整合inventory和authorities数据，提供统一的搜索入口

关键特性

• 支持Kafka事件并发消费，可配置消费线程数和拉取参数
• 提供Elasticsearch索引压缩、数据格式优化等性能调优选项
• 支持全字段搜索与定向字段搜索，可配置浏览功能开关
• 内置索引重建机制，支持范围索引和记录级重建

使用场景

适用于FOLIO图书馆服务平台中各类资源的搜索场景，包括：

• 图书馆馆藏资源（实例、holdings、item）检索
• 规范数据（authorities）查询
• 主题、贡献者、分类及索书号等维度的资源浏览
• 大规模馆藏数据的增量索引与实时搜索

核心配置参数

基础配置

Kafka配置

连接与安全配置

事件消费配置

性能调优配置

Elasticsearch配置

索引与搜索配置

使用方法

Docker Run部署示例

bash
docker run -d \
  --name mod-search \
  -p 8081:8081 \
  -e MODULE_PORT=8081 \
  -e KAFKA_HOST=kafka \
  -e KAFKA_PORT=9092 \
  -e ELASTICSEARCH_URL=http://elasticsearch:9200 \
  -e ELASTICSEARCH_USERNAME=elastic \
  -e ELASTICSEARCH_PASSWORD=your_es_password \
  -e DB_HOST=postgres \
  -e DB_PORT=5432 \
  -e DB_NAME=folio \
  -e DB_USER=folio_user \
  -e DB_PASSWORD=folio_password \
  folio/mod-search

Docker Compose配置示例

yaml
version: '3'
services:
  mod-search:
    image: folio/mod-search
    ports:
      - "8081:8081"
    environment:
      - MODULE_PORT=8081
      - Container memory=1073741824
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=85.0
      - ENV=folio
      - KAFKA_HOST=kafka
      - KAFKA_PORT=9092
      - KAFKA_SECURITY_PROTOCOL=PLAINTEXT
      - ELASTICSEARCH_URL=http://elasticsearch:9200
      - ELASTICSEARCH_USERNAME=elastic
      - ELASTICSEARCH_PASSWORD=your_es_password
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=folio
      - DB_USER=folio_user
      - DB_PASSWORD=folio_password
    depends_on:
      - kafka
      - elasticsearch
      - postgres

注意事项

1. 部署前需确保Kafka、Elasticsearch和数据库服务已就绪，并正确配置连接参数
2. 根据数据量调整KAFKA_EVENTS_CONCURRENCY、KAFKA_CONSUMER_EVENTS_MAX_POLL_RECORDS等性能参数
3. 首次启动时建议检查Kafka主题是否存在，必要时手动创建匹配KAFKA_EVENTS_CONSUMER_PATTERN的主题
4. Elasticsearch索引需提前配置合适的分片和副本策略，以保障搜索性能