This documentation was automatically generated, and corresponds to version
0.9.6 of Xapian.
Directory structure index
Directory structure
backends
This directory contains a subdirectory for each of the available database
backends. Each backend corresponds to a different underlying file
structure. For example, the inmemory backend holds its databases
entirely in RAM, and the quartz backend is a fully featured disk based
backend.
The directory also contains the implementation of Xapian::Database::Internal
(the base class for each backend database class) and the factory functions
which are the public interface for instantiating the database backend classes.
backends/flint
This backend uses a custom written Btree management system to store
posting lists and termlists. This is a highly efficient
backend, using compression to store the postlists, and supporting the
full range of indexing functionality (sessions / transactions / etc).
backends/inmemory
This backend stores a database entirely in memory. When the
database is closed these indexed contents are lost.
This is useful for searching through relatively small amounts of data
(such as a single large file) which hasn't previously been indexed.
backends/multi
The MultiDatabase backend, which enables
searches to be performed across several databases. Opening this
database involves opening each of the sub-databases and merging
them together.
Searches are performed across the sub-databases via MultiPostList
and MultiTermList objects, which represent merged sets of postlist
and termlist objects.
backends/muscat36
The Muscat36 backend, used to access old-style
Muscat 3.6 databases.
This backend only supports reading from the database: databases
can be created with the old Muscat 3.6 software. We do not plan
to implement writing to these databases, since they are a legacy
format and do not have the ability to represent several of the
data structures we require for some of our new features.
backends/net
The NetworkDatabase backend, which enables
searches to be performed across databases on remote machines. Opening
this database involves opening a communications channel with a remote
database.
NetworkDatabase objects are used with NetworkMatch objects.
backends/quartz
This backend uses a custom written Btree management system to store
posting lists and termlists. This is a highly efficient
backend, using compression to store the postlists, and supporting the
full range of indexing functionality (sessions / transactions / etc).
bin
Programs relating to the Xapian library.
common
Header files which are used in various places within
the Xapian library code. It does not contain header files which are
externally visible: these are kept in the "include" directory.
docs
Documentation, and scripts to automatically generate
further documentation from the source code. If you have the appropriate
packages installed (currently, this means Perl), these scripts will be run
by make.
examples
This directory contains example programs which use the Xapian library.
These programs are intended to be a good starting point for those trying
to get acquainted with the Xapian API. Some of them are really just
toy programs, but others are actually useful utilities in their own
right (for example: delve, quest, and copydatabase).
include
This directory contains the externally visible header files. Internal header
files are kept in the "common" directory.
languages
Utilities for performing processing of text in various different languages.
Current these comprise stemming algorithms. In future language detection,
character set normalisation, and other language related utilities will be
added.
matcher
The code for performing the best match algorithm lives here.
This is the heart of the Xapian system, and is the code which calculates
relevance rankings for the documents in the collection for a given query.
The query expansion (relevance feedback) code also lives here.
net
The code implementing the network protocols lives here.
tests
This directory contains various test programs which exercise most parts of
the Xapian library.
testsuite
This contains the test suite engine, which is linked with by most of the
C++ test programs to perform a set of tests.
Generated on 15 May 2006.
Command line used to generate this documentation:
/u1/olly/xapian-svn-snapshot/tags/0.9.6/xapian/xapian-core/docs/mkdoc.pl 0.9.6 /u1/olly/xapian-svn-snapshot/tags/0.9.6/xapian/xapian-core code_structure.html