Skip to main content

​
Dashboard Configuration

This extension requires activation via the PlanetScale Dashboard before it can be used. It must be enabled through shared libraries and requires a database restart. To enable TimescaleDB:
1
From the PlanetScale organization dashboard, select the desired database
2
Navigate to the Cluster configuration page from the menu on the left
3
Choose the branch whose extensions you’d like to configure in the “Branch” dropdown
4
Select the Extensions tab
5
Enable timescaledb and configure its parameters
6
Click Queue extension changes to apply the configuration
7
Once you’re ready to apply the changes, click “Apply changes”

​
Usage

After enabling the extension through the dashboard, you’ll be able to install it in your Postgres cluster: 
CREATE EXTENSION IF NOT EXISTS timescaledb;

​
External Documentation

For more detailed information about TimescaleDB usage, see the official documentation.

​
Parameters

​
timescaledb.enable_chunk_append

  • Type: Boolean
  • Default: true
  • Description: Enable chunk append node

​
timescaledb.enable_chunk_skipping

  • Type: Boolean
  • Default: false
  • Description: Enable chunk skipping functionality

​
timescaledb.enable_constraint_aware_append

  • Type: Boolean
  • Default: true
  • Description: Enable constraint-aware append scans

​
timescaledb.enable_constraint_exclusion

  • Type: Boolean
  • Default: true
  • Description: Enable constraint exclusion

​
timescaledb.enable_custom_hashagg

  • Type: Boolean
  • Default: false
  • Description: Enable custom hash aggregation

​
timescaledb.enable_deprecation_warnings

  • Type: Boolean
  • Default: true
  • Description: Enable warnings when using deprecated functionality

​
timescaledb.enable_event_triggers

  • Type: Boolean
  • Default: false
  • Description: Enable event triggers for chunks creation

​
timescaledb.enable_foreign_key_propagation

  • Type: Boolean
  • Default: true
  • Description: Enable foreign key propagation

​
timescaledb.enable_job_execution_logging

  • Type: Boolean
  • Default: false
  • Description: Enable job execution logging

​
timescaledb.enable_now_constify

  • Type: Boolean
  • Default: true
  • Description: Enable now() constify

​
timescaledb.enable_optimizations

  • Type: Boolean
  • Default: true
  • Description: Enable TimescaleDB query optimizations

​
timescaledb.enable_ordered_append

  • Type: Boolean
  • Default: true
  • Description: Enable ordered append scans

​
timescaledb.enable_parallel_chunk_append

  • Type: Boolean
  • Default: true
  • Description: Enable parallel chunk append node

​
timescaledb.enable_qual_propagation

  • Type: Boolean
  • Default: true
  • Description: Enable qualifier propagation

​
timescaledb.enable_runtime_exclusion

  • Type: Boolean
  • Default: true
  • Description: Enable runtime chunk exclusion

​
timescaledb.enable_tiered_reads

  • Type: Boolean
  • Default: true
  • Description: Enable tiered data reads

​
timescaledb.enable_tss_callbacks

  • Type: Boolean
  • Default: true
  • Description: Enable ts_stat_statements callbacks

​
timescaledb.max_cached_chunks_per_hypertable

  • Type: Integer
  • Default: 1024
  • Min: 0
  • Max: 65536
  • Description: Maximum cached chunks

​
timescaledb.max_open_chunks_per_insert

  • Type: Integer
  • Default: 1024
  • Min: 0
  • Max: 32767
  • Description: Maximum open chunks per insert

​
timescaledb.restoring

  • Type: Boolean
  • Default: false
  • Description: Enable restoring mode for TimescaleDB