https://github.com/amancevice/influxalchemy

Query InfluxDB using SQLAlchemy-style syntax
https://github.com/amancevice/influxalchemy

influxdb python sqlalchemy

Last synced: 17 days ago
JSON representation

Query InfluxDB using SQLAlchemy-style syntax

• Host: GitHub
• URL: https://github.com/amancevice/influxalchemy
• Owner: amancevice
• License: mit
• Created: 2016-08-09T18:53:59.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-03-10T15:26:46.000Z (8 months ago)
• Last Synced: 2024-10-10T04:07:55.363Z (about 1 month ago)
• Topics: influxdb, python, sqlalchemy
• Language: Python
• Size: 157 KB
• Stars: 50
• Watchers: 9
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# InfluxAlchemy

![pypi](https://img.shields.io/pypi/v/influxalchemy?color=yellow&logo=python&logoColor=eee&style=flat-square)

![python](https://img.shields.io/pypi/pyversions/influxalchemy?logo=python&logoColor=eee&style=flat-square)

[![pytest](https://img.shields.io/github/actions/workflow/status/amancevice/influxalchemy/pytest.yml?logo=github&style=flat-square)](https://github.com/amancevice/influxalchemy/actions/workflows/pytest.yml)

[![coverage](https://img.shields.io/codeclimate/coverage/amancevice/influxalchemy?logo=code-climate&style=flat-square)](https://codeclimate.com/github/amancevice/influxalchemy/test_coverage)

[![maintainability](https://img.shields.io/codeclimate/maintainability/amancevice/influxalchemy?logo=code-climate&style=flat-square)](https://codeclimate.com/github/amancevice/influxalchemy/maintainability)

Query InfluxDB using SQLAlchemy-style syntax

## Installation

```bash

pip install influxalchemy

```

## Usage

```python

import influxdb

import influxalchemy

```

### Define InfluxAlchemy Measurements

```python

class Widgets(influxalchemy.Measurement):

    __measurement__ = 'widgets'

class Wombats(influxalchemy.Measurement):

    __measurement__ = 'wombats'

```

The class-attribute `__measurement__` can be omitted and will default to the class name if absent.

### Open InfluxAlchemy Connection

```python

db = influxdb.DataFrameClient(database="example")

flux = influxalchemy.InfluxAlchemy(db)

```

## Query InfluxDB

### Query Single Measurement

```python

# SELECT * FROM widgets;

flux.query(Widgets)

```

### Query Ad Hoc Measurement

```python

# SELECT * from /.*/;

flux.query(influxalchemy.Measurement.new("/.*/"))

```

### Select Fields of Measurement

```python

# SELECT tag1, field2 FROM widgets;

flux.query(Widgets.tag1, Widgets.field2)

```

### Query Across Measurements

```python

# SELECT * FROM /widgets|wombats/;

flux.query(Widgets | Wombats)

```

### Filter Tags

```python

# SELECT * FROM widgets WHERE tag1 = 'fizz';

flux.query(Widgets).filter(Widgets.tag1 == "fizz")

```

### Filter Tags with 'like'

```python

# SELECT * FROM widgets WHERE tag1 =~ /z$/;

flux.query(Widgets).filter(Widgets.tag1.like("/z$/"))

```

### Chain Filters

```python

clause1 = Widgets.tag1 == "fizz"

clause2 = Widgets.tag2 == "buzz"

# SELECT * FROM widgets WHERE tag1 = 'fizz' AND tag2 = 'buzz';

flux.query(Widgets).filter(clause1 & clause2)

# SELECT * FROM widgets WHERE tag1 = 'fizz' OR tag2 = 'buzz';

flux.query(Widgets).filter(clause1 | clause2)

```

### Group By

```python

# SELECT * FROM widgets GROUP BY time(1d);

flux.query(Widgets).group_by("time(1d)")

# SELECT * FROM widgets GROUP BY tag1;

flux.query(Widgets).group_by(Widgets.tag1)

```

### Time

```python

# SELECT * FROM widgets WHERE (time > now() - 7d);

flux.query(Widgets).filter(Widgets.time > "now() - 7d")

# SELECT * FROM widgets WHERE time >= '2016-01-01' AND time <= now() - 7d;

d = date(2016, 1, 1)

flux.query(Widgets).filter(Widgets.time.between(d, "now() - 7d"))

```

Note that naive datetime object will be assumed in UTC timezone.