Python API

Package:

paimon_ftindex

Example:

from paimon_ftindex import FullTextIndexReader, FullTextIndexWriter, MatchQuery

with FullTextIndexWriter({"tokenizer": "ngram"}) as writer:
    writer.add_document(1, "Apache Paimon full text search")
    writer.write(output)

with FullTextIndexReader(input_) as reader:
    ids, scores = reader.search(MatchQuery("paimon"), limit=10)

The output object must provide:

• write(bytes)
• optional flush()

The input object must provide:

• pread(pos: int, length: int) -> bytes

Native loading:

• Set PAIMON_FTINDEX_LIB_PATH to a library file or directory, or
• build paimon-ftindex-ffi so the package can discover target/debug or target/release.