4.3 KiB
| title | description | menu | weight | related | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Define custom partitions | Use the [`influxctl` CLI](/influxdb/clustered/reference/cli/influxctl/) to define custom partition strategies when creating a database or table. |
|
202 |
|
Use the influxctl CLI
to define custom partition strategies when creating a database or table.
By default, {{< product-name >}} partitions data by day.
The partitioning strategy of a database or table is determined by a partition template which defines the naming pattern for partition keys. Partition keys uniquely identify each partition. When a partition template is applied to a database, it becomes the default template for all tables in that database, but can be overridden when creating a table.
- Create a database with a custom partition template
- Create a table with a custom partition template
- Example partition templates
{{% note %}}
Partition templates can only be applied on create
You can only apply a partition template when creating a database or table. There is no way to update a partition template on an existing resource. {{% /note %}}
Use the following command flags to identify partition template parts:
--template-tag: An InfluxDB tag to use in the partition template. Supports up to 7 of these flags.--template-time: A Rust strftime date and time string that specifies the time format in the partition template and determines the time interval to partition by.
View partition template part restrictions.
Create a database with a custom partition template
The following example creates a new example-db database and applies a partition
template that partitions by two tags (room and sensor-type) and by week using
the time format %Y wk:%W:
influxctl database create \
--template-tag room \
--template-tag sensor-type \
--template-time '%Y wk:%W' \
example-db
Create a table with a custom partition template
The following example creates a new example-table table in the example-db
database and applies a partition template that partitions by two tags
(room and sensor-type) and by month using the time format %Y-%m:
influxctl table create \
--template-tag room \
--template-tag sensor-type \
--template-time '%Y-%m' \
example-db \
example-table
Example partition templates
Given the following line protocol
with a 2024-01-01T00:00:00Z timestamp:
prod,line=A,station=weld1 temp=81.9,qty=36i 1704067200000000000
| Description | Tag part(s) | Time part | Resulting partition key |
|---|---|---|---|
| By day (default) | %Y-%m-%d |
2024-01-01 | |
| By day (non-default) | %d %b %Y |
01 Jan 2024 | |
| By week | %Y wk:%W |
2024 wk:01 | |
| By month | %Y-%m |
2024-01 | |
| Single tag, by day | line |
%F |
A | 2024-01-01 |
| Single tag, by week | line |
%Y wk:%W |
A | 2024 wk:01 |
| Single tag, by month | line |
%Y-%m |
A | 2024-01 |
| Multiple tags, by day | line, station |
%F |
A | weld1 | 2024-01-01 |
| Multiple tags, by week | line, station |
%Y wk:%W |
A | weld1 | 2024 wk:01 |
| Multiple tags, by month | line, station |
%Y-%m |
A | weld1 | 2024-01 |