Versions:

API Reference tag overview

The Timescale API Reference uses tags to categorize functions. The tags are Community, Experimental, Toolkit, and Experimental (Toolkit). This section explains each tag.

Community

This tag indicates that the function is available under the TimescaleDB Community license, and are not available under the Apache 2 license. For more information, visit our TimescaleDB License comparison sheet.

Experimental (TimescaleDB Experimental Schema)

This tag indicates that the function is included in the TimescaleDB experimental schema. Do not use experimental functions in production. Experimental features could include bugs, and are likely to change in future versions. The experimental schema is is used by Timescale to develop new features more quickly. If experimental functions are successful, they can move out of the experimental schema and go into production use. For more information about the experimental schema, read the Timescale blog post.

Toolkit

This tag indicates that the function is included in the TimescaleDB Toolkit extension. Toolkit functions are available under the Timescale Community Edition license. For installation instructions, see the installation guide.

Experimental (TimescaleDB Toolkit)

This tag is used with the Toolkit tag. It indicates a Toolkit function that is under active development. Do not use experimental toolkit functions in production. Experimental toolkit functions could include bugs, and are likely to change in future versions. These functions might not correctly handle unusual use cases or errors, and they could have poor performance. Updates to the TimescaleDB extension drop database objects that depend on experimental features like this function. If you use experimental toolkit functions on Timescale Cloud, this function is automatically dropped when the Toolkit extension is updated. For more information, see the TimescaleDB Toolkit docs.

Found an issue on this page?

Report an issue!

Related Content