Hyperfunctions

Reference list of all available TimescaleDB hyperfunctions

includes all hyperfunctions by default, while self-hosted includes a subset of them. For additional hyperfunctions, install the extension.

Available hyperfunctions

Hyperfunctions are organized by their analytical purpose. Functions marked with ✓ in the Toolkit column require an installation of for self-hosted deployments. Functions marked with ✓ in the Experimental column are still under development.

Experimental hyperfunctions are still under active development and subject to change. When you upgrade to a new version of , experimental features might have changed or been removed. Be prepared to update your code if you use experimental hyperfunctions.

Approximate count distinct functions

hyperloglog() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	hyperloglog()	✓
Alternate aggregate	approx_count_distinct()	✓
Accessor	distinct_count()	✓
Accessor	stderror()	✓
Rollup	rollup()	✓

Counters and gauges functions

counter_agg() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	counter_agg()	✓
Accessor	corr()	✓
Accessor	delta()	✓
Accessor	extrapolated_rate()	✓
Accessor	counter_zero_time()	✓
Accessor	first_time()	✓
Accessor	first_val()	✓
Accessor	extrapolated_delta()	✓
Accessor	idelta_right()	✓
Accessor	idelta_left()	✓
Accessor	interpolated_rate()	✓
Accessor	intercept()	✓
Accessor	irate_right()	✓
Accessor	irate_left()	✓
Accessor	interpolated_delta()	✓
Accessor	num_changes()	✓
Accessor	last_time()	✓
Accessor	last_val()	✓
Accessor	num_resets()	✓
Accessor	rate()	✓
Accessor	time_delta()	✓
Accessor	slope()	✓
Accessor	num_elements()	✓
Mutator	with_bounds()	✓
Rollup	rollup()	✓

gauge_agg() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	gauge_agg()	✓	✓
Accessor	delta()	✓	✓
Accessor	extrapolated_delta()	✓	✓
Accessor	extrapolated_rate()	✓	✓
Accessor	gauge_zero_time()	✓	✓
Accessor	corr()	✓	✓
Accessor	intercept()	✓	✓
Accessor	idelta_left()	✓	✓
Accessor	interpolated_rate()	✓	✓
Accessor	interpolated_delta()	✓	✓
Accessor	idelta_right()	✓	✓
Accessor	irate_left()	✓	✓
Accessor	num_changes()	✓	✓
Accessor	num_elements()	✓	✓
Accessor	irate_right()	✓	✓
Accessor	rate()	✓	✓
Accessor	time_delta()	✓	✓
Accessor	slope()	✓	✓
Rollup	rollup()	✓	✓
Mutator	with_bounds()	✓	✓

Downsampling functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Function	asap_smooth()	✓
Function	gp_lttb()	✓	✓
Function	lttb()	✓

Financial analysis functions

candlestick_agg() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	candlestick_agg()	✓
Pseudo aggregate	candlestick()	✓
Accessor	close()	✓
Accessor	close_time()	✓
Accessor	high()	✓
Accessor	low_time()	✓
Accessor	open()	✓
Accessor	open_time()	✓
Accessor	volume()	✓
Accessor	low()	✓
Accessor	vwap()	✓
Accessor	high_time()	✓
Rollup	rollup()	✓

Frequency analysis functions

count_min_sketch() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	count_min_sketch()	✓	✓
Accessor	approx_count()	✓	✓

freq_agg() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	freq_agg()	✓	✓
Accessor	into_values()	✓
Accessor	max_frequency()	✓
Accessor	min_frequency()	✓
Accessor	topn()	✓
Alternate aggregate	mcv_agg()	✓
Rollup	rollup()	✓

Gapfilling functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Bucket	time_bucket_gapfill()
Interpolator	locf()
Interpolator	interpolate()

Minimum and maximum functions

max_n() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	max_n()	✓
Accessor	into_array()	✓
Accessor	into_values()	✓
Rollup	rollup()	✓

max_n_by() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	max_n_by()	✓
Accessor	into_values()	✓
Rollup	rollup()	✓

min_n() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	min_n()	✓
Accessor	into_array()	✓
Accessor	into_values()	✓
Rollup	rollup()	✓

min_n_by() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	min_n_by()	✓
Rollup	rollup()	✓
Accessor	into_values()	✓

Percentile approximation functions

tdigest() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	tdigest()	✓
Accessor	approx_percentile_rank()	✓
Accessor	approx_percentile()	✓
Accessor	mean()	✓
Accessor	num_vals()	✓
Rollup	rollup()	✓

uddsketch() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	uddsketch()	✓
Accessor	approx_percentile()	✓
Accessor	approx_percentile_array()	✓
Accessor	approx_percentile_rank()	✓
Accessor	error()	✓
Accessor	mean()	✓
Accessor	num_vals()	✓
Alternate aggregate	percentile_agg()	✓
Rollup	rollup()	✓

Saturating math functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Function	saturating_add()	✓	✓
Function	saturating_mul()	✓	✓
Function	saturating_sub_pos()	✓	✓
Function	saturating_sub()	✓	✓
Function	saturating_add_pos()	✓	✓

State tracking functions

compact_state_agg() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	compact_state_agg()	✓	✓
Rollup	rollup()	✓	✓
Accessor	into_values()	✓	✓
Accessor	duration_in()	✓	✓
Accessor	interpolated_duration_in()	✓	✓

heartbeat_agg() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	heartbeat_agg()	✓
Accessor	dead_ranges()	✓
Accessor	downtime()	✓
Accessor	interpolated_downtime()	✓
Accessor	interpolated_uptime()	✓
Accessor	interpolate()	✓
Accessor	live_at()	✓
Accessor	num_live_ranges()	✓
Accessor	live_ranges()	✓
Accessor	uptime()	✓
Accessor	trim_to()	✓
Accessor	num_gaps()	✓
Rollup	rollup()	✓

state_agg() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	state_agg()	✓
Accessor	interpolated_state_periods()	✓
Accessor	interpolated_state_timeline()	✓
Accessor	into_values()	✓
Accessor	state_periods()	✓
Accessor	state_timeline()	✓
Accessor	state_at()	✓
Accessor	duration_in()	✓
Accessor	interpolated_duration_in()	✓
Rollup	rollup()	✓

Statistical and regression analysis functions

stats_agg() (one variable) functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	stats_agg() (one variable)	✓
Accessor	average()	✓
Accessor	num_vals()	✓
Accessor	kurtosis()	✓
Accessor	skewness()	✓
Accessor	sum()	✓
Accessor	stddev()	✓
Accessor	variance()	✓
Rollup	rollup()	✓
Rollup	rolling()	✓

stats_agg() (two variables) functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	stats_agg() (two variables)	✓
Accessor	average_y(), average_x()	✓
Accessor	covariance()	✓
Accessor	corr()	✓
Accessor	determination_coeff()	✓
Accessor	intercept()	✓
Accessor	kurtosis_y(), kurtosis_x()	✓
Accessor	num_vals()	✓
Accessor	slope()	✓
Accessor	skewness_y(), skewness_x()	✓
Accessor	variance_y(), variance_x()	✓
Accessor	sum_y(), sum_x()	✓
Accessor	stddev_y(), stddev_x()	✓
Accessor	x_intercept()	✓
Rollup	rolling()	✓
Rollup	rollup()	✓

Time weighted calculations functions

time_weight() functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	time_weight()	✓
Accessor	average()	✓
Accessor	first_time()	✓
Accessor	first_val()	✓
Accessor	integral()	✓
Accessor	last_time()	✓
Accessor	last_val()	✓
Accessor	interpolated_average()	✓
Accessor	interpolated_integral()	✓
Rollup	rollup()	✓

Timevector functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Aggregate	timevector()	✓	✓
Accessor	unnest()	✓	✓
Rollup	rollup()	✓	✓

General functions

Hyperfunction type	Hyperfunction name	Toolkit	Experimental
Bucket	time_bucket()
Bucket	timescaledb_experimental.time_bucket_ng()		✓
One step aggregate	approximate_row_count()
One step aggregate	histogram()
One step aggregate	first()
One step aggregate	last()
One step operation	days_in_month()	✓
One step operation	month_normalize()	✓

For more information about each hyperfunction, see the TimescaleDB API documentation and TimescaleDB Toolkit API documentation.

For detailed usage examples, see the hyperfunctions features documentation.