Java API

Package:

org.apache.paimon.index.fulltext

Main classes:

• FullTextIndexWriter
• FullTextIndexReader
• FullTextQuery
• FullTextSearchResult
• FullTextIndexInput
• FullTextIndexOutput

Example:

try (FullTextIndexWriter writer = FullTextIndexWriter.create(Collections.emptyMap())) {
    writer.addDocument(1L, "Apache Paimon full text search");
    writer.writeIndex(output);
}

try (FullTextIndexReader reader = new FullTextIndexReader(input)) {
    FullTextSearchResult result = reader.search(FullTextQuery.match("paimon", "text"), 10);
    FullTextSearchResult filtered =
            reader.search(FullTextQuery.match("paimon", "text"), 10, roaringFilterBytes);
}

roaringFilterBytes must be a serialized 64-bit Roaring bitmap (RoaringTreemap) containing the allowed row ids. The filter is applied during Tantivy collection, before the top results are selected.

Input reads:

• Implement FullTextIndexInput.readAt(...) for compatibility.
• Override FullTextIndexInput.pread(long[] positions, byte[][] buffers) when the storage client can batch, coalesce, or parallelize positional reads.

Native loading:

• Set PAIMON_FTINDEX_JNI_LIB_PATH to the full path of libpaimon_ftindex_jni.dylib / .so, or
• put the library on java.library.path as paimon_ftindex_jni.