Generic SQL Historian library that can be used to implement a historian agent with a relational database backend. This library cannot be installed as a VOLTTRON agent as is. Only a concrete database implementation package such as sqlite-historian that depends on this library can be installed as a VOLTTRON agent.

Requirements

• Python >= 3.10

Installation

This library can be installed into a running VOLTTRON instance using

vctl install-lib volttron-lib-sql-historian

To remove it later, use

vctl remove-lib volttron-lib-sql-historian

However, this is not usually necessary. Any historian agent that uses this library will automatically install it as part of its installation. For example, installing SQLiteHistorian will automatically install volttron-lib-sql-historian into the same VOLTTRON environment.

Development

Please see the following for contributing guidelines contributing.

Please see the following helpful guide about developing modular VOLTTRON agents

To create a new relational database based historian by extending this library, subclass DBDriver. The subclass should be in a module historian.<database_type>.<database_type>functs.py for it to be dynamically loaded by the base DBDriver. Please refer to SQLiteHistorian as an example

Disclaimer Notice

This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.