Upgrading ThingsBoard CE to 3.1.1
NOTE: These upgrade steps are applicable for ThingsBoard version 3.1. In order to upgrade to 3.1.1 you need to upgrade to 3.1 first.
ThingsBoard package download
Download ThingsBoard installation archive for Windows: thingsboard-windows-3.1.1.zip.
ThingsBoard service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
-
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Remove ThingsBoard install dir.
- Unzip installation archive to ThingsBoard install dir.
- Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- Please make sure that you set database.ts.type parameter value (in the file <ThingsBoard install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4
database:
ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
ts:
type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
- Finally, run upgrade.bat script to upgrade ThingsBoard to the new version.
NOTE Scripts listed above should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\thingsboard>upgrade.bat --fromVersion=3.1.0
Start the service
If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.
Connect to your Redis instance (or container/pod, depending on your setup) and run the command:
redis-cli flushall
Please note that this command is applicable only if you use Redis exclusively for ThingsBoard. If other applications use Redis, you need to locate the ThingsBoard database and flush only that. The default database index is 0, configurable with REDIS_DB ThingsBoard environment value.
redis-cli
select 0
flushdb
If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.
Connect to your Redis instance (or container/pod, depending on your setup) and run the command:
redis-cli flushall
Please note that this command is applicable only if you use Redis exclusively for ThingsBoard. If other applications use Redis, you need to locate the ThingsBoard database and flush only that. The default database index is 0, configurable with REDIS_DB ThingsBoard environment value.
redis-cli
select 0
flushdb
1
net start thingsboard
Upgrading ThingsBoard CE to 3.1
NOTE: These upgrade steps are applicable for ThingsBoard version 3.0.1. In order to upgrade to 3.1 you need to upgrade to 3.0.1 first.
ThingsBoard package download
Download ThingsBoard installation archive for Windows: thingsboard-windows-3.1.zip.
ThingsBoard service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
-
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Remove ThingsBoard install dir.
- Unzip installation archive to ThingsBoard install dir.
- Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- Please make sure that you set database.ts.type parameter value (in the file <ThingsBoard install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4
database:
ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
ts:
type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
- Finally, run upgrade.bat script to upgrade ThingsBoard to the new version.
NOTE Scripts listed above should be executed using Administrator Role.
NOTE: If you were using Cassandra database for entities data execute the following migration script:
1
C:\thingsboard>upgrade.bat --fromVersion=cassandra-latest-to-postgres
Execute regular upgrade script:
1
C:\thingsboard>upgrade.bat --fromVersion=3.0.1
Start the service
If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.
Connect to your Redis instance (or container/pod, depending on your setup) and run the command:
redis-cli flushall
Please note that this command is applicable only if you use Redis exclusively for ThingsBoard. If other applications use Redis, you need to locate the ThingsBoard database and flush only that. The default database index is 0, configurable with REDIS_DB ThingsBoard environment value.
redis-cli
select 0
flushdb
If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.
Connect to your Redis instance (or container/pod, depending on your setup) and run the command:
redis-cli flushall
Please note that this command is applicable only if you use Redis exclusively for ThingsBoard. If other applications use Redis, you need to locate the ThingsBoard database and flush only that. The default database index is 0, configurable with REDIS_DB ThingsBoard environment value.
redis-cli
select 0
flushdb
1
net start thingsboard