TimescaleDB API 참조

TimescaleDB API 참조 (API Reference)

TimescaleDB API 참조는 시계열 데이터 관리를 위한 모든 함수·SQL 명령·유틸리티의 완전한 문서예요. 하이퍼테이블, 청크, 연속 집계, 하이퍼펑션, 데이터 보존, 작업 자동화까지 카테고리별로 정리돼 있어요.

개발할 때는 기능을 구현하기 전에 이 API 참조에서 정확한 함수 이름과 파라미터를 확인하는 게 좋아요. 각 함수는 시그니처와 예시를 함께 제공해요.

출처: https://docs.timescale.com/api/latest/

카테고리 구성

하이퍼테이블과 청크 (Hypertables and chunks)

create_hypertable() — 일반 테이블을 하이퍼테이블로 변환.
add_dimension() — 공간 차원 추가.
set_chunk_time_interval() — 청크 간격 변경.
drop_chunks() — 오래된 청크 삭제.
show_chunks() — 청크 목록 확인.
차원·인덱스·메타데이터 관리를 위한 함수들.

연속 집계 (Continuous aggregates)

create_continuous_aggregate() — 자동 갱신 materialized view 생성.
refresh_continuous_aggregate() — 수동 갱신.
add_continuous_aggregate_policy() — 갱신 정책.
관리·상태 확인 함수들.

하이퍼펑션 (Hyperfunctions)

time_bucket(), time_bucket_gapfill() — 시간 버케팅·갭필링.
first(), last(), delta() 등 — 시계열 값 분석.
분포·백분위 분석 함수들.

데이터 보존 (Data retention)

add_retention_policy() — 자동 보존 정책.
remove_retention_policy() — 정책 제거.
drop_chunks() — 수동 청크 삭제.

작업과 자동화 (Jobs and automation)

백그라운드 작업 스케줄러 관련 함수들.

기타

UUIDv7 함수
정보 뷰(informational views) — 하이퍼테이블·청크·작업 메타데이터 조회.
설정(Configuration) — TimescaleDB 파라미터.
관리(Administration) — 백업·복원·시스템 관리.

사용 예시

하이퍼테이블과 집계를 만들 때는 보통 이 패턴을 써요.

SELECT create_hypertable('metrics', 'time');
SELECT create_continuous_aggregate('metrics_hourly',
    'SELECT time_bucket(''1 hour'', time) AS bucket, avg(value)
     FROM metrics GROUP BY bucket');