Skip to main content

Create Hypertable

Creates a hypertable in TimescaleDB.

This node is also exposed as an AI Agent tool.

This node has 1 input port and 1 output port.

Common Properties​

Every node shares these.

  • Name — the node's display name on the canvas.
  • Color — the node's colour on the canvas.
  • Delay Before (sec) — wait this long before the node runs.
  • Delay After (sec) — wait this long after the node runs.
  • Continue On Error — carry on instead of failing the flow. Defaults to false.
info

When Continue On Error is true the error is not raised at all, so a Catch node will not see it either.

Inputs​

PropertyFieldDescription
Client IDinClientIDClient ID from Connect node
Table NameinTableName of the existing table to convert to a hypertable
Time ColumninTimeColumnName of the time column to partition by (e.g. time，created_at，timestamp)

Outputs​

PropertyFieldDescription
ResultoutResultResult details from create_hypertable
SuccessoutSuccessWhether the hypertable was created successfully

Options​

PropertyFieldDescription
Chunk Time IntervaloptChunkIntervalSize of each time chunk (e.g. 1 day，7 days，1 hour). Default: 7 days
CredentialsoptCredentialsTimescaleDB credentials (optional if using Connect node)
If Not ExistsoptIfNotExistsDo not error if hypertable already exists
Migrate DataoptMigrateDataMigrate existing data in the table into chunks
Timeout (seconds)optTimeoutMaximum time in seconds to wait

Requirements​

  • A Client ID from this package's Connect node, unless you set credentials directly on this node.

Drop Chunks · Enable Compression

Elsewhere in the package: Connect · Disconnect · Execute Query · Insert Data · Query Data · Create Continuous Aggregate · Refresh Continuous Aggregate · Toolkit

See also​