Merge pull request #23 from developmentseed/geom_return_options

Support tables without geometries. Add options for returning geometries.

Author: bitner

CHANGES.md

@@ -1,5 +1,11 @@
 # Release Notes
 
+## Unreleased
+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.
+
 ## 0.1.0
 
 Initial release

tests/routes/test_items.py

@@ -194,9 +194,9 @@ def test_items_properties_filter(app):
 
 def test_items_filter_cql_ids(app):
     """Test /items endpoint with ids options."""
-    filter = {"op": "=", "args": [{"property": "ogc_fid"}, 1]}
+    filter_query = {"op": "=", "args": [{"property": "ogc_fid"}, 1]}
     response = app.get(
-        f"/collections/public.landsat_wrs/items?filter-lang=cql2-json&filter={json.dumps(filter)}"
+        f"/collections/public.landsat_wrs/items?filter-lang=cql2-json&filter={json.dumps(filter_query)}"
     )
     assert response.status_code == 200
     assert response.headers["content-type"] == "application/geo+json"
@@ -222,7 +222,7 @@ def test_items_filter_cql_ids(app):
     response = app.get(
         "/collections/public.landsat_wrs/items?filter-lang=cql2-text&filter=ogc_fid IN (1,2)"
     )
-    print(response.content)
+
     assert response.status_code == 200
     assert response.headers["content-type"] == "application/geo+json"
     body = response.json()
@@ -237,9 +237,9 @@ def test_items_filter_cql_ids(app):
 
 def test_items_properties_filter_cql2(app):
     """Test /items endpoint with properties filter options."""
-    filter = {"op": "=", "args": [{"property": "path"}, 13]}
+    filter_query = {"op": "=", "args": [{"property": "path"}, 13]}
     response = app.get(
-        f"/collections/public.landsat_wrs/items?filter-lang=cql2-json&filter={json.dumps(filter)}"
+        f"/collections/public.landsat_wrs/items?filter-lang=cql2-json&filter={json.dumps(filter_query)}"
     )
     assert response.status_code == 200
     assert response.headers["content-type"] == "application/geo+json"
@@ -250,22 +250,22 @@ def test_items_properties_filter_cql2(app):
     assert body["features"][0]["properties"]["path"] == 13
 
     # invalid type (str instead of int)
-    filter = {"op": "=", "args": [{"property": "path"}, "d"]}
+    filter_query = {"op": "=", "args": [{"property": "path"}, "d"]}
     response = app.get(
-        f"/collections/public.landsat_wrs/items?filter-lang=cql2-json&filter={json.dumps(filter)}"
+        f"/collections/public.landsat_wrs/items?filter-lang=cql2-json&filter={json.dumps(filter_query)}"
     )
     assert response.status_code == 500
     assert "integer is required" in response.json()["detail"]
 
-    filter = {
+    filter_query = {
         "op": "and",
         "args": [
             {"op": "=", "args": [{"property": "path"}, 13]},
             {"op": "=", "args": [{"property": "row"}, 10]},
         ],
     }
     response = app.get(
-        f"/collections/public.landsat_wrs/items?filter-lang=cql2-json&filter={json.dumps(filter)}"
+        f"/collections/public.landsat_wrs/items?filter-lang=cql2-json&filter={json.dumps(filter_query)}"
     )
     assert response.status_code == 200
     assert response.headers["content-type"] == "application/geo+json"
@@ -423,3 +423,63 @@ def test_items_datetime(app):
     )
     assert response.status_code == 422
     assert response.headers["content-type"] == "application/json"
+
+
+def test_items_geometry_return_options(app):
+    """Test /items endpoint with geometry return options."""
+    response = app.get("/collections/public.landsat_wrs/items?ids=1&geom-column=none")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "application/geo+json"
+    body = response.json()
+    assert len(body["features"]) == 1
+    assert body["numberMatched"] == 1
+    assert body["numberReturned"] == 1
+    assert body["features"][0]["id"] == "1"
+    assert body["features"][0]["properties"]["ogc_fid"] == 1
+    assert "geometry" not in body["features"][0]
+
+    response = app.get("/collections/public.landsat_wrs/items?ids=1&bbox-only=true")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "application/geo+json"
+    body = response.json()
+    assert len(body["features"]) == 1
+    assert body["numberMatched"] == 1
+    assert body["numberReturned"] == 1
+    assert body["features"][0]["id"] == "1"
+    assert body["features"][0]["properties"]["ogc_fid"] == 1
+    assert body["features"][0]["geometry"] == {
+        "coordinates": [
+            [
+                [-22.2153, 79.6888],
+                [-22.2153, 81.8555],
+                [-8.97407, 81.8555],
+                [-8.97407, 79.6888],
+                [-22.2153, 79.6888],
+            ]
+        ],
+        "type": "Polygon",
+    }
+
+    response = app.get("/collections/public.landsat_wrs/items?ids=1&simplify=.001")
+    assert response.status_code == 200
+    assert response.headers["content-type"] == "application/geo+json"
+    body = response.json()
+    assert len(body["features"]) == 1
+    assert body["numberMatched"] == 1
+    assert body["numberReturned"] == 1
+    assert body["features"][0]["id"] == "1"
+    assert body["features"][0]["properties"]["ogc_fid"] == 1
+    print(body["features"][0]["geometry"])
+    assert body["features"][0]["geometry"] == {
+        "coordinates": [
+            [
+                [-10.803, 80.989],
+                [-8.974, 80.342],
+                [-16.985, 79.689],
+                [-22.215, 81.092],
+                [-13.255, 81.856],
+                [-10.803, 80.989],
+            ]
+        ],
+        "type": "Polygon",
+    }

tifeatures/dbmodel.py

@@ -74,10 +74,12 @@ def datetime_column(self, name: Optional[str] = None) -> Optional[Column]:
 
     def geometry_column(self, name: Optional[str] = None) -> Optional[GeometryColumn]:
         """Return the name of the first geometry column."""
-        if self.geometry_columns:
-            for col in self.geometry_columns:
-                if name is None or col.name == name:
-                    return col
+        if name and name.lower() == "none":
+            return None
+
+        for col in self.geometry_columns:
+            if name is None or col.name == name:
+                return col
 
         return None
 

tifeatures/factory.py

@@ -351,7 +351,10 @@ def collections(
                             ],
                         }
                     )
-                    for collection in [*tables, *list(function_catalog.values())]
+                    for collection in [
+                        *tables,
+                        *list(function_catalog.values()),
+                    ]
                 ],
             )
 
@@ -398,7 +401,9 @@ def collection(
                         ),
                         model.Link(
                             href=self.url_for(
-                                request, "collection", collectionId=collection.id
+                                request,
+                                "collection",
+                                collectionId=collection.id,
                             )
                             + "?f=html",
                             rel="alternate",
@@ -521,6 +526,15 @@ async def items(
                 description="Starts the response at an offset.",
             ),
             output_type: Optional[ResponseType] = Depends(OutputType),
+            bbox_only: Optional[bool] = Query(
+                None,
+                description="Only return the bounding box of the feature.",
+                alias="bbox-only",
+            ),
+            simplify: Optional[float] = Query(
+                None,
+                description="Simplify the output geometry to given threshold in decimal degrees.",
+            ),
         ):
             offset = offset or 0
 
@@ -537,6 +551,8 @@ async def items(
                 "datetime-column",
                 "limit",
                 "offset",
+                "bbox-only",
+                "simplify",
             ]
             properties_filter = [
                 (key, value)
@@ -556,6 +572,8 @@ async def items(
                 offset=offset,
                 geom=geom_column,
                 dt=datetime_column,
+                bbox_only=bbox_only,
+                simplify=simplify,
             )
 
             qs = "?" + str(request.query_params) if request.query_params else ""

tifeatures/layer.py

@@ -12,14 +12,14 @@
 from pydantic import BaseModel, root_validator
 from pygeofilter.ast import AstType
 
+from tifeatures.dbmodel import GeometryColumn
 from tifeatures.dbmodel import Table as DBTable
 from tifeatures.errors import (
     InvalidDatetime,
     InvalidDatetimeColumnName,
     InvalidGeometryColumnName,
     InvalidPropertyName,
     MissingDatetimeColumn,
-    MissingGeometryColumn,
 )
 from tifeatures.filter.evaluate import to_filter
 from tifeatures.filter.filters import bbox_to_wkt
@@ -121,6 +121,39 @@ def _select_count(self):
     def _from(self):
         return clauses.From(self.id)
 
+    def _geom(
+        self,
+        geometry_column: Optional[GeometryColumn],
+        bbox_only: Optional[bool],
+        simplify: Optional[float],
+    ):
+        if geometry_column is None:
+            return pg_funcs.cast(None, "json")
+
+        g = logic.V(geometry_column.name)
+
+        if bbox_only:
+            g = logic.Func("ST_Envelope", g)
+
+        elif simplify:
+            g = logic.Func(
+                "ST_SnapToGrid",
+                logic.Func("ST_Simplify", g, simplify),
+                simplify,
+            )
+
+        if geometry_column.srid == 4326:
+            g = logic.Func("ST_AsGeoJson", g)
+
+        else:
+            g = logic.Func(
+                "ST_Transform",
+                logic.Func("ST_AsGeoJson", g),
+                4326,
+            )
+
+        return g
+
     def _where(
         self,
         ids: Optional[List[str]] = None,
@@ -304,13 +337,11 @@ async def query(
         dt: str = None,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
+        bbox_only: Optional[bool] = None,
+        simplify: Optional[float] = None,
     ) -> Tuple[FeatureCollection, int]:
         """Build and run Pg query."""
-        if not self.geometry_columns:
-            raise MissingGeometryColumn("Must have geometry column for geojson output.")
-
-        geometry_column = self.geometry_column(geom)
-        if not geometry_column:
+        if geom and geom.lower() != "none" and not self.geometry_column(geom):
             raise InvalidGeometryColumnName(f"Invalid Geometry Column: {geom}.")
 
         sql_query = """
@@ -327,13 +358,8 @@ async def query(
                     json_build_object(
                         'type', 'Feature',
                         'id', :id_column,
-                        'geometry', ST_AsGeoJSON(
-                            CASE
-                                WHEN :srid = 4326 THEN :geometry_column
-                                ELSE ST_Transform(:geometry_column, 4326)
-                            END
-                            )::json,
-                        'properties', to_jsonb( features.* ) - :geom_columns
+                        'geometry', :geometry_q,
+                        'properties', to_jsonb( features.* ) - :geom_columns::text[]
                     )
                 ),
                 'total_count', total_count.count
@@ -365,16 +391,17 @@ async def query(
                 dt=dt,
             ),
             id_column=logic.V(self.id_column),
-            srid=geometry_column.srid,
-            geometry_column=logic.V(geometry_column.name),
-            geom_columns=geometry_column.name,
+            geometry_q=self._geom(
+                geometry_column=self.geometry_column(geom),
+                bbox_only=bbox_only,
+                simplify=simplify,
+            ),
+            geom_columns=[g.name for g in self.geometry_columns],
         )
+
         async with pool.acquire() as conn:
             items = await conn.fetchval(q, *p)
 
-        # TODO:
-        # - make sure we always return features (even empty)
-        # - make sure we always return total_count
         if items:
             return (
                 FeatureCollection(features=items["features"]),