advancedxy commented on code in PR #8579:
URL: https://github.com/apache/iceberg/pull/8579#discussion_r1456811454


##########
format/spec.md:
##########
@@ -1119,21 +1156,30 @@ Partition specs are serialized as a JSON object with 
the following fields:
 
 Each partition field in the fields list is stored as an object. See the table 
for more detail:
 
-|Transform or Field|JSON representation|Example|
-|--- |--- |--- |
-|**`identity`**|`JSON string: "identity"`|`"identity"`|
-|**`bucket[N]`**|`JSON string: "bucket[<N>]"`|`"bucket[16]"`|
-|**`truncate[W]`**|`JSON string: "truncate[<W>]"`|`"truncate[20]"`|
-|**`year`**|`JSON string: "year"`|`"year"`|
-|**`month`**|`JSON string: "month"`|`"month"`|
-|**`day`**|`JSON string: "day"`|`"day"`|
-|**`hour`**|`JSON string: "hour"`|`"hour"`|
-|**`Partition Field`**|`JSON object: {`<br />&nbsp;&nbsp;`"source-id": <id 
int>,`<br />&nbsp;&nbsp;`"field-id": <field id int>,`<br />&nbsp;&nbsp;`"name": 
<name string>,`<br />&nbsp;&nbsp;`"transform": <transform JSON>`<br 
/>`}`|`{`<br />&nbsp;&nbsp;`"source-id": 1,`<br />&nbsp;&nbsp;`"field-id": 
1000,`<br />&nbsp;&nbsp;`"name": "id_bucket",`<br />&nbsp;&nbsp;`"transform": 
"bucket[16]"`<br />`}`|
+| Transform or Field                                 | JSON representation     
                                                                                
                                                                                
                                                                | Example       
                                                                                
                                                                                
                                            |
+|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`identity`**                                     | `JSON string: 
"identity"`                                                                     
                                                                                
                                                                          | 
`"identity"`                                                                    
                                                                                
                                                          |
+| **`bucket[N]`**                                    | `JSON string: 
"bucket[<N>]"`                                                                  
                                                                                
                                                                          | 
`"bucket[16]"`                                                                  
                                                                                
                                                          |
+| **`bucket[N]`** (multi-arg bucket [1])             | `JSON string: 
"bucketV2[<N>]"`                                                                
                                                                                
                                                                          | 
`"bucketV2[16]"`                                                                
                                                                                
                                                          |
+| **`truncate[W]`**                                  | `JSON string: 
"truncate[<W>]"`                                                                
                                                                                
                                                                          | 
`"truncate[20]"`                                                                
                                                                                
                                                          |
+| **`year`**                                         | `JSON string: "year"`   
                                                                                
                                                                                
                                                                | `"year"`      
                                                                                
                                                                                
                                            |
+| **`month`**                                        | `JSON string: "month"`  
                                                                                
                                                                                
                                                                | `"month"`     
                                                                                
                                                                                
                                            |
+| **`day`**                                          | `JSON string: "day"`    
                                                                                
                                                                                
                                                                | `"day"`       
                                                                                
                                                                                
                                            |
+| **`hour`**                                         | `JSON string: "hour"`   
                                                                                
                                                                                
                                                                | `"hour"`      
                                                                                
                                                                                
                                            |
+| **`Partition Field`** [2]                          | `JSON object: {`<br 
/>&nbsp;&nbsp;`"source-id": <id int>,`<br />&nbsp;&nbsp;`"field-id": <field id 
int>,`<br />&nbsp;&nbsp;`"name": <name string>,`<br />&nbsp;&nbsp;`"transform": 
<transform JSON>`<br />`}`                                           | `{`<br 
/>&nbsp;&nbsp;`"source-id": 1,`<br />&nbsp;&nbsp;`"field-id": 1000,`<br 
/>&nbsp;&nbsp;`"name": "id_bucket",`<br />&nbsp;&nbsp;`"transform": 
"bucket[16]"`<br />`}`                                                 |
+| **`Partition Field with multi-arg transform`** [3] | `JSON object: {`<br 
/>&nbsp;&nbsp;`"source-id": -1,`<br />&nbsp;&nbsp;`"source-ids": <list of 
ids>,`<br />&nbsp;&nbsp;`"field-id": <field id int>,`<br />&nbsp;&nbsp;`"name": 
<name string>,`<br />&nbsp;&nbsp;`"transform": <transform JSON>`<br />`}` | 
`{`<br />&nbsp;&nbsp;`"source-id": -1,`<br />&nbsp;&nbsp;`"source-ids": 
[1,2],`<br />&nbsp;&nbsp;`"field-id": 1000,`<br />&nbsp;&nbsp;`"name": 
"id_type_bucket",`<br />&nbsp;&nbsp;`"transform": "bucketV2[16]"`<br />`}` |
 
 In some cases partition specs are stored using only the field list instead of 
the object format that includes the spec ID, like the deprecated 
`partition-spec` field in table metadata. The object format should be used 
unless otherwise noted in this spec.
 
 The `field-id` property was added for each partition field in v2. In v1, the 
reference implementation assigned field ids sequentially in each spec starting 
at 1,000. See Partition Evolution for more details.
 
+Notes:
+
+1. For multi-arg bucket, the serialized form is `bucketV2[N]` instead of 
`bucket[N]` to distinguish it from the single-arg bucket transform. Therefore, 
old readers/writers will identify this transform as an unknown transform, old 
writer will stop writing the table if it encounters this transform, but old 
readers would still be able to read the table by scanning all the partitions.
+   This makes adding multi-arg transform a forward-compatible change, but not 
a backward-compatible change.
+2. For partition fields with a transform with a single argument, the id of the 
source field is set on `source-id`, and `source-ids` is omitted.

Review Comment:
   I changed some occurrence of id to ID. However it seems id and IDs are 
mixed, it may require another PR to fix that, which is out this PR's scope.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org

Reply via email to