Cockatrice 0.7.1 documentation

Cockatrice is the open source search and indexing server written in Python that provides scalable indexing, search and advanced analysis/tokenization capabilities.

Features

Cockatrice provides Indexing and search functionality implemented by Whoosh via the RESTful API based on Flask and it could bring up the cluster with Raft Consensus Algorithm by PySyncObj.

• Easy deployment
• Full-text search and indexing
• Per field similarity (scoring/ranking model) definition.
• Bringing up cluster
• Index replication
• Create indices snapshot
• Recover from indices snapshot
• Synchronize indices from leader node
• An easy-to-use RESTful API

Source Codes

https://github.com/mosuka/cockatrice

Requirements

Python 3.x interpreter

Contents

• Getting Started
  • Installing Cockatrice
  • Starting Cockatrice
  • Create an index
  • Get an index
  • Delete an index
  • Put a document
  • Get a document
  • Delete a document
  • Index documents in bulk
  • Delete documents in bulk
  • Searching documents
• Schema
  • Schema Design
  • Schema
  • Default Search Field
  • Field Types
  • Analyzers
  • Tokenizers
  • Filters
  • Example
  • More information
• Scoring
  • Weighting Design
  • Weighting
  • Example
  • More information
• Cluster
  • Bring up a cluster
  • Get Cluster state
• Monitoring
  • Get metrics
• Health check
  • Liveness probe
  • Readiness probe
• RESTful API Reference
  • Index APIs
  • Document APIs
  • Search APIs
  • Cluster APIs
  • Snapshot APIs
• Wipepedia example
  • Downloading Wikipedia dump
  • Installing Wikiextractor
  • Extracting Wikipedia data
  • Starting Cockatrice
  • Creating index
  • Indexing Wikipedia

Indices and tables

• Index
• Module Index
• Search Page