featurebase/README.md

2.8 KiB

Our private fork of Pilosa, a distributed bitmap index

Docs

See our internal documentation, which includes all external documentation, plus many internal-only pages, listed under the "Internal" heading in the main navigation bar.

The documentation for the open source fork is also available, but is outdated for most technical details. Conceptual explanations and technical blog posts may still be informative.

Getting Started

  1. Install Pilosa.

Optionally, to include Lattice, the in-browser UI, follow the "Build from source" instructions, and run make generate-statik before make install. When you run a local Pilosa server on the default host, for example, you can access Lattice at localhost:10101.

  1. Start Pilosa with the default configuration:

    pilosa server
    

    and verify that it's running:

    curl localhost:10101/status
    
  2. Follow along with the Sample Project to get a better understanding of Pilosa's capabilities.

Data Model

Check out how the Pilosa Data Model works.

Query Language

You can interact with Pilosa directly in the console using the Pilosa Query Language (PQL).

Client Libraries

Three client libraries were supported for the open source fork: Go, (https://www.pilosa.com/docs/client-libraries/#java), (https://www.pilosa.com/docs/client-libraries/#python). Of these, only the Go client has seen significant use and development in the private fork, and it has now been incorporated into this repository, in the client directory

License

Pilosa is licensed under the Apache License, Version 2.0.

A copy of the license is located in github.com/molecula/pilosa/LICENSE. More details about licensing are found in github.com/molecula/pilosa/NOTICE.