docs(bigquery): Update supported types for time partition type

closes: #7848 pr: #8045
googleapis · Oct 20, 2020 · d23896f · d23896f
1 parent ffdff97
commit d23896f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 13 deletions.
diff --git a/google-cloud-bigquery/lib/google/cloud/bigquery/load_job.rb b/google-cloud-bigquery/lib/google/cloud/bigquery/load_job.rb
@@ -428,8 +428,9 @@ def time_partitioning?
         # The period for which the destination table will be time partitioned, if
         # any. See [Partitioned Tables](https://cloud.google.com/bigquery/docs/partitioned-tables).
         #
-        # @return [String, nil] The time partition type. Currently the only supported
-        #   value is "DAY", or `nil` if not present.
+        # @return [String, nil] The time partition type. The supported types are `DAY`,
+        #   `HOUR`, `MONTH`, and `YEAR`, which will generate one partition per day,
+        #   hour, month, and year, respectively; or `nil` if not present.
         #
         # @!group Attributes
         #
@@ -1499,8 +1500,9 @@ def range_partitioning_end= range_end
           # BigQuery does not allow you to change partitioning on an existing
           # table.
           #
-          # @param [String] type The time partition type. Currently the only
-          #   supported value is "DAY".
+          # @param [String] type The time partition type. The supported types are `DAY`,
+          #   `HOUR`, `MONTH`, and `YEAR`, which will generate one partition per day,
+          #   hour, month, and year, respectively.
           #
           # @example
           #   require "google/cloud/bigquery"

diff --git a/google-cloud-bigquery/lib/google/cloud/bigquery/query_job.rb b/google-cloud-bigquery/lib/google/cloud/bigquery/query_job.rb
@@ -528,8 +528,9 @@ def time_partitioning?
         # The period for which the destination table will be partitioned, if
         # any. See [Partitioned Tables](https://cloud.google.com/bigquery/docs/partitioned-tables).
         #
-        # @return [String, nil] The partition type. Currently the only supported
-        #   value is "DAY", or `nil` if not present.
+        # @return [String, nil] The partition type. The supported types are `DAY`,
+        #   `HOUR`, `MONTH`, and `YEAR`, which will generate one partition per day,
+        #   hour, month, and year, respectively; or `nil` if not present.
         #
         # @!group Attributes
         #
@@ -1302,13 +1303,16 @@ def range_partitioning_end= range_end
           ##
           # Sets the partitioning for the destination table. See [Partitioned
           # Tables](https://cloud.google.com/bigquery/docs/partitioned-tables).
+          # The supported types are `DAY`, `HOUR`, `MONTH`, and `YEAR`, which will
+          # generate one partition per day, hour, month, and year, respectively.
           #
           # You can only set the partitioning field while creating a table.
           # BigQuery does not allow you to change partitioning on an existing
           # table.
           #
-          # @param [String] type The partition type. Currently the only
-          #   supported value is "DAY".
+          # @param [String] type The partition type. The supported types are `DAY`,
+          #   `HOUR`, `MONTH`, and `YEAR`, which will generate one partition per day,
+          #   hour, month, and year, respectively.
           #
           # @example
           #   require "google/cloud/bigquery"

diff --git a/google-cloud-bigquery/lib/google/cloud/bigquery/table.rb b/google-cloud-bigquery/lib/google/cloud/bigquery/table.rb
@@ -250,9 +250,10 @@ def time_partitioning?
         # The period for which the table is time partitioned, if any. See
         # [Partitioned Tables](https://cloud.google.com/bigquery/docs/partitioned-tables).
         #
-        # @return [String, nil] The time partition type. Currently the only supported
-        #   value is "DAY", or `nil` if the object is a reference (see
-        #   {#reference?}).
+        # @return [String, nil] The time partition type. The supported types are `DAY`,
+        #   `HOUR`, `MONTH`, and `YEAR`, which will generate one partition per day,
+        #   hour, month, and year, respectively; or `nil` if not set or the object is a
+        #   reference (see {#reference?}).
         #
         # @!group Attributes
         #
@@ -265,13 +266,16 @@ def time_partitioning_type
         ##
         # Sets the time partitioning type for the table. See [Partitioned
         # Tables](https://cloud.google.com/bigquery/docs/partitioned-tables).
+        # The supported types are `DAY`, `HOUR`, `MONTH`, and `YEAR`, which will
+        # generate one partition per day, hour, month, and year, respectively.
         #
         # You can only set time partitioning when creating a table as in
         # the example below. BigQuery does not allow you to change time partitioning
         # on an existing table.
         #
-        # @param [String] type The time partition type. Currently the only
-        #   supported value is "DAY".
+        # @param [String] type The time partition type. The supported types are `DAY`,
+        #   `HOUR`, `MONTH`, and `YEAR`, which will generate one partition per day,
+        #   hour, month, and year, respectively.
         #
         # @example
         #   require "google/cloud/bigquery"