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

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)[source]
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)[source]
ping(*args, **kwargs)[source]
query(*args, **kwargs)[source]
get_databases(*args, **kwargs)[source]
get_database_names(*args, **kwargs)[source]
create_database(*args, **kwargs)[source]
drop_database(*args, **kwargs)[source]
get_users(*args, **kwargs)[source]
get_user_names(*args, **kwargs)[source]
create_user(*args, **kwargs)[source]
change_user_password(*args, **kwargs)[source]
drop_user(*args, **kwargs)[source]
grant_privilege(*args, **kwargs)[source]
revoke_privilege(*args, **kwargs)[source]
grant_admin_privileges(*args, **kwargs)[source]
revoke_admin_privileges(*args, **kwargs)[source]

asyncflux.database – Database level operations

class asyncflux.database.Database(client, name)[source]
BATCH_SIZE = 5000
client
name
query(*args, **kwargs)[source]
write(*args, **kwargs)[source]
write_points(*args, **kwargs)[source]
get_measurements(*args, **kwargs)[source]
get_tag_keys(*args, **kwargs)[source]
get_tag_values(*args, **kwargs)[source]
get_series(*args, **kwargs)[source]
drop_series(*args, **kwargs)[source]
grant_privilege_to(*args, **kwargs)[source]
revoke_privilege_from(*args, **kwargs)[source]
get_retention_policies(*args, **kwargs)[source]
get_retention_policy_names(*args, **kwargs)[source]
create_retention_policy(*args, **kwargs)[source]
alter_retention_policy(*args, **kwargs)[source]
drop_retention_policy(*args, **kwargs)[source]
drop(*args, **kwargs)[source]

asyncflux.user – Tools for InfluxDB users

class asyncflux.user.User(client, name, admin=None)[source]
ADMIN = False
client
name
admin
change_password(*args, **kwargs)[source]
grant_privilege_on(*args, **kwargs)[source]
revoke_privilege_on(*args, **kwargs)[source]
grant_admin_privileges(*args, **kwargs)[source]
revoke_admin_privileges(*args, **kwargs)[source]
drop(*args, **kwargs)[source]

asyncflux.retentionpolicy – Tools for databases’ retention policies

class asyncflux.retentionpolicy.RetentionPolicy(database, name, duration, replication, default=None)[source]
DEFAULT = False
database
name
duration
replication
default
alter(*args, **kwargs)[source]
drop(*args, **kwargs)[source]

asyncflux.testing – Unit testing support for asynchronous code

asyncflux.util – General-purpose utilities

asyncflux.util.asyncflux_coroutine(f)[source]

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)[source]
asyncflux.util.batches(source, batch_size)[source]

Release Notes

Next Release

Very soon

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