Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

2.0 KB
Raw Blame
/**
 * Every DateTime / DateTime64 column Rybbit stores in ClickHouse, with the
 * UTC-pinned type the CREATE statements declare. The startup migration
 * (ensureUtcTimeColumns) uses this to heal tables created before the timezone
 * was explicit. Types must match the CREATE statements in schema/*.ts exactly.
 */
export type TimeColumnDefinition = {
  name: string;
  /** The full target type, e.g. `DateTime('UTC')` or `SimpleAggregateFunction(min, DateTime64(3, 'UTC'))`. */
  type: string;
};

const EVENT_HOUR: TimeColumnDefinition[] = [{ name: "event_hour", type: "DateTime('UTC')" }];

export const UTC_TIME_COLUMNS = {
  events: [
    { name: "timestamp", type: "DateTime('UTC')" },
    { name: "timestamp_ms", type: "DateTime64(3, 'UTC')" },
  ],
  bot_events: [{ name: "timestamp", type: "DateTime('UTC')" }],
  bot_observations: [{ name: "timestamp", type: "DateTime('UTC')" }],
  session_replay_events: [{ name: "timestamp", type: "DateTime64(3, 'UTC')" }],
  session_replay_metadata: [
    { name: "start_time", type: "DateTime('UTC')" },
    { name: "end_time", type: "Nullable(DateTime('UTC'))" },
    { name: "created_at", type: "DateTime('UTC')" },
  ],
  session_replay_metadata_v2: [
    { name: "start_time", type: "SimpleAggregateFunction(min, DateTime64(3, 'UTC'))" },
    { name: "end_time", type: "SimpleAggregateFunction(max, Nullable(DateTime64(3, 'UTC')))" },
  ],
  // Cloud only.
  hourly_events_by_site_mv_target: EVENT_HOUR,
  // LITE_DASHBOARD only.
  sessions_mv_target: [
    { name: "start_time", type: "SimpleAggregateFunction(min, DateTime('UTC'))" },
    { name: "end_time", type: "SimpleAggregateFunction(max, DateTime('UTC'))" },
    { name: "last_seen", type: "SimpleAggregateFunction(max, DateTime('UTC'))" },
  ],
  overview_hourly_mv_target: EVENT_HOUR,
  pathname_hourly_mv_target: EVENT_HOUR,
  country_hourly_mv_target: EVENT_HOUR,
  device_type_hourly_mv_target: EVENT_HOUR,
  session_hourly_mv_target: [{ name: "session_hour", type: "DateTime('UTC')" }],
} satisfies Record<string, TimeColumnDefinition[]>;