Python Client API

You can develop applications and tools using Riak TS with the Riak Python client. This document covers the Python API for Riak TS.

Overview

To use Riak TS with the Python client, we’ve added 5 new operations to the riak.client.RiakClient object.

The Riak TS API is only available through Protocol Buffers and not HTTP, so please set up your Python client accordingly.

Prerequisites

In order for the Python client to install successfully on Ubuntu and CentOS, you must install some dependencies.

Ubuntu

sudo apt-get install -y python-setuptools python-dev libffi-dev libssl-dev

CentOS

sudo yum install -y python-setuptools python-devel libffi-devel openssl-deve

Client Operations

Operations Index

• Get - Fetch a single row based on the primary key values provided.
• Put - Store 1 or more rows to a Riak TS table.
• Delete - Delete a single row based on the primary key values provided.
• Query - Query a Riak TS table with the given query string.
• Stream ListKeys - Lists the primary keys of all the rows in a Riak TS table.

Operations Details

Get

Retrieve TS value by key.

ts_get(table, key)

Note: This request is automatically retried 3 times if it fails due to network error.

Return Type: class TsObject <riak.ts_object.TsObject>

Put

Stores time series data in the Riak TS cluster. To insert a null cell value, use a None when building the row(s) for the TsObject.

ts_put(tsobj)

Note: This request is automatically retried 3 times if it fails due to network error.

Return Type: boolean

Delete

Delete TS value by key.

ts_delete(table, key)

Note: This request is automatically retried 3 times if it fails due to network error.

Return Type: boolean

Query

Queries time series data in the Riak cluster.

ts_query(table, query)

Note: This request is automatically retried 3 times if it fails due to network error.

Return Type: Class TsObject <riak.ts_object.TsObject>

Stream ListKeys

Lists all keys in a Riak TS table via a stream. This is a generator method which should be iterated over. The caller should explicitly close the returned iterator, either using :func:contextlib.closing or calling close() explicitly. Consuming the entire iterator will also close the stream. If it does not, the associated connection might not be returned to the pool.

riak.client.RiakClient:ts_stream_keys(table, timeout=None)

Example:

from contextlib import closing
# Using contextlib.closing
with closing(client.ts_stream_keys(mytable)) as keys:
    for key_list in keys:
        do_something(key_list)
# Explicit close()
stream = client.ts_stream_keys(mytable)
for key_list in stream:
     do_something(key_list)
stream.close()

Return Type: iterator