Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Build Riak search queries safely and easily.

Project Description

rkQuery is a library for programmatically building Riak search queries. It aims to be easy to use, powerful, and protect from injection attacks that would be possible with simple string interpolation.


Just start playing around with the q object:

>>> from rkquery import q
>>> q("some literal")
<q: "some literal">
>>> q(field="literal value")
<q: field:"literal value">
>>> q.not_(blocked="yes")
<q: NOT blocked:"yes">

You can provide multiple arguments, too. The default query combinator is AND:

>>> q("word1", "word2")
<q: "word1" AND "word2">
>>> q(username='foo', password='s3cr3t')
<q: username:"foo" AND password:"s3cr3t">

This is just a synonym for q.all():

>>> q.all("word1", "word2")
<q: "word1" AND "word2">
>>> q.all(username='foo', password='s3cr3t')
<q: username:"foo" AND password:"s3cr3t">

Of course you can construct OR queries, using q.any():

>>> q.any("word1", "word2")
<q: "word1" OR "word2">
>>> q.any(username='foo', email='')
<q: username:"foo" OR email:"">
>>> q(field=q.any("string1", "string2"))
<q: field:("string1" OR "string2")>

Or by combining existing q objects:

>>> q.any("word1", "word2") & q("word3")
<q: ("word1" OR "word2") AND "word3">
>>> q.any(email="", username="foo") & q(password="s3cr3t")
<q: (email:"" OR username:"foo") AND password:"s3cr3t">

There are helpers for negation as well (note that ‘none’ means ‘not any’):

>>> q.none(blocked="yes", cheque_bounced="yes")
<q: NOT (blocked:"yes" OR cheque_bounced:"yes")>
>>> ~q.any(blocked="yes", cheque_bounced="yes")
<q: NOT (blocked:"yes" OR cheque_bounced:"yes")>

You can do range queries with q.range():

>>> q.range("red", "rum")
<q: ["red" TO "rum"]>
>>> q(field=q.range("red", "rum"))
<q: field:["red" TO "rum"]>

Note that the default is an inclusive range (square brackets). The full set of range queries:

>>> q.range_inclusive("red", "rum")
<q: ["red" TO "rum"]>
>>> q.range_exclusive("red", "rum")
<q: {"red" TO "rum"}>
>>> q.between("red", "rum")
<q: {"red" TO "rum"}>

Term boosting is a simple unary operation:

>>> q("red").boost(5)
<q: "red"^5>

As is proximity:

>>> q("See spot run").proximity(20)
<q: "See spot run"~20>

Release History

This version
History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(5.2 kB) Copy SHA256 Hash SHA256
Source None Jun 21, 2012

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers