Store history data in SQL Database: MySQL, PostgreSQL or SQLite
JavaScript HTML
Latest commit 8dd095d Jan 15, 2017 Ingo Fischer New add admin-version dependency

README.md

Logo

ioBroker.sql

NPM version Downloads Tests

NPM

This adapter saves state history into SQL DB.

Supports PostgreSQL, mysql, Microsoft SQL Server and sqlite. You can leave port 0 if default port is desired.

MS-SQL:

Use localhost\instance for host and check that TCP/IP connections are enabled. https://msdn.microsoft.com/en-us/library/bb909712(v=vs.90).aspx

SQLite:

is "file"-DB and cannot manage too many events. If you have a big amount of data use real DB, like PostgreSQL and co.

SQLite DB must not be installed extra. It is just a file on disk, but to install it you require build tools on your system. For linux, just write:

sudo apt-get install build-essential

For windows:

c:\>npm install --global --production windows-build-tools

And then reinstall the adapter, e.g:

cd /opt/iobroker
iobroker stop sql
npm install iobroker.sql --production
iobroker start sql

MySQL:

You can install mysql on linux systems:

apt-get install mysql-server mysql-client

mysql -uroot -p

CREATE USER 'iobroker‘@’%’ IDENTIFIED BY 'iobroker';
GRANT ALL PRIVILEGES ON * . * TO 'iobroker'@'%';
FLUSH PRIVILEGES;

If required edit /etc/mysql/my.cnf to set bind to IP-Address for remote connect.

Warning: iobroker user is "admin". If required give limited rights to iobroker user.

Structure of the DBs

Default Database name is "iobroker", but it can be changed in configuration.

Sources

This table is a list of adapter's instances, that wrote the entries. (state.from)

DB Name in query
MS-SQL iobroker.dbo.sources
MySQL iobroker.sources
PostgreSQL sources
SQLite sources

Structure:

Field Type Description
id INTEGER NOT NULL PRIMARY KEY IDENTITY(1,1) unique ID
name varchar(255) / TEXT instance of adapter, that wrote the entry

Note: MS-SQL uses varchar(255), and others use TEXT

Datapoints

This table is a list of datapoints. (IDs)

DB Name in query
MS-SQL iobroker.dbo.datapoints
MySQL iobroker.datapoints
PostgreSQL datapoints
SQLite datapoints

Structure:

Field Type Description
id INTEGER NOT NULL PRIMARY KEY IDENTITY(1,1) unique ID
name varchar(255) / TEXT ID of variable, e.g. hm-rpc.0.JEQ283747.1.STATE
type INTEGER 0 - number, 1 - string, 2 - boolean

Note: MS-SQL uses varchar(255), and others use TEXT

Numbers

Values for states with type "number". ts means "time series".

DB Name in query
MS-SQL iobroker.dbo.ts_number
MySQL iobroker.ts_number
PostgreSQL ts_number
SQLite ts_number

Structure:

Field Type Description
id INTEGER ID of state from "Datapoints" table
ts BIGINT / INTEGER Time in ms till epoch. Can be converted to time with "new Date(ts)"
val REAL Value
ack BIT/BOOLEAN Is acknowledged: 0 - not ack, 1 - ack
_from INTEGER ID of source from "Sources" table
q INTEGER Quality as number. You can find description here

Note: MS-SQL uses BIT, and others use BOOLEAN. SQLite uses for ts INTEGER and all others BIGINT.

Strings

Values for states with type "string".

DB Name in query
MS-SQL iobroker.dbo.ts_string
MySQL iobroker.ts_string
PostgreSQL ts_string
SQLite ts_string

Structure:

Field Type Description
id INTEGER ID of state from "Datapoints" table
ts BIGINT Time in ms till epoch. Can be converted to time with "new Date(ts)"
val TEXT Value
ack BIT/BOOLEAN Is acknowledged: 0 - not ack, 1 - ack
_from INTEGER ID of source from "Sources" table
q INTEGER Quality as number. You can find description here

Note: MS-SQL uses BIT, and others use BOOLEAN. SQLite uses for ts INTEGER and all others BIGINT.

Booleans

Values for states with type "boolean".

DB Name in query
MS-SQL iobroker.dbo.ts_bool
MySQL iobroker.ts_bool
PostgreSQL ts_bool
SQLite ts_bool

Structure:

Field Type Description
id INTEGER ID of state from "Datapoints" table
ts BIGINT Time in ms till epoch. Can be converted to time with "new Date(ts)"
val BIT/BOOLEAN Value
ack BIT/BOOLEAN Is acknowledged: 0 - not ack, 1 - ack
_from INTEGER ID of source from "Sources" table
q INTEGER Quality as number. You can find description here

Note: MS-SQL uses BIT, and others use BOOLEAN. SQLite uses for ts INTEGER and all others BIGINT.

Custom queries

The user can execute custom queries on tables from javascript adapter:

sendTo('sql.0', 'query', 'SELECT * FROM datapoints', function (result) {
    if (result.error) {
        console.error(result.error);
    } else {
        // show result
         console.log('Rows: ' + JSON.stringify(result.result));
    }
});

Or get entries for the last hour for ID=system.adapter.admin.0.memRss

sendTo('sql.0', 'query', 'SELECT id FROM datapoints WHERE name="system.adapter.admin.0.memRss"', function (result) {
    if (result.error) {
        console.error(result.error);
    } else {
        // show result
        console.log('Rows: ' + JSON.stringify(result.result));
        var now = new Date();
        now.setHours(-1);
        sendTo('sql.0', 'query', 'SELECT * FROM ts_number WHERE ts >= ' + now.getTime() + ' AND id=' + result.result[0].id, function (result) {
            console.log('Rows: ' + JSON.stringify(result.result));
        });
    }
});

storeState

If you want to write other data into the InfluxDB you can use the build in system function storeState. This function can also be used to convert data from other History adapters like History or SQL.

The given ids are not checked against the ioBroker database and do not need to be set up there, but can only be accessed directly.

The Message can have one of the following three formats:

  • one ID and one state object
  • one ID and array of state objects
  • array of multiple IDs with state objects

Get history

Additional to custom queries, you can use build in system function getHistory:

var end = new Date().getTime();
sendTo('sql.0', 'getHistory', {
    id: 'system.adapter.admin.0.memRss',
    options: {
        start:      end - 3600000,
        end:        end,
        aggregate: 'minmax' // or 'none' to get raw values
    }
}, function (result) {
    for (var i = 0; i < result.result.length; i++) {
        console.log(result.result[i].id + ' ' + new Date(result.result[i].ts).toISOString());
    }
});

History Logging Management via Javascript

The adapter supports enabling and disabling of history logging via JavaScript and also retrieving the list of enabled datapoints with their settings.

enable

The message requires to have the "id" of the datapoint.Additionally optional "options" to define the datapoint specific settings:

sendTo('sql.0', 'enableHistory', {
    id: 'system.adapter.sql.0.memRss',
    options: {
        changesOnly:  true,
        debounce:     0,
        retention:    31536000,
        maxLength:    3,
        changesMinDelta: 0.5
    }
}, function (result) {
    if (result.error) {
        console.log(result.error);
    }
    if (result.success) {
        //successfull enabled
    }
});

disable

The message requires to have the "id" of the datapoint.

sendTo('sql.0', 'disableHistory', {
    id: 'system.adapter.sql.0.memRss',
}, function (result) {
    if (result.error) {
        console.log(result.error);
    }
    if (result.success) {
        //successfull enabled
    }
});

get List

The message has no parameters.

sendTo('sql.0', 'getEnabledDPs', {}, function (result) {
    //result is object like:
    {
        "system.adapter.sql.0.memRss": {
            "changesOnly":true,
            "debounce":0,
            "retention":31536000,
            "maxLength":3,
            "changesMinDelta":0.5,
            "enabled":true,
            "changesRelogInterval":0
        }
        ...
    }
});

Changelog

1.4.2 (2017-01-16)

  • (bluefox) Fix handling of float values in Adapter config and Datapoint config.

1.4.1

  • (Apollon77) Rollback to sql-client 0.7 to get rid of the mmagic dependecy that brings problems on older systems

1.4.0 (2016-12-02)

  • (Apollon77) Add messages enableHistory/disableHistory
  • (Apollon77) add support to log changes only if value differs a minimum value for numbers

1.3.4 (2016-11)

  • (Apollon77) Allow database names with '-' for MySQL

1.3.3 (2016-11)

  • (Apollon77) Update dependecies

1.3.2 (2016-11-21)

  • (bluefox) Fix insert of string with '

1.3.0 (2016-10-29)

  • (Apollon77) add option to re-log unchanged values to make it easier for visualization

1.2.1 (2016-08-30)

  • (bluefox) Fix selector for SQL objects

1.2.0 (2016-08-30)

  • (bluefox) сompatible only with new admin

1.0.10 (2016-08-27)

  • (bluefox) change name of object from "history" to "custom"

1.0.10 (2016-07-31)

  • (bluefox) fix multi requests if sqlite

1.0.9 (2016-06-14)

  • (bluefox) allow settings for parallel requests

1.0.7 (2016-05-31)

  • (bluefox) draw line to the end if ignore null

1.0.6 (2016-05-30)

  • (bluefox) allow setup DB name for mysql and mssql

1.0.5 (2016-05-29)

  • (bluefox) switch max and min with each other

1.0.4 (2016-05-29)

  • (bluefox) check retention of data if set "never"

1.0.3 (2016-05-28)

  • (bluefox) try to calculate old timestamps

1.0.2 (2016-05-24)

  • (bluefox) fix error with io-package

1.0.1 (2016-05-24)

  • (bluefox) fix error with SQLite

1.0.0 (2016-05-20)

  • (bluefox) change default aggregation name

0.3.3 (2016-05-18)

  • (bluefox) fix postgres

0.3.2 (2016-05-13)

  • (bluefox) queue select if IDs and FROMs queries for sqlite

0.3.1 (2016-05-12)

  • (bluefox) queue delete queries too for sqlite

0.3.0 (2016-05-08)

  • (bluefox) support of custom queries
  • (bluefox) only one request simultaneously for sqlite
  • (bluefox) add tests (primitive and only sql)

0.2.0 (2016-04-30)

  • (bluefox) support of milliseconds
  • (bluefox) fix sqlite

0.1.4 (2016-04-25)

  • (bluefox) fix deletion of old entries

0.1.3 (2016-03-08)

  • (bluefox) do not print errors twice

0.1.2 (2015-12-22)

  • (bluefox) fix MS-SQL port settings

0.1.1 (2015-12-19)

  • (bluefox) fix error with double entries

0.1.0 (2015-12-14)

  • (bluefox) support of strings

0.0.3 (2015-12-06)

  • (smiling_Jack) Add demo Data ( todo: faster insert to db )
  • (smiling_Jack) change aggregation (now same as history Adapter)
  • (bluefox) bug fixing

0.0.2 (2015-12-06)

  • (bluefox) allow only 1 client for SQLite

0.0.1 (2015-11-19)

  • (bluefox) initial commit

License

The MIT License (MIT)

Copyright (c) 2015 bluefox

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.