Asyncflux

Asynchronous client for InfluxDB and Tornado.

Installation

You can use pip to install Asyncflux:

$ pip install git+https://github.com/puentesarrin/asyncflux.git

Documentation

Sphinx is needed to generate the documentation. Documentation can be generated by issuing the following commands:

$ cd docs
$ make html

Or simply:

$ python setup.py doc

Also, the current documentation can be found at ReadTheDocs.

License

Asyncflux is available under the Apache License, Version 2.0.

Indices and tables

• Index
• Module Index
• Search Page

Package Documentation

asyncflux Package

asyncflux.version = '0.1+'

Current version of Asyncflux.

asyncflux Modules

asyncflux.client – Connection to InfluxDB

class asyncflux.client.AsyncfluxClient(host=None, port=None, username=None, password=None, is_secure=False, io_loop=None, **kwargs)

client[db_name] || client.db_name

Get the db_name Database on AsyncfluxClient client.

HOST = 'localhost'

PORT = 8086

USERNAME = 'root'

PASSWORD = 'root'

host

port

base_url

username

password

request(*args, **kwargs)

ping(*args, **kwargs)

query(*args, **kwargs)

get_databases(*args, **kwargs)

get_database_names(*args, **kwargs)

create_database(*args, **kwargs)

drop_database(*args, **kwargs)

get_users(*args, **kwargs)

get_user_names(*args, **kwargs)

create_user(*args, **kwargs)

change_user_password(*args, **kwargs)

drop_user(*args, **kwargs)

grant_privilege(*args, **kwargs)

revoke_privilege(*args, **kwargs)

grant_admin_privileges(*args, **kwargs)

revoke_admin_privileges(*args, **kwargs)

asyncflux.database – Database level operations

class asyncflux.database.Database(client, name)

BATCH_SIZE = 5000

client

name

query(*args, **kwargs)

write(*args, **kwargs)

write_points(*args, **kwargs)

get_measurements(*args, **kwargs)

get_tag_keys(*args, **kwargs)

get_tag_values(*args, **kwargs)

get_series(*args, **kwargs)

drop_series(*args, **kwargs)

grant_privilege_to(*args, **kwargs)

revoke_privilege_from(*args, **kwargs)

get_retention_policies(*args, **kwargs)

get_retention_policy_names(*args, **kwargs)

create_retention_policy(*args, **kwargs)

alter_retention_policy(*args, **kwargs)

drop_retention_policy(*args, **kwargs)

drop(*args, **kwargs)

asyncflux.user – Tools for InfluxDB users

class asyncflux.user.User(client, name, admin=None)

ADMIN = False

client

name

admin

change_password(*args, **kwargs)

grant_privilege_on(*args, **kwargs)

revoke_privilege_on(*args, **kwargs)

grant_admin_privileges(*args, **kwargs)

revoke_admin_privileges(*args, **kwargs)

drop(*args, **kwargs)

asyncflux.retentionpolicy – Tools for databases’ retention policies

class asyncflux.retentionpolicy.RetentionPolicy(database, name, duration, replication, default=None)

DEFAULT = False

database

name

duration

replication

default

alter(*args, **kwargs)

drop(*args, **kwargs)

asyncflux.testing – Unit testing support for asynchronous code

asyncflux.util – General-purpose utilities

asyncflux.util.asyncflux_coroutine(f)

A coroutine that accepts an optional callback.

Given a callback, the function returns None, and the callback is run with (result, error). Without a callback the function returns a Future.

asyncflux.util.sanitize_url(url)

asyncflux.util.batches(source, batch_size)

Release Notes

Next Release

Very soon

• Initial release.
• Added Sphinx docs and ReadTheDocs configuration.