Install self-hosted TimescaleDB on macOS systems

  • Apple macOS 10.15 Catalina
  • Apple macOS 11 Big Sur
  • Apple macOS 12 Monterey
important

Before you begin installing TimescaleDB, make sure you have installed PostgreSQL version 12 or later.

warning

If you have already installed PostgreSQL using a method other than Homebrew, you could encounter errors following these instructions. It is safest to remove any existing PostgreSQL installations before you begin. If you want to keep your current PostgreSQL installation, do not install TimescaleDB using this method. Install from source instead.

You can use Homebrew to install TimescaleDB on macOS-based systems.

  1. Install Homebrew, if you don’t already have it:

    For more information about Homebrew, including installation instructions, see the .

  2. At the command prompt, add the Timescale Homebrew tap:

  3. Run the timescaledb-tune script to configure your database:

    1. timescaledb-tune --quiet --yes

  4. Change to the directory where the setup script is located. It is typically, located at /opt/homebrew/Cellar/timescaledb/<VERSION>/bin/, where <VERSION> is the version of timescaledb that you installed:

    1. cd /opt/homebrew/Cellar/timescaledb/<VERSION>/bin/

  5. Run the setup script to complete installation.

    1. ./timescaledb_move.sh

Installing psql using Homebrew

  1. Install psql:

  2. Update your path to include the psql tool.

    1. brew link --force libpq

    On Intel chips, the symbolic link is added to /usr/local/bin. On Apple Silicon, the symbolic link is added to .

You can use MacPorts to install TimescaleDB on macOS-based systems.

  1. Install MacPorts by downloading and running the package installer. For more information about MacPorts, including installation instructions, see the .

  2. Install TimescaleDB:

    1. sudo port install timescaledb

  3. OptionalView the files that were installed:

    1. port contents timescaledb
important

MacPorts does not install the timescaledb-tools to run the timescaledb-tune script. For more information about installing and using the tool, see section.

When you have PostgreSQL and TimescaleDB installed, you can connect to it from your local system using the psql command-line utility.

Installing psql using MacPorts

  1. Install the latest version of libpqxx:

    1. sudo port install libpqxx

    Connect to PostgreSQL from your local system using the psql command-line utility and set up the TimescaleDB extension.

    1. On your local system, at the command prompt, connect to the PostgreSQL instance as the postgres superuser:

      If your connection is successful, you’ll see a message like this, followed by the psql prompt:

      1. psql (14.4)

    2. At the psql prompt, create an empty database named tsdb:

      1. CREATE database tsdb;

    3. Connect to the tsdb database that you created:

      1. \c tsdb

    4. Add the TimescaleDB extension:

      1. CREATE EXTENSION IF NOT EXISTS timescaledb;

    5. Check that the TimescaleDB extension is installed by using the \dx command at the psql prompt. Output is similar to:

      1. tsdb-# \dx
      3.                                       List of installed extensions
      5.     Name     | Version |   Schema   |                            Description

    After you have created the extension and the database, you can connect to your database directly using this command:

    2. psql -U postgres -h localhost -d tsdb

    Now that you have your first TimescaleDB database up and running, you can check out the TimescaleDB section, and find out what you can do with it.

    If you want to work through some tutorials to help you get up and running with TimescaleDB and time-series data, check out the section.