codec.base 模块

此模块包含“codec”对象的基类/接口。

Classes

class whoosh.codec.base.Codec
class whoosh.codec.base.PerDocumentWriter
class whoosh.codec.base.FieldWriter
class whoosh.codec.base.PostingsWriter
abstract written()

如果此对象已写入磁盘,则返回true。

class whoosh.codec.base.TermsReader
class whoosh.codec.base.PerDocumentReader
all_doc_ids()

返回读卡器中所有(未删除)文档ID的迭代器。

class whoosh.codec.base.Segment(indexname)

不要直接实例化此对象。索引对象使用它来保存有关段的信息。这个类的对象列表作为TOC文件的一部分被pickle。

TOC文件存储的信息量很小——主要是一个段对象列表。段是真正的反向索引。拥有多个段允许快速增量索引:只需为新文档创建一个新段,并让索引覆盖新段,以便进行读取/搜索。”优化“索引将现有段的内容合并为一个段(删除沿途删除的所有文档)。

create_file(storage, ext, **kwargs)

在给定的存储中使用此段的ID和给定的扩展名创建新文件的方便方法。任何关键字参数都将传递给存储的create_file方法。

abstract delete_document(docnum, delete=True)

删除给定的文档编号。在优化文档之前,不会从索引中实际删除该文档。

参数
  • docnum -- 要删除的文档编号。

  • delete -- 如果为false,则此操作将恢复删除的文档。

abstract deleted_count()

返回此段中已删除文档的总数。

doc_count()

返回此段中的(未删除的)文档数。

abstract doc_count_all()

返回此段中已删除或未删除的文档总数。

has_deletions()

如果删除此段中的任何文档,则返回true。

abstract is_deleted(docnum)

如果删除给定的文档编号,则返回true。

open_file(storage, ext, **kwargs)

方便方法打开给定存储中名为该段ID和给定扩展名的文件。任何关键字参数都将传递给存储的open-file方法。