archivebox.search package

Subpackages

• archivebox.search.backends package
  • Submodules
  • archivebox.search.backends.ripgrep module
    • index()
    • flush()
    • search()
  • archivebox.search.backends.sonic module
    • index()
    • search()
    • flush()
  • Module contents

Submodules

archivebox.search.utils module

archivebox.search.utils.log_index_started(url)

archivebox.search.utils.get_file_result_content(res, extra_path, use_pwd=False)

archivebox.search.utils.get_indexable_content(results: QuerySet)

Module contents

archivebox.search.indexing_enabled()

archivebox.search.search_backend_enabled()

archivebox.search.get_backend()

archivebox.search.import_backend()

archivebox.search.write_search_index(link: Link, texts: List[str] | None = None, out_dir: Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/dev'), skip_text_index: bool = False) → None

archivebox.search.query_search_index(query: str, out_dir: Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/dev')) → QuerySet

archivebox.search.flush_search_index(snapshots: QuerySet)

archivebox.search.index_links(links: List[Link] | None, out_dir: Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/dev'))