jackye1995 commented on a change in pull request #2055:
URL: https://github.com/apache/iceberg/pull/2055#discussion_r555355191
##########
File path: site/docs/spec.md
##########
@@ -831,6 +852,29 @@ Each partition field in the fields list is stored as an
object. See the table fo
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.
+### Sort Orders
+
+Sort orders are serialized as a list of JSON object, each of which contains
the following fields:
+
+|Field|JSON representation|Example|
+|--- |--- |--- |
+|**`order-id`**|`JSON int`|`1`|
+|**`fields`**|`JSON list: [`<br /> `<sort field JSON>,`<br
/> `...`<br />`]`|`[ {`<br /> ` "transform":
"identity",`<br /> ` "source-id": 2,`<br /> `
"direction": "asc",`<br /> ` "null-order": "nulls-first"`<br
/> `}, {`<br /> ` "transform": "bucket[4]",`<br
/> ` "source-id": 3,`<br /> ` "direction": "desc",`<br
/> ` "null-order": "nulls-last"`<br />`} ]`|
+
+Each sort field in the fields list is stored as an object with the following
properties:
+
+|Field|JSON representation|Example|
+|--- |--- |--- |
+|**`Sort Field`**|`JSON object: {`<br /> `"transform": <transform
JSON>,`<br /> `"source-id": <source id int>,`<br
/> `"direction": <direction string>,`<br
/> `"null-order": <null-order string>`<br />`}`|`{`<br
/> ` "transform": "bucket[4]",`<br /> ` "source-id":
3,`<br /> ` "direction": "desc",`<br /> ` "null-order":
"nulls-last"`<br />`}`|
+
+The following table describes the possible values for the some of the field
within sort field:
+
+|Field|JSON representation|Possible values|
+|--- |--- |--- |
+|**`direction`**|`JSON string`|`"asc", "desc"`|
+|**`null-order`**|`JSON string`|`"nulls-first", "nulls-last"`|
Review comment:
how is NaN ordered? In java, `Double.NaN` is considered to be equal to
itself and greater than all other double values including
`Double.POSITIVE_INFINITY`. If this is the definition we follow, we should
document it here. Otherwise something similar like a `NaNOrder` class should be
defined in sort order.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
