New to ClickHouse®?

Getting started

Explore the platform

Serverless ClickHouse®

Ingestion

Query APIs

SQL Reference

Management API

REST API Reference

API Reference

Embeddable UI

Changelog

Propel docs

Console

Sign up

Guides, resources, and references to build with Propel.

Overview

Propel documentation

Learn why ClickHouse is **so fast** for analytical use cases.

What is ClickHouse®?

Built for developers by ex-Twilio engineers.

Why Propel?

Learn about Propel's cloud-native ClickHouse architecture.

Architecture

Get up and running with Propel in under 5 minutes.

Quickstart

Connect using ClickHouse or PostgreSQL clients and SDKs.

Connect & SDKs

Create Data Pools via the API or Terraform.

Creating tables

Individual and bulk inserts into ClickHouse

Inserting data

Real-time and batch updates in ClickHouse.

Updating data

Real-time and batch deletes in ClickHouse.

Deleting data

Changing schemas

Materialized Views

Query data from other databases and data warehouses.

Federation

Applications

Fine-grained control over Data Pool access with column and row-level rules

Access Policies

Using JWT tokens to secure multi-tenant applications.

Multi-tenant JWT tokens

Guide to selecting the optimal Propeller size for your use case

Choosing a Propeller

How to select and use the optimal default timestamp for your Data Pool

Default Timestamp

Default timestamp

How to select the best table engine and sorting key in ClickHouse

Table Engine & Sorting Key

Selecting table engine and sorting key

Example section for showcasing API endpoints

Partition Key

Partition key

Propel Terraform provider

Advanced Terraform examples for Propel resources

Advanced Examples

Advanced examples

Configure Single Sign-On (SSO) for user authentication.

Single Sign-On (SSO)

Starter Apps

Authentication

Layout

Querying Metrics

Logging

Customize loading, error and empty states.

Default States

Customizing default states

Chart.js configuration

Theme overview

Understand the color system and its application in your theme.

Color

Dark mode

Typography

Spacing

Define responsive breakpoints for your layout.

Breakpoints

Choose the border radius for UI elements.

Radius

Select shadow styles for your components.

Shadows

Customize cursor styles for interactive elements.

Cursors

Time Series

Counter

Data Grid

Leaderboard

Pie Chart

Time Range Picker

Simple Filter

Choose a time granularity for aggregation.

Time Grain Picker

Group By

Access Token Provider

AccessToken Provider

Filter Provider

Filter provider

Log Provider

Log provider

Theme Provider

Theme provider

useSql

A React Hook for fetching a  value from the Counter API.

useCounter

A React Hook for fetching tabular data from the Data Grid API.

useDataGrid

A React Hook for fetching ranked data from the Leaderboard API.

useLeaderboard

A React Hook for ready-to-chart time series data from the Time Series API.

useTimeSeries

A React Hook for fetching unique values from the Top Values API.

useTopValues

2024

2024 Changelog

2023

2023 Changelog

2022

2022 Changelog

Execute SQL queries from your application.

SQL API

Get a single aggregated value for a time range.

Get aggregated values grouped by common dimensions.

Get multiple aggregated values grouped by common dimensions.

Metric Report

Metric report

Get the most frequent non-null values in a column.

Top Values

Top values

Metrics

Learn about the different types of metrics.

Types of Metrics

Define Metrics using the console, API, or Terraform.

Defining Metrics

Querying JSON

Querying JSON data

Multiple queries

Make multiple GraphQL queries in a single request

Timezones

Working with timezones

Pagination

Unique names

Learn the key elements of ClickHouse SQL syntax.

Syntax

Data Types

Data types

Table Engines

Table engines

Operators

SELECT

TABLES

SHOW TABLES

Perform data manipulation and transformation using built-in functions.

Regular functions

Perform basic and advanced mathematical operations.

Arithmetic

Arithmetic functions

Arrays

Array functions

arrayJoin

arrayJoin function

Perform bitwise operations on integer values.

Bit functions

Work with bitmap data structures for efficient set operations.

Bitmap

Bitmap functions

Compare values and return boolean results.

Comparison

Comparison functions

Conditional

Conditional functions

Manipulate and format date and time values.

Dates and Times

Date and Time functions

Convert between different character encodings.

Encoding

Encoding functions

Encrypt and decrypt data for security purposes.

Encryption

Encryption functions

Generate hash values for data integrity and lookups.

Hash

Hash functions

IP Addresses

IP addresses functions

Logical

Logical functions

Manipulate key-value pair data structures.

Maps

Map functions

Perform advanced mathematical calculations.

Mathematical

Mathematical functions

Nullable

Nullable functions

Miscellaneous functions for various purposes.

Other

Other functions

Generate random values for various data types.

Get Started

Manage

Identity & Access

Resources

Enterprise

Propel documentation

New to ClickHouse®?

What is ClickHouse®?

Why Propel?

Getting started

Quickstart

Connect & SDKs

Explore the platform

Ingestion

Query APIs

Embeddable UIs

Get Started

Manage

Identity & Access

Resources

Enterprise

​New to ClickHouse®?

What is ClickHouse®?

Why Propel?

​Getting started

Quickstart

Connect & SDKs

​Explore the platform

Ingestion

Query APIs

Embeddable UIs

New to ClickHouse®?

Getting started

Explore the platform