Skip to content

Commit dc35e55

Browse files
committed
Update readme
1 parent f23c8de commit dc35e55

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,27 @@ your_profile_name:
123123

124124
## Column Configuration
125125

126-
| Option | Description | Default if any |
127-
|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|
128-
| codec | A string consisting of arguments passed to `CODEC()` in the column's DDL. For example: `codec: "Delta, ZSTD"` will be interpreted as `CODEC(Delta, ZSTD)`. | |
126+
| Option | Description | Default if any |
127+
|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|
128+
| codec | A string consisting of arguments passed to `CODEC()` in the column's DDL. For example: `codec: "Delta, ZSTD"` will be interpreted as `CODEC(Delta, ZSTD)`. | |
129+
| ttl | A string consisting of a [TTL (time-to-live) expression](https://clickhouse.com/docs/guides/developer/ttl) that defines a TTL rule in the column's DDL. For example: `ttl: ts + INTERVAL 1 DAY` will be interpreted as `TTL ts + INTERVAL 1 DAY`. | |
130+
131+
### Example
132+
133+
```yaml
134+
models:
135+
- name: table_column_configs
136+
config:
137+
contract:
138+
enforced: true
139+
columns:
140+
- name: ts
141+
data_type: timestamp
142+
codec: ZSTD
143+
- name: x
144+
data_type: UInt8
145+
ttl: ts + INTERVAL 1 DAY
146+
```
129147
130148
## ClickHouse Cluster
131149

0 commit comments

Comments
 (0)