I would like an option for a flux query specified in the queries_flux
section of a custom influxdb sensor to be passed verbatim to influxdb, without being modified.
Reason being that prepending the query with range
and bucket
does not always create syntactically correct queries. Sometimes I just want my query to be passed as is .
Example:
The following query calculates the cumulative electricity cost for the day from two existing time series, however the integration prepends the join
function with a range
specifier, which is incorrect. I just want to use the query as it is written.
import "join"
usage = from(bucket: "homeassistant")
|> range(start: today())
|> filter(fn: (r) => r["entity_id"] == "emoncms_import" and r["_field"] == "value")
|> window(every: 30m)
|> integral(unit: 1h)
|> map(fn: (r) => ({_value: r._value, _time: r._stop}))
cost = from(bucket: "homeassistant")
|> range(start: today())
|> filter(fn: (r) => r["entity_id"] == "octopus_energy_electricity_21e5388127_1630000294385_current_rate" and r["_field"] == "value")
|> window(every: 30m)
|> mean()
|> map(fn: (r) => ({_value: r._value, _time: r._stop}))
join.time(method: "left", left: usage, right: cost, as: (l, r) => ({l with cost: r._value}))
|> map(fn: (r) => ({_value: r._value * r.cost}))
|> sum()
|> map(fn: (r) => ({_value: r._value * 0.001, _time: now()}))
I have added a PR for this feature here -
home-assistant:dev
← planetmarshall:influxdb-verbatim-flux-query
opened 10:12AM - 12 May 24 UTC
<!--
You are amazing! Thanks for contributing to our project!
Please, DO N… OT DELETE ANY TEXT from this template! (unless instructed).
-->
## Proposed change
Add `verbatim` configuration option to influxdb flux queries. Allows the use of queries that would otherwise be syntactcally incorrect with the existing behaviour, which always prepend queries with a `from` and `range` expression.
See [Discourse](https://community.home-assistant.io/t/verbatim-option-for-flux-queries-in-influxdb-integration/728152/1) link to feature request.
## Type of change
<!--
What type of change does your PR introduce to Home Assistant?
NOTE: Please, check only 1! box!
If your PR requires multiple boxes to be checked, you'll most likely need to
split it into multiple PRs. This makes things easier and faster to code review.
-->
- [ ] Dependency upgrade
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New integration (thank you!)
- [x] New feature (which adds functionality to an existing integration)
- [ ] Deprecation (breaking change to happen in the future)
- [ ] Breaking change (fix/feature causing existing functionality to break)
- [ ] Code quality improvements to existing code or addition of tests
## Checklist
<!--
Put an `x` in the boxes that apply. You can also fill these out after
creating the PR. If you're unsure about any of them, don't hesitate to ask.
We're here to help! This is simply a reminder of what we are going to look
for before merging your code.
-->
- [x] The code change is tested and works locally.
- [x] Local tests pass. **Your PR cannot be merged unless tests pass**
- [x] There is no commented out code in this PR.
- [x] I have followed the [development checklist][dev-checklist]
- [x] I have followed the [perfect PR recommendations][perfect-pr]
- [x] The code has been formatted using Ruff (`ruff format homeassistant tests`)
- [ ] Tests have been added to verify that the new code works.
If user exposed functionality or configuration variables are added/changed:
- [x] Documentation added/updated for [www.home-assistant.io][docs-repository]
Documentation PR - https://github.com/home-assistant/home-assistant.io/pull/32695
If the code communicates with devices, web services, or third-party tools:
- [ ] The [manifest file][manifest-docs] has all fields filled out correctly.
Updated and included derived files by running: `python3 -m script.hassfest`.
- [ ] New or updated dependencies have been added to `requirements_all.txt`.
Updated by running `python3 -m script.gen_requirements_all`.
- [ ] For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
- [ ] Untested files have been added to `.coveragerc`.
<!--
This project is very active and we have a high turnover of pull requests.
Unfortunately, the number of incoming pull requests is higher than what our
reviewers can review and merge so there is a long backlog of pull requests
waiting for review. You can help here!
By reviewing another pull request, you will help raise the code quality of
that pull request and the final review will be faster. This way the general
pace of pull request reviews will go up and your wait time will go down.
When picking a pull request to review, try to choose one that hasn't yet
been reviewed.
Thanks for helping out!
-->
To help with the load of incoming pull requests:
- [ ] I have reviewed two other [open pull requests][prs] in this repository.
[prs]: https://github.com/home-assistant/core/pulls?q=is%3Aopen+is%3Apr+-author%3A%40me+-draft%3Atrue+-label%3Awaiting-for-upstream+sort%3Acreated-desc+review%3Anone+-status%3Afailure
<!--
Thank you for contributing <3
Below, some useful links you could explore:
-->
[dev-checklist]: https://developers.home-assistant.io/docs/development_checklist/
[manifest-docs]: https://developers.home-assistant.io/docs/creating_integration_manifest/
[quality-scale]: https://developers.home-assistant.io/docs/integration_quality_scale_index/
[docs-repository]: https://github.com/home-assistant/home-assistant.io
[perfect-pr]: https://developers.home-assistant.io/docs/review-process/#creating-the-perfect-pr