Skip to content

timescaledb.md

Latest commit

 

History

History
93 lines (66 loc) · 3.76 KB

timescaledb.md

File metadata and controls

93 lines (66 loc) · 3.76 KB
Raw
description TimescaleDB with pREST — hypertables over the Postgres wire, auto-detect adapter in v2.3.0 (#999), _time_bucket, REST and MCP.

TimescaleDB

TimescaleDB is a PostgreSQL extension for time-series workloads. pREST treats it as Compatible with caveats: connect like PostgreSQL, use hypertables as tables, and use Timescale-aware operators when the Timescale adapter is selected.

Last updated: July 22, 2026 · Label: Compatible with caveats

{% hint style="info" %} v2.2.0+: E2E coverage on the native PostgreSQL adapter (#988). See v2.2.0.

v2.3.0 (#999): pREST auto-detects Timescale (extension check) and selects a Timescale adapter with _time_bucket and system-schema filtering. Still not a separate dialect family — wire-compatible with PostgreSQL. MySQL/SQLite multi-adapter is roadmap. See v2.3.0. {% endhint %}

Full Compose example: Integrations — TimescaleDB. Prefer timescale/timescaledb:latest-pg18 and CREATE EXTENSION IF NOT EXISTS timescaledb.

Supported features

Capability Status
Connection supported (Postgres protocol)
Schema discovery supported — hypertables; _timescaledb_* hidden by default on Timescale adapter (v2.3.0)
CRUD supported on underlying relations; hypertable semantics apply
Filtering / ordering / pagination supported
_time_bucket v2.3.0 / #999 — Timescale adapter only (5m…1y)
Transactions supported (PostgreSQL)
Scripts (/_QUERIES) supported — preferred for policies, continuous-aggregate DDL
MCP (/_mcp) supported (v2.1.0+) for readable relations
ACL / permissions supported

Connection

Same as PostgreSQL — point PREST_PG_* / PREST_PG_URL at a TimescaleDB (or Timescale Cloud) instance, or register an alias in Multi-database.

export PREST_VERSION=2
export PREST_PG_HOST=timescaledb
export PREST_PG_USER=prest
export PREST_PG_PASS=prest
export PREST_PG_DATABASE=prest
export PREST_PG_SSL_MODE=disable

Since v2.3.0 (#999), startup tries the Timescale adapter first, then falls back to Postgres.

Time bucketing (v2.3.0)

curl "http://localhost:3000/prest/public/readings?_time_bucket=1h"
curl "http://localhost:3000/prest/public/readings?_time_bucket=1h,measured_at"

Intervals: 5m, 15m, 1h, 6h, 1d, 7d, 30d, 1y. Include Timescale system schemas with _include_system_schemas=true.

MCP and REST

Known limitations

  • Stock Postgres adapter (v2.2.0 and earlier) does not implement _time_bucket — use /_QUERIES or upgrade to v2.3.0 (#999).
  • Compression, retention policies, and continuous-aggregate DDL stay outside generic CRUD.
  • Catalog listing may include hypertables and chunk children; use ACL / expose settings as needed.
  • Use a PostgreSQL version Timescale supports for your image/cloud tier (docs examples use PG 18 images).

Related