設定
MygramDBはYAMLまたはJSON形式の設定ファイルを使用します。
設定例
# MySQL接続
mysql:
host: "127.0.0.1"
port: 3306
user: "repl_user"
password: "your_password"
database: "mydb"
datetime_timezone: "+09:00" # 日本標準時
# インデックス対象テーブル
tables:
- name: "articles"
text_source:
column: "content"
filters:
- name: "status"
type: "int"
- name: "category_id"
type: "int"
ngram_size: 2
- name: "products"
text_source:
column: "description"
ngram_size: 2
# APIサーバー
api:
tcp:
port: 11016
max_connections: 10000
http:
enable: true
port: 8080
# メモリ管理
memory:
hard_limit_mb: 8192
soft_target_mb: 4096
verify_text: "off" # "off"、"ascii"、"all"
# シノニム辞書（v1.6.0以降）
synonyms:
enable: false
file: "/etc/mygramdb/synonyms.tsv"
# 永続化
dump:
dir: "/var/lib/mygramdb/dumps"
interval_sec: 3600
retain: 3
# ログ
logging:
level: "info"
format: "text"MySQL / MariaDB接続
MygramDBは MySQL 8.4/9.x と MariaDB 10.6+/11.x の両方に対応します。設定ファイルは同じ mysql セクションを使用し、SELECT VERSION() からサーバーの種別を自動判定して、適切なGTID形式（MySQLはUUIDベース、MariaDBは domain-server-sequence）に切り替えます。
mysql:
host: "127.0.0.1"
port: 3306
user: "repl_user"
password: "your_password"
database: "mydb"必要な権限
GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'repl_user'@'%';
FLUSH PRIVILEGES;サーバー要件
IMPORTANT
これらの設定はMygramDBの動作に必須です。設定がない場合、レプリケーションが失敗します。
# my.cnf (MySQL 8.4/9.x または MariaDB 10.6+/11.x)
gtid_mode = ON # MySQL
enforce_gtid_consistency = ON # MySQL
binlog_format = ROW
binlog_row_image = FULLMariaDBではGTIDがデフォルトで有効（gtid_domain_id + server_id）であり、gtid_mode/enforce_gtid_consistency は不要です。binlog_format = ROW と binlog_row_image = FULL のみ確認してください。
テーブル設定
インデックス対象の各テーブル：
tables:
- name: "articles" # テーブル名
text_source:
column: "content" # 検索対象カラム
primary_key: "id" # プライマリキー（デフォルト: "id"）
ngram_size: 2 # CJK向けN-gramサイズ（デフォルト: 2）
filters: # フィルタ用カラム
- name: "status"
type: "int"
- name: "user_id"
type: "int"
- name: "created_at"
type: "datetime"フィルタ型
| 型 | 説明 |
|---|---|
int | 32ビット整数 |
bigint | 64ビット整数 |
string | テキスト値 |
datetime | 日時値 |
date | 日付値 |
APIサーバー
api:
tcp:
bind: "127.0.0.1" # TCPバインドアドレス
port: 11016 # TCPプロトコルポート
max_connections: 10000 # 最大同時接続数
http:
enable: true # HTTP APIを有効化
bind: "127.0.0.1" # HTTPバインドアドレス
port: 8080 # HTTP APIポートメモリ管理
memory:
hard_limit_mb: 8192 # ハードメモリ上限（MB）
soft_target_mb: 4096 # ソフトメモリ目標（MB）
verify_text: "off" # N-gramポストフィルタ検証verify_text — N-gram偽陽性を排除するため、保存テキストと照合して結果を検証:
| 値 | 動作 | メモリ |
|---|---|---|
off | 検証なし（デフォルト） | 約740MB / 100万件 |
ascii | ASCIIクエリのみ検証 | 中程度 |
all | 全クエリを検証 | 約2.3GB / 100万件 |
詳細は設定ガイドを参照。
永続化（スナップショット）
dump:
dir: "/var/lib/mygramdb/dumps"
interval_sec: 3600 # 自動保存間隔（0 = 無効）
retain: 3 # 保持するスナップショット数クエリキャッシュ
cache:
enabled: true
max_memory_mb: 32 # 最大キャッシュメモリ（MB）
ttl_seconds: 3600 # キャッシュTTL（秒）シノニム辞書
検索語句をクエリ時に同義語のORグループへ展開します（v1.6.0以降）：
synonyms:
enable: true
file: "/etc/mygramdb/synonyms.tsv"シノニムファイル形式（TSV、1グループ1行、タブ区切り）：
car automobile vehicle
fast quick rapid speedy
# '#' 始まりの行はコメント- 双方向：グループ内のどの語句を検索しても、同グループの全ての語句にマッチ
- 1グループあたり最大20語
- インデックスと同じルール（NFKC正規化、全角半角変換）で正規化
ログ
logging:
level: "info" # debug, info, warn, error
format: "text" # text または json
file: "/var/log/mygramdb/mygramdb.log"ネットワークセキュリティ
WARNING
allow_cidrsが空または未設定の場合、すべての接続が拒否されます。アクセスを許可するには、少なくとも1つのCIDRを追加する必要があります。
network:
allow_cidrs:
- "127.0.0.1/32"
- "192.168.1.0/24"
- "10.0.0.0/8"Unixドメインソケット
ローカル接続でより低レイテンシを実現するには、Unixドメインソケットを設定します：
api:
unix_socket:
path: "/var/run/mygramdb/mygramdb.sock"CLIから接続：
mygram-cli -s /var/run/mygramdb/mygramdb.sock SEARCH articles "hello"ランタイム変数
MySQL互換のSET/SHOW VARIABLESコマンドで、再起動なしに設定を変更できます：
-- すべての変数を表示
SHOW VARIABLES;
-- 特定の変数を表示
SHOW VARIABLES LIKE 'cache%';
-- 設定をランタイムで変更
SET logging.level = 'debug';
SET cache.enabled = false;
SET api.default_limit = 200;NOTE
以下の設定は変更不可で、再起動が必要です：
mysql.databasetables（追加/削除）api.tcp.port,api.http.port