Install and update TimescaleDB Toolkit

Some hyperfunctions are included in the default TimescaleDB product. For additional hyperfunctions, you need to install the TimescaleDB Toolkit PostgreSQL extension.

If you’re using Timescale Cloud, the Toolkit is already installed.

Install and update Toolkit on Managed Service for TimescaleDB

On Managed Service for TimescaleDB, run this command on each database you want to use the Toolkit with:

  2. CREATE EXTENSION timescaledb_toolkit;

Update an installed version of the Toolkit using this command:

  2. ALTER EXTENSION timescaledb_toolkit UPDATE;

Install Toolkit on self-hosted TimescaleDB

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, or brew on platforms where pre-built binaries are available
  • Building from source

Install Docker image

The recommended way to install the Toolkit is to use the TimescaleDB Docker image. To get Toolkit, use the high availability image, timescaledb-ha:

  2. docker pull timescale/timescaledb-ha:pg14-latest
important

The timescaledb-ha image does not support ARM64. For ARM64 environments, use the timescaledb Docker image. By default, this image does not contain Toolkit. You can add Toolkit using the package installation method, or by building from source.

For more information on running TimescaleDB using Docker, see the section on pre-built containers.

Install Toolkit on CentOS 7 and other Red Hat-based systems

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.

Installing Toolkit on CentOS 7

  1. Make sure you have installed TimescaleDB and created a TimescaleDB repository in your yum repo.d directory. For more information, see the instructions for Red Hat-based systems.

  2. Update your local repository list:

    1. yum update

  3. Install TimescaleDB Toolkit:

    1. yum install timescaledb-toolkit-postgresql-14

  4. Connect to the database where you want to use Toolkit.

  5. Create the Toolkit extension in the database:

    1. CREATE EXTENSION timescaledb_toolkit;

Install Toolkit on Ubuntu and other Debian-based systems

These instructions use the apt package manager. They have been tested on Ubuntu 20.04 and may also work on other Debian-based systems.

Installing Toolkit on Ubuntu 20.04

  1. Make sure you have installed TimescaleDB and added the TimescaleDB repository and GPG key. For more information, see the instructions for Debian-based systems.

  2. Update your local repository list:

    1. apt update

  3. Install TimescaleDB Toolkit:

    1. apt install timescaledb-toolkit-postgresql-14

  4. Connect to the database where you want to use Toolkit.

  5. Create the Toolkit extension in the database:

    1. CREATE EXTENSION timescaledb_toolkit;

Install Toolkit on macOS

These instructions use the brew package manager. For more information on installing or using Homebrew, see the brew homepage.

Installing Toolkit on macOS

  1. Tap the Timescale formula repository, which also contains formulae for TimescaleDB and timescaledb-tune.

    1. brew tap timescale/tap

  2. Update your local brew installation:

    1. brew update

  3. Install TimescaleDB Toolkit:

    1. brew install timescaledb-toolkit

  4. Connect to the database where you want to use Toolkit.

  5. Create the Toolkit extension in the database:

    1. CREATE EXTENSION timescaledb_toolkit;

Install Toolkit on Windows

TimescaleDB Toolkit isn’t currently supported on Windows. As a workaround, you can run PostgreSQL in a Docker container.

Update Toolkit on self-hosted TimescaleDB

Update Toolkit by installing the latest version and running ALTER EXTENSION.

Updating Toolkit on self-hosted TimescaleDB

  1. Update your local repository list:

  2. Install the latest version of TimescaleDB Toolkit:

  3. Connect to the database where you want to use the new version of Toolkit.

  4. Update the Toolkit extension in the database:

    1. ALTER EXTENSION timescaledb_toolkit UPDATE;
note

For some Toolkit versions, you might need to disconnect and reconnect active sessions.

Build Toolkit from source

You can build Toolkit from source. For more information, see the Toolkit developer documentation.