Some hyperfunctions are included by default in Timescale. For additional hyperfunctions, you need to install the TimescaleDB Toolkit PostgreSQL extension.
If you're using Timescale, the Toolkit is already installed.
On Managed Service for TimescaleDB, run this command on each database you want to use the Toolkit with:
CREATE EXTENSION timescaledb_toolkit;
Update an installed version of the Toolkit using this command:
ALTER EXTENSION timescaledb_toolkit UPDATE;
If you're hosting your own TimescaleDB database, you can install Toolkit by:
- Using the TimescaleDB high-availability Docker image
- Using a package manager such as
yum,apt, orbrewon platforms where pre-built binaries are available - Building from source
The recommended way to install the Toolkit is to use the
TimescaleDB Docker image.
To get Toolkit, use the high availability image, timescaledb-ha:
docker pull timescale/timescaledb-ha:pg17
For more information on running TimescaleDB using Docker, see the section on pre-built containers.
These instructions use the yum package manager. They have been tested on
CentOS 7 and may also work on other Red Hat-based systems, such as Red Hat
Enterprise Linux and Fedora.
Make sure you have installed TimescaleDB and created a TimescaleDB repository in your
yumrepo.ddirectory. For more information, see the instructions for Red Hat-based systems.Update your local repository list:
yum updateInstall TimescaleDB Toolkit:
yum install timescaledb-toolkit-postgresql-16Connect to the database where you want to use Toolkit.
Create the Toolkit extension in the database:
CREATE EXTENSION timescaledb_toolkit;
These instructions use the apt package manager. They have been tested on Ubuntu 20.04
and may also work on other Debian-based systems.
Make sure you have installed TimescaleDB and added the TimescaleDB repository and GPG key. For more information, see the instructions for Debian-based systems.
Update your local repository list:
apt updateInstall TimescaleDB Toolkit:
apt install timescaledb-toolkit-postgresql-16Connect to the database where you want to use Toolkit.
Create the Toolkit extension in the database:
CREATE EXTENSION timescaledb_toolkit;
These instructions use the brew package manager. For more information on
installing or using Homebrew, see the brew homepage.
Tap the Timescale formula repository, which also contains formulae for TimescaleDB and
timescaledb-tune.brew tap timescale/tapUpdate your local brew installation:
brew updateInstall TimescaleDB Toolkit:
brew install timescaledb-toolkitConnect to the database where you want to use Toolkit.
Create the Toolkit extension in the database:
CREATE EXTENSION timescaledb_toolkit;
TimescaleDB Toolkit isn't currently supported on Windows. As a workaround, you can run PostgreSQL in a Docker container.
Update Toolkit by installing the latest version and running ALTER EXTENSION.
Update your local repository list:
Install the latest version of TimescaleDB Toolkit:
Connect to the database where you want to use the new version of Toolkit.
Update the Toolkit extension in the database:
ALTER EXTENSION timescaledb_toolkit UPDATE;
Note
For some Toolkit versions, you might need to disconnect and reconnect active sessions.
You can build Toolkit from source. For more information, see the Toolkit developer documentation.
Keywords
Found an issue on this page?Report an issue or Edit this page in GitHub.