TimescaleDB Toolkit

This repository is the home of the TimescaleDB Toolkit team. Our mission is to ease all things analytics when using TimescaleDB, with a particular focus on developer ergonomics and performance. Our issue tracker contains more on the features we're planning to work on and the problems we're trying to solve, and our Discussions forum contains ongoing conversation.

Documentation for this version of the TimescaleDB Toolkit extension can be found in this repository at docs.

🖥 Try It Out

The extension comes pre-installed on all Timescale Forge instances, and also on our full-featured timescale/timescaledb-ha docker image.

We also provide nightly builds as a docker images in timescaledev/timescaledb-toolkit:nightly.

All versions of the extension contain experimental features in the toolkit_experimental, schema see our docs section on experimental features for more details.

💿 Installing From Source

🔧 Tools Setup

Building the extension requires valid rust, rustfmt, and clang installs, along with the postgres headers for whichever version of postgres you are running, and pgx. We recommend installing rust using the official instructions:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

and build tools, the postgres headers, in the preferred manner for your system. You may also need to install OpenSSl. For Ubuntu you can follow the postgres install instructions then run

sudo apt-get install make gcc pkg-config clang postgresql-server-dev-13 libssl-dev

and finally, the toolkit uses a fork of pgx while our patches are being upstreamed. It can be installed with

cargo install --git https://github.com/JLockerman/pgx.git --branch timescale cargo-pgx && \
cargo pgx init --pg13 pg_config

💾 Building and Installing the extension

Download or clone this repository, and switch to the extension subdirectory, e.g.

git clone https://github.com/timescale/timescale-analytics && \
cd timescale-analytics/extension

Then run

cargo pgx install --release && \
cargo run --manifest-path ../tools/post-install/Cargo.toml -- pg_config

✏️ Get Involved

The TimescaleDB Toolkit project is still in the initial planning stage as we decide our priorities and what to implement first. As such, now is a great time to help shape the project's direction! Have a look at the list of features we're thinking of working on and feel free to comment on the features, expand the list, or hop on the Discussions forum for more in-depth discussions.

🔨 Building

Building the extension requires a valid rust install see the website for instructions.

The extension is built using a fork of pgx. To install pgx use

cargo install --git https://github.com/JLockerman/pgx.git --branch timescale cargo-pgx && \
cargo pgx init

Once you have pgx installed, clone this repo and swich into the extension directory, e.g

cd timescaledb_toolkit/extension

you can run tests against a postgres version pg12, or pg13 using

cargo pgx test ${postgres_version}

to install the extension to a postgres install locatable using pg_config use

cargo pgx install --release

🐯 About TimescaleDB

TimescaleDB is a distributed time-series database built on PostgreSQL that scales to over 10 million of metrics per second, supports native compression, handles high cardinality, and offers native time-series capabilities, such as data-retention policies, continuous aggregate views, downsampling, data gap-filling and interpolation.

TimescaleDB also supports full SQL, a variety of data types (numerics, text, arrays, JSON, booleans), and ACID semantics. Operationally mature capabilities include high availability, streaming backups, upgrades over time, roles and permissions, and security.

TimescaleDB has a large and active user community (tens of millions of downloads, hundreds of thousands of active deployments, Slack channel with thousands of members).

k-bx / timescaledb-toolkit Goto Github PK