From 585490b983da9f50e6dd31847ea1fe6be76439eb Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Fri, 9 May 2025 10:22:47 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Scott Anderson --- api-docs/influxdb3/cloud-dedicated/management/openapi.yml | 2 +- content/influxdb3/cloud-dedicated/admin/databases/create.md | 5 +++++ content/influxdb3/cloud-dedicated/admin/tables/create.md | 5 +++++ .../define-custom-partitions.md | 5 +++++ .../partition-templates.md | 5 +++++ 5 files changed, 21 insertions(+), 1 deletion(-) diff --git a/api-docs/influxdb3/cloud-dedicated/management/openapi.yml b/api-docs/influxdb3/cloud-dedicated/management/openapi.yml index 95bcfb27c..3204939cd 100644 --- a/api-docs/influxdb3/cloud-dedicated/management/openapi.yml +++ b/api-docs/influxdb3/cloud-dedicated/management/openapi.yml @@ -408,7 +408,7 @@ paths: The retention period is specified in nanoseconds. For example, to set a retention period of 1 hour, use `3600000000000`. InfluxDB Cloud Dedicated lets you define a [custom partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/) strategy for each database and table. - A _partition_ is a logical grouping of data stored in [Apache Parquet](https://parquet.apache.org/) + A _partition_ is a logical grouping of data stored in [Apache Parquet](https://parquet.apache.org/). By default, data is partitioned by day, but, depending on your schema and workload, customizing the partitioning strategy can improve query performance. diff --git a/content/influxdb3/cloud-dedicated/admin/databases/create.md b/content/influxdb3/cloud-dedicated/admin/databases/create.md index 2af42d58a..af605cecc 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/create.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/create.md @@ -157,6 +157,11 @@ If a table doesn't have a custom partition template, it inherits the database's - `--template-timeformat`: A [Rust strftime date and time](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/#time-part-templates) string that specifies the time part in the partition template and determines the time interval to partition by. + Use one of the following: + + - `%Y-%m-%d` (daily) + - `%Y-%m` (monthly) + - `%Y` (annually) - `--template-tag`: An [InfluxDB tag] to use in the partition template. - `--template-tag-bucket`: An [InfluxDB tag](/influxdb3/cloud-dedicated/reference/glossary/#tag) diff --git a/content/influxdb3/cloud-dedicated/admin/tables/create.md b/content/influxdb3/cloud-dedicated/admin/tables/create.md index 4d15fdf71..be53195de 100644 --- a/content/influxdb3/cloud-dedicated/admin/tables/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/create.md @@ -185,6 +185,11 @@ If a table doesn't have a custom partition template, it inherits the database's - `--template-timeformat`: A [Rust strftime date and time](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/#time-part-templates) string that specifies the time part in the partition template and determines the time interval to partition by. + Use one of the following: + + - `%Y-%m-%d` (daily) + - `%Y-%m` (monthly) + - `%Y` (annually) - `--template-tag`: An [InfluxDB tag] to use in the partition template. - `--template-tag-bucket`: An [InfluxDB tag](/influxdb3/cloud-dedicated/reference/glossary/#tag) diff --git a/content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md b/content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md index 16761a292..cf266a8d6 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md +++ b/content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md @@ -47,6 +47,11 @@ The following command flags identify - `--template-timeformat`: A [Rust strftime date and time](/influxdb/version/admin/custom-partitions/partition-templates/#time-part-templates) string that specifies the time part in the partition template and determines the time interval to partition by. + Use one of the following: + + - `%Y-%m-%d` (daily) + - `%Y-%m` (monthly) + - `%Y` (annually) - `--template-tag`: An [InfluxDB tag](/influxdb/version/reference/glossary/#tag) to use in the partition template. - `--template-tag-bucket`: An [InfluxDB tag](/influxdb/version/reference/glossary/#tag) diff --git a/content/shared/v3-distributed-admin-custom-partitions/partition-templates.md b/content/shared/v3-distributed-admin-custom-partitions/partition-templates.md index c6a0e812f..016411b85 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/partition-templates.md +++ b/content/shared/v3-distributed-admin-custom-partitions/partition-templates.md @@ -41,6 +41,11 @@ When creating a partition template: - With `influxctl`, always include `--template-timeformat` with a valid format - Without a time part, InfluxDB won't compact partitions, impacting performance - If you include more than one time part, InfluxDB uses the smallest unit of time + - Use one of the following Rust strftime date and time strings: + + - `%Y-%m-%d` (daily) + - `%Y-%m` (monthly) + - `%Y` (annually) 2. **Tag and tag bucket limitations** - Include up to seven [tag](#tag-part-templates) and [tag bucket](#tag-bucket-part-templates) parts