Skip to content
Python client library for Pilosa
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
docs
integration_tests
pilosa
requirements
tests
.coveragerc
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
MANIFEST.in
Makefile
README.md
make.cmd
setup.cfg
setup.py

README.md

Python Client for Pilosa

Python client for Pilosa high performance distributed row index.

What's New?

See: CHANGELOG

Requirements

  • Compatible with Pilosa 1.2
  • Requires Python 2.7 and higher or Python 3.4 and higher.

Install

Pilosa client is on PyPI. You can install the library using pip:

pip install pilosa

Usage

Quick overview

Assuming Pilosa server is running at localhost:10101 (the default):

import pilosa

# Create the default client
client = pilosa.Client()

# Retrieve the schema
schema = client.schema()

# Create an Index object
myindex = schema.index("myindex")

# Create a Field object
myfield = myindex.field("myfield")

# make sure the index and field exists on the server
client.sync_schema(schema)

# Send a Set query. PilosaError is thrown if execution of the query fails.
client.query(myfield.set(5, 42))

# Send a Row query. PilosaError is thrown if execution of the query fails.
response = client.query(myfield.row(5))

# Get the result
result = response.result

# Act on the result
if result:
    columns = result.row.columns
    print("Got columns: ", columns)

# You can batch queries to improve throughput
response = client.query(
    myindex.batch_query(
        myfield.row(5),
        myfield.row(10),
    )    
)
for result in response.results:
    # Act on the result
    print(result.row.columns)

Documentation

Data Model and Queries

See: Data Model and Queries

Executing Queries

See: Server Interaction

Importing and Exporting Data

See: Importing and Exporting Data

Contributing

See: CONTRIBUTING

License

See: LICENSE

You can’t perform that action at this time.