The EFD Python client¶
The EFD client built on top of the aioinflux library and provides a high-level API to interact with the EFD.
The EFD client is designed to be used in the RSP notebook aspect. For services that need to access the EFD, see how to query the InfluxDB API directly.
For example, from a notebook running at the USDF RSP you can instantiate the EFD client using:
from lsst_efd_client import EfdClient
client = EfdClient("usdf_efd")
await client.get_topics()
usdf_efd is an alias for the InfluxDB instance at USDF. With that the EFD client discovers the InfluxDB URL, database and credentials to connect to that
environment.
If you are using the EFD client on another environment, see the corresponding alias in the environments page.
Learn more about the methods available in the documentation.
InfluxQL¶
To perform queries directly using InfluxQL, you can make use of the influx_client.query() method in conjunction with the EFD client.
For a comprehensive understanding of the InfluxQL query syntax, we recommend referring to the InfluxQL documentation.
from lsst_efd_client import EfdClient
client = EfdClient("usdf_efd")
query = '''SELECT vacuum FROM "lsst.sal.ATCamera.vacuum" WHERE time > '2023-04-20' '''
await client.influx_client.query(query)
InfluxQL is picky about single vs. double quotes.
The rule of thumb is to use double quotes around topic names that have special characters like . and single quotes around timestamps.
Use the now() function to query data with time relative the current time in UTC.
query = '''SELECT vacuum FROM "lsst.sal.ATCamera.vacuum" WHERE time > now() - 6h '''
Example notebooks¶
Learn how to use the EFD client and InfluxQL to query EFD data.
Learn how to downsample data with InfluxQL.
Learn how to return chunked responses with the EFD client.