rdblue commented on code in PR #5124: URL: https://github.com/apache/iceberg/pull/5124#discussion_r912062557
########## python/pyiceberg/table/sorting.py: ########## @@ -0,0 +1,84 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from enum import Enum +from typing import Any, List, Optional + +from pydantic import Field + +from pyiceberg.transforms import Transform +from pyiceberg.utils.iceberg_base_model import IcebergBaseModel + + +class SortDirection(str, Enum): + ASC = "asc" + DESC = "desc" + + +class NullOrder(str, Enum): + NULLS_FIRST = "nulls-first" + NULLS_LAST = "nulls-last" + + +class SortField(IcebergBaseModel): + def __init__( + self, + source_id: int, + transform: Transform, + direction: SortDirection = SortDirection.ASC, + null_order: NullOrder = NullOrder.NULLS_LAST, + **data: Any, + ): + data["source-id"] = source_id + data["transform"] = transform + data["direction"] = direction + data["null-order"] = null_order + super().__init__(**data) + + source_id: int = Field(alias="source-id") + transform: Transform = Field() + direction: SortDirection = Field() + null_order: NullOrder = Field(alias="null-order") + + +class SortOrder(IcebergBaseModel): + """ + Users can sort their data within partitions by columns to gain performance. + The information on how the data is sorted can be declared per data or delete file, by a sort order. + + The order of the sort fields within the list defines the order in which the sort is applied to the data. + + Each sort field consists of: + + - Source column id from the table’s schema + - Transform that is used to produce values to be sorted on from the source column. + This is the same transform as described in partition transforms. + - Sort direction, that can only be either asc or desc + - Null order that describes the order of null values when sorted. Can only be either nulls-first or nulls-last + """ + + def __init__(self, order_id: int, *fields: SortField, **data: Any): + data["order-id"] = order_id + if fields: + data["fields"] = fields + super().__init__(**data) + + order_id: Optional[int] = Field(alias="order-id") + fields: List[SortField] = Field(default_factory=list) + + +UNPARTITIONED_SORT_ORDER_ID = 0 Review Comment: I think you mean `UNSORTED` rather than `UNPARTITIONED`? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
