XAPIAN-CHECK(1)

✨ NAME ✨ (XAPIAN-CHECK(1), from the User Commands manual)

Okay bestie, this is xapian-check β€” the tool that checks the consistency of a database or table. No cap, that's literally its whole thing. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

xapian-check DATABASE_DIRECTORY|PATH_TO_BTREE [[F][t][f][b][v][+]]

You give it a DATABASE_DIRECTORY or a PATH_TO_BTREE, then optionally some little combo from [[F][t][f][b][v][+]]. πŸŽ€


πŸ’– DESCRIPTION πŸ’–

xapian-check checks the consistency of a database or table. Yes, it's very much giving "I check consistency" and we love that for it. πŸ’€βœ¨

If a whole database is checked, then additional cross-checks between the tables are performed. So when you point it at the entire database, it also does extra cross-checks between the tables. πŸ”₯

🌳 The btree(s) is/are always checked - control the output verbosity with:

  • F β€” attempt to fix a broken database (implemented for glass currently) πŸ› οΈ
  • t β€” short tree printing 🌱
  • f β€” full tree printing 🌳
  • b β€” show free blocks 🧱
  • v β€” show stats about B-tree (default) πŸ“Š
  • + β€” same as tbv ✨

Like, for example:

xapian-check /var/lib/xapian/data/default
xapian-check /var/lib/xapian/data/default/postlist fbv

πŸ’– okay bye bestie β€” this iconic page is from xapian-core 2.0.0, March 2026. periodt. πŸ’–

πŸ“¦ where this page comes from