Merge pull request #38 from developmentseed/sortby

Add support for sortby

Author: vincentsarago

CHANGES.md

@@ -5,6 +5,7 @@ Add options to reduce the bandwidth required for returning record geometries.
  - bbox-only=[bool] only return the bounding box in the return geometry
  - geom-column=none don't return geometry as part of the return
  - simplify=[float] Use ST_SnapToGrid(ST_Simplify(geom, [simplify]),[simplify]) to simplify and reduce precision of output geometry.
+ - sortby=[+/-][field] support to sorting by a field
 
 ## 0.1.0
 

tests/routes/test_items.py

@@ -598,3 +598,52 @@ def test_output_response_type(app):
     assert response.headers["content-type"] == "application/ndjson"
     body = response.text.splitlines()
     assert len(body) == 10
+
+
+def test_items_sortby(app):
+    """Test /items endpoint with sortby options."""
+    response = app.get("/collections/public.landsat_wrs/items?limit=1")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "application/geo+json"
+    body = response.json()
+    assert body["features"][0]["properties"]["ogc_fid"] == 1
+    assert body["numberMatched"] == 16269
+
+    response = app.get("/collections/public.landsat_wrs/items?limit=1&sortby=ogc_fid")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "application/geo+json"
+    body = response.json()
+    assert body["features"][0]["properties"]["ogc_fid"] == 1
+    assert body["numberMatched"] == 16269
+
+    response = app.get("/collections/public.landsat_wrs/items?limit=1&sortby=row")
+    assert response.status_code == 200
+    body = response.json()
+    assert body["features"][0]["properties"]["row"] == 1
+    assert body["numberMatched"] == 16269
+
+    response = app.get("/collections/public.landsat_wrs/items?limit=1&sortby=+row")
+    assert response.status_code == 200
+    body = response.json()
+    assert body["features"][0]["properties"]["row"] == 1
+
+    response = app.get("/collections/public.landsat_wrs/items?limit=1&sortby=-row")
+    assert response.status_code == 200
+    body = response.json()
+    assert body["features"][0]["properties"]["row"] == 248
+
+    response = app.get("/collections/public.landsat_wrs/items?limit=1&sortby=-row,path")
+    assert response.status_code == 200
+    body = response.json()
+    assert body["features"][0]["properties"]["row"] == 248
+    assert body["features"][0]["properties"]["path"] == 1
+
+    response = app.get("/collections/public.landsat_wrs/items?limit=1&sortby=path,-row")
+    assert response.status_code == 200
+    body = response.json()
+    assert body["features"][0]["properties"]["row"] == 248
+    assert body["features"][0]["properties"]["path"] == 1
+
+    # Invalid column name
+    response = app.get("/collections/public.landsat_wrs/items?limit=1&sortby=something")
+    assert response.status_code == 404

tifeatures/dbmodel.py

@@ -55,7 +55,7 @@ class Table(BaseModel):
     table: str
     dbschema: str = Field(..., alias="schema")
     description: Optional[str]
-    id_column: Optional[str]
+    id_column: str
     geometry_columns: List[GeometryColumn]
     properties: List[Column]
 
@@ -94,7 +94,7 @@ def columns(self, properties: Optional[List[str]] = None) -> List[str]:
         """Return table columns optionally filtered to only include columns from properties."""
         cols = [c.name for c in self.properties]
         if properties is not None:
-            if self.id_column is not None and self.id_column not in properties:
+            if self.id_column not in properties:
                 properties.append(self.id_column)
 
             geom_col = self.geometry_column()

tifeatures/dependencies.py

@@ -241,3 +241,13 @@ def filter_query(
         return cql2_text_parser(query)
 
     return None
+
+
+def sortby_query(
+    sortby: Optional[str] = Query(
+        None,
+        description="Column Sort the items by Column (ascending (default) or descending).",
+    )
+):
+    """Sortby dependency."""
+    return sortby

tifeatures/factory.py

@@ -20,6 +20,7 @@
     filter_query,
     ids_query,
     properties_query,
+    sortby_query,
 )
 from tifeatures.errors import NotFound
 from tifeatures.layer import CollectionLayer
@@ -547,6 +548,7 @@ async def items(
             datetime_filter: Optional[List[str]] = Depends(datetime_query),
             properties: Optional[List[str]] = Depends(properties_query),
             cql_filter: Optional[AstType] = Depends(filter_query),
+            sortby: Optional[str] = Depends(sortby_query),
             geom_column: Optional[str] = Query(
                 None,
                 description="Select geometry column.",
@@ -594,6 +596,7 @@ async def items(
                 "offset",
                 "bbox-only",
                 "simplify",
+                "sortby",
             ]
             properties_filter = [
                 (key, value)
@@ -608,6 +611,7 @@ async def items(
                 datetime_filter=datetime_filter,
                 properties_filter=properties_filter,
                 cql_filter=cql_filter,
+                sortby=sortby,
                 properties=properties,
                 limit=limit,
                 offset=offset,

tifeatures/layer.py

@@ -1,6 +1,7 @@
 """tifeatures.layers."""
 
 import abc
+import re
 from dataclasses import dataclass
 from typing import Any, ClassVar, Dict, List, Optional, Tuple
 
@@ -261,6 +262,29 @@ def _datetime_filter_to_sql(self, interval: List[str], dt_name: str):
                     logic.V(dt_name) < logic.S(pg_funcs.cast(end, "timestamptz")),
                 )
 
+    def _sortby(self, sortby: Optional[str]):
+        sorts = []
+        if sortby:
+            for s in sortby.strip().split(","):
+                parts = re.match(
+                    "^(?P<direction>[+-]?)(?P<column>.*)$", s
+                ).groupdict()  # type:ignore
+
+                direction = parts["direction"]
+                column = parts["column"].strip()
+                if self.get_column(column):
+                    if direction == "-":
+                        sorts.append(logic.V(column).desc())
+                    else:
+                        sorts.append(logic.V(column))
+                else:
+                    raise InvalidPropertyName(f"Property {column} does not exist.")
+
+        else:
+            sorts.append(logic.V(self.id_column))
+
+        return clauses.OrderBy(*sorts)
+
     def _features_query(
         self,
         *,
@@ -269,6 +293,7 @@ def _features_query(
         datetime_filter: Optional[List[str]] = None,
         properties_filter: Optional[List[Tuple[str, str]]] = None,
         cql_filter: Optional[AstType] = None,
+        sortby: Optional[str] = None,
         properties: Optional[List[str]] = None,
         geom: str = None,
         dt: str = None,
@@ -288,6 +313,7 @@ def _features_query(
                 geom=geom,
                 dt=dt,
             )
+            + self._sortby(sortby)
             + clauses.Limit(limit or 10)
             + clauses.Offset(offset or 0)
         )
@@ -327,6 +353,7 @@ async def query(
         datetime_filter: Optional[List[str]] = None,
         properties_filter: Optional[List[Tuple[str, str]]] = None,
         cql_filter: Optional[AstType] = None,
+        sortby: Optional[str] = None,
         properties: Optional[List[str]] = None,
         geom: str = None,
         dt: str = None,
@@ -370,6 +397,7 @@ async def query(
                 datetime_filter=datetime_filter,
                 properties_filter=properties_filter,
                 cql_filter=cql_filter,
+                sortby=sortby,
                 properties=properties,
                 geom=geom,
                 dt=dt,