Cockatrice 0.6.3 documentation

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

Features

Indexing and search are implemented by Whoosh. Cockatrice provides it via the RESTful API using Flask.

In cluster mode, uses Raft Consensus Algorithm by PySyncObj to achieve consensus across all the instances of the nodes, ensuring that every change made to the system is made to a quorum of nodes.

• Full-text search and indexing
• Faceting
• Result highlighting
• Easy deployment
• Bringing up cluster
• Index replication
• 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
• Schema management
  • Schema Design
  • Schema
  • Default Search Field
  • Field Types
  • Analyzers
  • Tokenizers
  • Filters
  • Example
  • More information
• Index management
  • Create an index
  • Get an index
  • Delete an index
• Document management
  • Index a document
  • Get a document
  • Delete a document
  • Index documents in bulk
  • Delete documents in bulk
• Search documents
  • Searching documents
  • Searching documents with weighting model
• Scoring
  • Weighting Design
  • Weighting
  • Example
  • More information
• Cluster management
  • Create a cluster
• Monitoring Cockatrice
  • Get metrics
• Health check
  • Liveness probe
  • Readiness probe
• RESTful API Reference
  • Index APIs
  • Document APIs
  • Search APIs
  • Cluster APIs
  • Snapshot APIs

Indices and tables

• Index
• Module Index
• Search Page