Caterpillar
Introduction
What is Caterpillar?
Err, What? Example Please...
Why Caterpillar?
Supported Platforms
Do you support Python 3?
Getting Started
Installation
Basic Concepts
Code Examples
Creating and writing an Index
Searching an Index
Index Storage Formats
Querying
Indexes and Schemas
Designing a Schema
Field Types
Example
Caterpillar API
caterpillar
package
caterpillar.processing
package
caterpillar.processing.analysis
package
caterpillar.searching
package
caterpillar.searching.query
package
caterpillar.storage
package
Caterpillar
Docs
»
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
acquire() (caterpillar.locking.PIDLockFile method)
add() (caterpillar.processing.schema.Schema method)
add_container() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
add_document() (caterpillar.processing.index.IndexWriter method)
add_fields() (caterpillar.processing.index.IndexWriter method)
AlreadyLocked
analyse() (caterpillar.processing.schema.FieldType method)
Analyser (class in caterpillar.processing.analysis.analyse)
AnalyticsPlugin (class in caterpillar.processing.plugin)
as_index_schema() (caterpillar.processing.schema.CsvSchema method)
B
BaseQuery (class in caterpillar.searching.query)
begin() (caterpillar.processing.index.IndexReader method)
(caterpillar.processing.index.IndexWriter method)
(caterpillar.storage.Storage method)
(caterpillar.storage.sqlite.SqliteStorage method)
BiGramAnalyser (class in caterpillar.processing.analysis.analyse)
BiGramFilter (class in caterpillar.processing.analysis.filter)
BOOLEAN (class in caterpillar.processing.schema)
C
CATEGORICAL_TEXT (class in caterpillar.processing.schema)
CategoricalFieldType (class in caterpillar.processing.schema)
caterpillar.locking (module)
caterpillar.processing.analysis.analyse (module)
caterpillar.processing.analysis.filter (module)
caterpillar.processing.analysis.stopwords (module)
caterpillar.processing.analysis.tokenize (module)
caterpillar.processing.index (module)
caterpillar.processing.plugin (module)
caterpillar.processing.schema (module)
caterpillar.searching (module)
caterpillar.searching.query (module)
caterpillar.searching.query.match (module)
caterpillar.searching.query.querystring (module)
caterpillar.searching.results (module)
caterpillar.searching.scoring (module)
caterpillar.storage (module)
caterpillar.storage.sqlite (module)
CaterpillarIndexError
clear() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
clear_container() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
close() (caterpillar.processing.index.IndexReader method)
(caterpillar.processing.index.IndexWriter method)
(caterpillar.storage.Storage method)
(caterpillar.storage.sqlite.SqliteStorage method)
ColumnDataType (class in caterpillar.processing.schema)
ColumnSpec (class in caterpillar.processing.schema)
commit() (caterpillar.processing.index.IndexWriter method)
(caterpillar.storage.Storage method)
(caterpillar.storage.sqlite.SqliteStorage method)
ContainerNotFoundError
copy() (caterpillar.processing.analysis.tokenize.Token method)
count() (caterpillar.searching.IndexSearcher method)
csv_has_header() (in module caterpillar.processing.schema)
CsvSchema (class in caterpillar.processing.schema)
D
DefaultAnalyser (class in caterpillar.processing.analysis.analyse)
delete_container() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
delete_container_item() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
delete_container_items() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
delete_document() (caterpillar.processing.index.IndexWriter method)
DocumentNotFoundError
dumps() (caterpillar.processing.index.IndexConfig method)
DuplicateContainerError
DuplicateStorageError
E
equals() (caterpillar.processing.schema.FieldType method)
equals_wildcard() (caterpillar.processing.schema.FieldType method)
evaluate() (caterpillar.searching.query.BaseQuery method)
evaluate_op() (caterpillar.processing.schema.FieldType method)
EverythingAnalyser (class in caterpillar.processing.analysis.analyse)
EverythingTokenizer (class in caterpillar.processing.analysis.tokenize)
F
FieldType (class in caterpillar.processing.schema)
Filter (class in caterpillar.processing.analysis.filter)
filter() (caterpillar.processing.analysis.filter.Filter method)
(caterpillar.searching.IndexSearcher method)
find_bi_gram_words() (in module caterpillar.processing.index)
flush() (caterpillar.processing.index.IndexWriter method)
fold_term_case() (caterpillar.processing.index.IndexWriter method)
G
generate_csv_schema() (in module caterpillar.processing.schema)
get_associations_index() (caterpillar.processing.index.IndexReader method)
get_container_item() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
get_container_items() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
get_container_keys() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
get_container_len() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
get_document() (caterpillar.processing.index.IndexReader method)
get_document_count() (caterpillar.processing.index.IndexReader method)
get_documents() (caterpillar.processing.index.IndexReader method)
get_frame() (caterpillar.processing.index.IndexReader method)
get_frame_count() (caterpillar.processing.index.IndexReader method)
get_frame_ids() (caterpillar.processing.index.IndexReader method)
get_frames() (caterpillar.processing.index.IndexReader method)
get_frequencies() (caterpillar.processing.index.IndexReader method)
get_metadata() (caterpillar.processing.index.IndexReader method)
get_name() (caterpillar.processing.plugin.AnalyticsPlugin method)
get_plugin_data() (caterpillar.processing.index.IndexReader method)
get_positions_index() (caterpillar.processing.index.IndexReader method)
get_revision() (caterpillar.processing.index.IndexReader method)
get_schema() (caterpillar.processing.index.IndexReader method)
get_setting() (caterpillar.processing.index.IndexReader method)
get_settings() (caterpillar.processing.index.IndexReader method)
get_term_association() (caterpillar.processing.index.IndexReader method)
get_term_frequency() (caterpillar.processing.index.IndexReader method)
get_term_positions() (caterpillar.processing.index.IndexReader method)
get_vocab_size() (caterpillar.processing.index.IndexReader method)
gt() (caterpillar.processing.schema.FieldType method)
gte() (caterpillar.processing.schema.FieldType method)
I
i_am_locking() (caterpillar.locking.PIDLockFile method)
ID (class in caterpillar.processing.schema)
IndexConfig (class in caterpillar.processing.index)
IndexNotFoundError
IndexReader (class in caterpillar.processing.index)
IndexSearcher (class in caterpillar.searching)
IndexWriteLockedError
IndexWriter (class in caterpillar.processing.index)
is_locked() (caterpillar.locking.PIDLockFile method)
items() (caterpillar.processing.schema.Schema method)
L
loads() (caterpillar.processing.index.IndexConfig static method)
LockError
LockFailed
LockTimeout
LowercaseFilter (class in caterpillar.processing.analysis.filter)
lt() (caterpillar.processing.schema.FieldType method)
lte() (caterpillar.processing.schema.FieldType method)
M
map_row() (caterpillar.processing.schema.CsvSchema method)
MatchAllQuery (class in caterpillar.searching.query.match)
MatchSomeQuery (class in caterpillar.searching.query.match)
merge_terms() (caterpillar.processing.index.IndexWriter method)
N
names() (caterpillar.processing.schema.Schema method)
NotLocked
NotMyLock
NUMERIC (class in caterpillar.processing.schema)
P
ParagraphTokenizer (class in caterpillar.processing.analysis.tokenize)
parse_stopwords() (in module caterpillar.processing.analysis.stopwords)
PassFilter (class in caterpillar.processing.analysis.filter)
PIDLockFile (class in caterpillar.locking)
PositionalLowercaseWordFilter (class in caterpillar.processing.analysis.filter)
PotentialBiGramAnalyser (class in caterpillar.processing.analysis.analyse)
PotentialBiGramFilter (class in caterpillar.processing.analysis.filter)
Q
QueryError
QueryResult (class in caterpillar.searching.query)
QueryStringQuery (class in caterpillar.searching.query.querystring)
R
read_pid() (caterpillar.locking.PIDLockFile method)
RegexpTokenizer (class in caterpillar.processing.analysis.tokenize)
release() (caterpillar.locking.PIDLockFile method)
rollback() (caterpillar.processing.index.IndexWriter method)
(caterpillar.storage.Storage method)
(caterpillar.storage.sqlite.SqliteStorage method)
run() (caterpillar.processing.plugin.AnalyticsPlugin method)
run_plugin() (caterpillar.processing.index.IndexWriter method)
S
Schema (class in caterpillar.processing.schema)
score_and_rank() (caterpillar.searching.scoring.Scorer method)
(caterpillar.searching.scoring.SimpleScorer method)
(caterpillar.searching.scoring.TfidfScorer method)
Scorer (class in caterpillar.searching.scoring)
search() (caterpillar.searching.IndexSearcher method)
searcher() (caterpillar.processing.index.IndexReader method)
SearchHit (class in caterpillar.searching.results)
SearchResults (class in caterpillar.searching.results)
set_container_item() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
set_container_items() (caterpillar.storage.sqlite.SqliteStorage method)
(caterpillar.storage.Storage method)
set_schema() (caterpillar.processing.index.IndexWriter method)
set_setting() (caterpillar.processing.index.IndexWriter method)
SettingNotFoundError
SimpleScorer (class in caterpillar.searching.scoring)
SqliteStorage (class in caterpillar.storage.sqlite)
StopFilter (class in caterpillar.processing.analysis.filter)
Storage (class in caterpillar.storage)
StorageError
StorageNotFoundError
SubstitutionFilter (class in caterpillar.processing.analysis.filter)
T
TermNotFoundError
TEXT (class in caterpillar.processing.schema)
TfidfScorer (class in caterpillar.searching.scoring)
Token (class in caterpillar.processing.analysis.tokenize)
tokenize() (caterpillar.processing.analysis.tokenize.RegexpTokenizer method)
Tokenizer (class in caterpillar.processing.analysis.tokenize)
U
UnlockError
update() (caterpillar.processing.analysis.tokenize.Token method)
V
value_of() (caterpillar.processing.schema.CategoricalFieldType method)
W
WordTokenizer (class in caterpillar.processing.analysis.tokenize)