JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.
Recoll user manual
Python API
Sidebar
Prev
|
Up
|
Next
Python search interface
The recoll module
The rclextract module
Search API usage example
Contents
Introduction
Giving it a try
Full text search
Recoll overview
Indexing
Introduction
Indexing modes
Choosing an indexing mode
Configurations, multiple indexes
Document types
Indexing failures
Recovery
Index storage
Xapian index formats
Security aspects
Special considerations for big indexes
Index configuration
The index configuration GUI
Multiple indexes
Creating and using an additional index: Linux example
Creating an alternate index: Windows example
Index case and diacritics sensitivity
Indexing threads configuration (Unix-like systems)
Multithreading for document preparation
Using multiple temporary indexes
Index update scheduling
Periodic indexing
Running the indexer
recollindex command line
Linux: using cron to automate indexing
Real time indexing
Unix-like systems: automatic daemon start with systemd
Unix-like systems: automatic daemon start from the desktop session
Miscellaneous details
Miscellaneous indexing notes
The PDF input handler
XMP fields extraction
PDF attachment indexing
Running OCR on image documents
Running a speech to text program on audio files
Removable volumes
Indexing removable volumes in the main index
Self contained volumes
Unix-like systems: indexing visited Web pages
Unix-like systems and Mac OS-like systems: using extended attributes
Unix-like systems: importing external tags
Searching
Introduction
Searching with the Qt graphical user interface
Simple search
The result list
Customising the viewers
No results: the spelling suggestions
The result list right-click menu
The result table
The filters panel
Running arbitrary commands on result files
Unix-like systems: displaying thumbnails
The preview window
Searching inside the preview
The Query Fragments window
Assisted Complex Search (A.K.A. "Advanced Search")
Advanced search: the "find" tab
Phrase and Proximity searches
Advanced search: the "filter" tab
Advanced search history
The term explorer tool
Multiple indexes
Document history
Sorting search results and collapsing duplicates
Keyboard shortcuts
Search tips
Terms and search expansion
Working with phrases and proximity
Others
Saving and restoring queries
Customizing the search interface
The result list format
The paragraph format
Searching with the KDE KIO slave
Searching on the command line
The query language
General syntax
Special field-like specifiers
Range clauses
Modifiers
Wildcards and anchored searches
Wildcards
Wildcards and path filtering
Anchored searches
Using Synonyms (1.22)
Path translations
Search case and diacritics sensitivity
Desktop integration
Programming interface
Writing a document input handler
Simple input handlers
"Multiple" handlers
Telling Recoll about the handler
Input handler output
Page numbers
Field data processing
Python API
Introduction
Interface elements
Log messages for Python scripts
Python search interface
The recoll module
connect(confdir=None, extra_dbs=None, writable = False)
The Db class
The Query class
The Doc class
The SearchData class
The rclextract module
The Extractor class
Search API usage example
Python indexing interface
Recoll external indexers
The Python indexing API
Python indexing interface methods
Query data access for external indexers
External indexers configuration
External indexer samples
Using an external indexer index in conjunction with a regular one
Installation and configuration
Installing a binary copy
Supporting packages
Building from source
Prerequisites
Building
Configure options:
Normal procedure, for source extracted from a tar distribution)
Building from git code
Installing
Python API package
Configuration overview
Environment variables
Recoll main configuration file, recoll.conf
Parameters affecting what documents we index
Parameters affecting how we generate terms and organize the index
Parameters affecting where and how we store things
Parameters affecting indexing performance and resource usage
Miscellaneous parameters
Query-time parameters (no impact on the index)
Parameters for the PDF input script
Parameters for OCR processing
Parameters for running speech to text conversion
Parameters for miscellaneous specific handlers
Parameters set for specific locations
The fields file
Extended attributes in the fields file
The mimemap file
The mimeconf file
The mimeview file
The ptrans file
Examples of configuration adjustments
Adding an external viewer for an non-indexed type
Adding indexing support for a new file type
