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.35.tar.gz (8.6 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.35-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sflux-0.0.35.tar.gz
Algorithm Hash digest
SHA256 ca7890e47e6f9752cca16d64a291b17d090bbb87f8ace89dc45eb7816deac114
MD5 cab282f7069ba23dd89ece80eb63a3cb
BLAKE2b-256 b3434cf11f469ea9e7507fc968decb374cae5e81b98c0c81b0a7322a10025285

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sflux-0.0.35-py3-none-any.whl
Algorithm Hash digest
SHA256 71851ed0e0fe8f52b746af6245bc7dc20889f791ad78a2553f6a54a57cbb2853
MD5 6cd0b8c1428c6dbe78bcd9f33ef65245
BLAKE2b-256 75fa977f1f82747b326140a5ecd631250a54a30bbcefbe2967dc00112fac35ba

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