gcp_bigquery_client/model/
time_partitioning.rs

1use serde::{Deserialize, Serialize};
2use std::time::Duration;
3
4#[derive(Debug, Default, Clone, Serialize, Deserialize)]
5#[serde(rename_all = "camelCase")]
6pub struct TimePartitioning {
7    /// [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
8    #[serde(skip_serializing_if = "Option::is_none")]
9    pub expiration_ms: Option<String>,
10    /// [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
11    #[serde(skip_serializing_if = "Option::is_none")]
12    pub field: Option<String>,
13    #[serde(skip_serializing_if = "Option::is_none")]
14    pub require_partition_filter: Option<bool>,
15    /// [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
16    #[serde(rename = "type")]
17    pub r#type: String,
18}
19
20impl TimePartitioning {
21    /// Creates a new time partitioning.
22    /// # Argument
23    /// * `type` - The type of the partitioning (HOUR, DAY, MONTH or YEAR)
24    pub fn new(r#type: String) -> Self {
25        Self {
26            expiration_ms: None,
27            field: None,
28            require_partition_filter: None,
29            r#type,
30        }
31    }
32
33    /// Creates a time partitioning per hour.
34    pub fn per_hour() -> Self {
35        Self {
36            expiration_ms: None,
37            field: None,
38            require_partition_filter: None,
39            r#type: "HOUR".to_string(),
40        }
41    }
42
43    /// Creates a time partitioning per day.
44    pub fn per_day() -> Self {
45        Self {
46            expiration_ms: None,
47            field: None,
48            require_partition_filter: None,
49            r#type: "DAY".to_string(),
50        }
51    }
52
53    /// Creates a time partitioning per month.
54    pub fn per_month() -> Self {
55        Self {
56            expiration_ms: None,
57            field: None,
58            require_partition_filter: None,
59            r#type: "MONTH".to_string(),
60        }
61    }
62
63    /// Creates a time partitioning per year.
64    pub fn per_year() -> Self {
65        Self {
66            expiration_ms: None,
67            field: None,
68            require_partition_filter: None,
69            r#type: "YEAR".to_string(),
70        }
71    }
72
73    /// Sets the expiration time per partition
74    pub fn expiration_ms(mut self, duration: Duration) -> Self {
75        self.expiration_ms = Some(duration.as_millis().to_string());
76        self
77    }
78
79    /// Sets the field used for the time partitioning
80    pub fn field(mut self, field: &str) -> Self {
81        self.field = Some(field.to_string());
82        self
83    }
84}
gcp_bigquery_client/model/time_partitioning.rs

gcp_bigquery_client/model/
time_partitioning.rs
