Skip to main content

A simple python interface for InfluxDB2.0

Project description

SFLUX

Simple Influx DB wrapper for python. Builds on top of influxdb-client to make the use of Influxdb as simple as possible

Basic Usage

1. Querying data

Sflux transforms the FluxQL syntaxis into intuitive python commands that try to follow FluxQL as close as possible. A simple query looks like this:

import sflux

with sflux.Client(url='your_host', token='your_token', org='your_org') as client:
    result = client.query(bucket='your_bucket')\
        .range(start='-1d')\
        .filter(sflux.ROW('_measurement') == 'your_measurement')\
        .pivot()\
        .filter(sflux.ROW('your_column') != 'something')\
        .to_dict()

2. Writing data

The writing of time series into the database is acheived by building measurement objects for each measurement to be inserted:

import time
import sflux

measurements = [
    sflux.Measurement('measurement_name', field1='value1', field2='value2')
        .tags(tag1='tag1', tag2='tag2')
        .time(time.time())
]
with sflux.Client(url='your_host', token='your_token', org='your_org') as client:
    client.write('your_bucket', measurements)

3. Usage considerations

This library is still under development and should be used with care. Please report any bugs as issues and they will be addressed promptly.

For now Sflux does not implement string checks to avoid Injections. Please always verify any user input before passing it to Sflux. String checking will be implemented in future releases.

Project details


Download files

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

Source Distribution

sflux-0.0.33.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sflux-0.0.33-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file sflux-0.0.33.tar.gz.

File metadata

  • Download URL: sflux-0.0.33.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for sflux-0.0.33.tar.gz
Algorithm Hash digest
SHA256 147213453477d080b2dc35fc7d0f1a209b73e9f88157b3f7d087251d87e467f9
MD5 abb86421b134ffa7e1c051e607690bd4
BLAKE2b-256 0cbe6e90f8655ed31a114bea900e0d86e5b76e76e1ff29618b8e6fbc39b836ec

See more details on using hashes here.

File details

Details for the file sflux-0.0.33-py3-none-any.whl.

File metadata

  • Download URL: sflux-0.0.33-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for sflux-0.0.33-py3-none-any.whl
Algorithm Hash digest
SHA256 bec14bb4269f048bdc0a9f2d7e8312c47bce773af14988beb681e0d369ac9cd1
MD5 602142cf9c617915fd9115ca1c56b173
BLAKE2b-256 d8ae61b1446676f518b4ac0a49c758ea88823afcc5857dab288e876d1e3fbf71

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page