Merge pull request #143 from hrodmn/extents-optional

make calculating spatial/datetime extents optional

docs/src/user_guide/configuration.md

@@ -50,6 +50,8 @@ class: `tipg.settings.DatabaseSettings`
 prefix: **`TIPG_DB_`**
 
 - **SCHEMAS** (list of string): Named schemas, `tipg` can look for `Tables` or `Functions`. Default is `["public"]`
+- **SPATIAL_EXTENT** (bool): Calculate spatial extent of records. Default is `True`.
+- **DATETIME_EXTENT** (bool): Calculate temporal extent of records. Default is `True`.
 
 #### `Tables`
 

tests/conftest.py

@@ -119,6 +119,8 @@ async def lifespan(app: FastAPI):
             exclude_functions=db_settings.exclude_functions,
             exclude_function_schemas=db_settings.exclude_function_schemas,
             spatial=db_settings.only_spatial_tables,
+            spatial_extent=db_settings.spatial_extent,
+            datetime_extent=db_settings.datetime_extent,
         )
         yield
         await close_db_connection(app)
@@ -333,6 +335,58 @@ def app_myschema_public(database_url, monkeypatch):
         yield client
 
 
+@pytest.fixture
+def app_no_extents(database_url, monkeypatch):
+    """Create APP with tables from `myschema` and `public` schema but without
+    calculating the spatial/datetime extents.
+
+    Available tables should come from `myschema` and `public` and functions from `pg_temp`.
+    """
+    postgres_settings = PostgresSettings(database_url=database_url)
+    db_settings = DatabaseSettings(
+        schemas=["myschema", "public"],
+        spatial_extent=False,
+        datetime_extent=False,
+        only_spatial_tables=False,
+    )
+    sql_settings = CustomSQLSettings(custom_sql_directory=SQL_FUNCTIONS_DIRECTORY)
+
+    app = create_tipg_app(
+        postgres_settings=postgres_settings,
+        db_settings=db_settings,
+        sql_settings=sql_settings,
+    )
+
+    with TestClient(app) as client:
+        yield client
+
+
+@pytest.fixture
+def app_no_spatial_extent(database_url, monkeypatch):
+    """Create APP with tables from `myschema` and `public` schema but without
+    calculating the spatial/datetime extents.
+
+    Available tables should come from `myschema` and `public` and functions from `pg_temp`.
+    """
+    postgres_settings = PostgresSettings(database_url=database_url)
+    db_settings = DatabaseSettings(
+        schemas=["myschema", "public"],
+        spatial_extent=False,
+        datetime_extent=True,
+        only_spatial_tables=False,
+    )
+    sql_settings = CustomSQLSettings(custom_sql_directory=SQL_FUNCTIONS_DIRECTORY)
+
+    app = create_tipg_app(
+        postgres_settings=postgres_settings,
+        db_settings=db_settings,
+        sql_settings=sql_settings,
+    )
+
+    with TestClient(app) as client:
+        yield client
+
+
 @pytest.fixture
 def app_myschema_public_functions(database_url, monkeypatch):
     """Create APP with only tables from `myschema` schema and functions from `public` schema.

tests/routes/test_collections.py

@@ -281,3 +281,49 @@ def test_collections_empty(app_empty):
     assert response.status_code == 200
     body = response.json()
     assert not body["collections"]
+
+
+def test_collections_no_extents(app_no_extents):
+    """Test /collections endpoint."""
+    response = app_no_extents.get("/collections/public.landsat_wrs")
+    assert response.status_code == 200
+    body = response.json()
+    assert body["crs"] == ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]
+    assert body["extent"].get("spatial").get("bbox") == [
+        [
+            -180,
+            -90,
+            180,
+            90,
+        ]
+    ]  # default value
+    assert not body["extent"].get("temporal")
+
+    # check a table with datetime column
+    response = app_no_extents.get("/collections/public.nongeo_data")
+    assert response.status_code == 200
+    body = response.json()
+    assert not body.get("extent")
+
+
+def test_collections_no_spatial_extent(app_no_spatial_extent):
+    """Test /collections endpoint."""
+    response = app_no_spatial_extent.get("/collections/public.canada")
+    assert response.status_code == 200
+    body = response.json()
+    assert body["crs"] == ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]
+    assert body["extent"].get("spatial").get("bbox") == [
+        [
+            -180,
+            -90,
+            180,
+            90,
+        ]
+    ]
+
+    # check a table with datetime column
+    response = app_no_spatial_extent.get("/collections/public.nongeo_data")
+    assert response.status_code == 200
+    body = response.json()
+    assert not body["extent"].get("spatial")
+    assert body["extent"].get("temporal")

tipg/collections.py

@@ -907,6 +907,8 @@ async def get_collection_index(  # noqa: C901
     exclude_functions: Optional[List[str]] = None,
     exclude_function_schemas: Optional[List[str]] = None,
     spatial: bool = True,
+    spatial_extent: bool = True,
+    datetime_extent: bool = True,
 ) -> Catalog:
     """Fetch Table and Functions index."""
     schemas = schemas or ["public"]
@@ -920,7 +922,9 @@ async def get_collection_index(  # noqa: C901
             :functions,
             :exclude_functions,
             :exclude_function_schemas,
-            :spatial
+            :spatial,
+            :spatial_extent,
+            :datetime_extent
         );
     """  # noqa: W605
 
@@ -935,6 +939,8 @@ async def get_collection_index(  # noqa: C901
             exclude_functions=exclude_functions,
             exclude_function_schemas=exclude_function_schemas,
             spatial=spatial,
+            spatial_extent=spatial_extent,
+            datetime_extent=datetime_extent,
         )
 
         catalog: Dict[str, Collection] = {}

tipg/main.py

@@ -52,6 +52,8 @@ async def lifespan(app: FastAPI):
         exclude_functions=db_settings.exclude_functions,
         exclude_function_schemas=db_settings.exclude_function_schemas,
         spatial=db_settings.only_spatial_tables,
+        spatial_extent=db_settings.spatial_extent,
+        datetime_extent=db_settings.datetime_extent,
     )
 
     yield

tipg/settings.py

@@ -50,7 +50,6 @@ class TableSettings(BaseSettings):
 
     fallback_key_names: List[str] = ["ogc_fid", "id", "pkey", "gid"]
     table_config: Dict[str, TableConfig] = {}
-    datetime_extent: bool = True
 
     model_config = {
         "env_prefix": "TIPG_",
@@ -158,6 +157,8 @@ class DatabaseSettings(BaseSettings):
     functions: Optional[List[str]] = None
     exclude_functions: Optional[List[str]] = None
     exclude_function_schemas: Optional[List[str]] = None
+    datetime_extent: bool = True
+    spatial_extent: bool = True
 
     only_spatial_tables: bool = True
 

tipg/sql/dbcatalog.sql

@@ -31,7 +31,9 @@ CREATE OR REPLACE FUNCTION pg_temp.tipg_pk(
 $$ LANGUAGE SQL;
 
 CREATE OR REPLACE FUNCTION pg_temp.tipg_properties(
-    att pg_attribute
+    att pg_attribute,
+    spatial_extent boolean,
+    datetime_extent boolean
 ) RETURNS jsonb AS $$
 DECLARE
     attname text := att.attname;
@@ -48,7 +50,7 @@ DECLARE
     bounds_geom geometry;
     bounds float[];
 BEGIN
-    IF atttype IN ('timestamp', 'timestamptz') THEN
+    IF atttype IN ('timestamp', 'timestamptz') AND datetime_extent THEN
         EXECUTE FORMAT(
             $q$
                 SELECT to_json(min(%I::timestamptz)), to_json(max(%I::timestamptz))
@@ -62,28 +64,30 @@ BEGIN
         geometry_type := postgis_typmod_type(att.atttypmod);
         srid = coalesce(nullif(postgis_typmod_srid(att.atttypmod),0), 4326);
 
-        SELECT schemaname, relname, n_live_tup, n_mod_since_analyze
-        INTO _schemaname, _relname, _n_live_tup, _n_mod_since_analyze
-        FROM pg_stat_user_tables
-        WHERE relid = att.attrelid;
+        IF spatial_extent THEN
+            SELECT schemaname, relname, n_live_tup, n_mod_since_analyze
+            INTO _schemaname, _relname, _n_live_tup, _n_mod_since_analyze
+            FROM pg_stat_user_tables
+            WHERE relid = att.attrelid;
 
-        IF _n_live_tup > 0 AND _n_mod_since_analyze = 0 THEN
-            bounds_geom := st_setsrid(st_estimatedextent(_schemaname, _relname, attname), srid);
-        END IF;
+            IF _n_live_tup > 0 AND _n_mod_since_analyze = 0 THEN
+                bounds_geom := st_setsrid(st_estimatedextent(_schemaname, _relname, attname), srid);
+            END IF;
 
-        IF bounds_geom IS NULL THEN
-            IF atttype = 'geography' THEN
-                EXECUTE format('SELECT ST_SetSRID(ST_Extent(%I::geometry), %L) FROM %s', attname, srid, att.attrelid::regclass::text) INTO bounds_geom;
-            ELSE
-                EXECUTE format('SELECT ST_SetSRID(ST_Extent(%I), %L) FROM %s', attname, srid, att.attrelid::regclass::text) INTO bounds_geom;
+            IF bounds_geom IS NULL THEN
+                IF atttype = 'geography' THEN
+                    EXECUTE format('SELECT ST_SetSRID(ST_Extent(%I::geometry), %L) FROM %s', attname, srid, att.attrelid::regclass::text) INTO bounds_geom;
+                ELSE
+                    EXECUTE format('SELECT ST_SetSRID(ST_Extent(%I), %L) FROM %s', attname, srid, att.attrelid::regclass::text) INTO bounds_geom;
+                END IF;
             END IF;
-        END IF;
 
-        IF bounds_geom IS NOT NULL THEN
-            IF srid != 4326 THEN
-                bounds_geom := st_transform(bounds_geom, 4326);
+            IF bounds_geom IS NOT NULL THEN
+                IF srid != 4326 THEN
+                    bounds_geom := st_transform(bounds_geom, 4326);
+                END IF;
+                bounds = ARRAY[ st_xmin(bounds_geom), st_ymin(bounds_geom), st_xmax(bounds_geom), st_ymax(bounds_geom) ];
             END IF;
-            bounds = ARRAY[ st_xmin(bounds_geom), st_ymin(bounds_geom), st_xmax(bounds_geom), st_ymax(bounds_geom) ];
         END IF;
     END IF;
 
@@ -101,11 +105,13 @@ END;
 $$ LANGUAGE PLPGSQL;
 
 CREATE OR REPLACE FUNCTION pg_temp.tipg_tproperties(
-    c pg_class
+    c pg_class,
+    spatial_extent boolean,
+    datetime_extent boolean
 ) RETURNS jsonb AS $$
     WITH t AS (
         SELECT
-            jsonb_agg(pg_temp.tipg_properties(a)) as properties
+            jsonb_agg(pg_temp.tipg_properties(a, spatial_extent, datetime_extent)) as properties
         FROM
             pg_attribute a
         WHERE
@@ -123,9 +129,11 @@ CREATE OR REPLACE FUNCTION pg_temp.tipg_tproperties(
 $$ LANGUAGE SQL;
 
 CREATE OR REPLACE FUNCTION pg_temp.tipg_tproperties(
-    tabl text
+    tabl text,
+    spatial_extent boolean,
+    datetime_extent boolean
 ) RETURNS jsonb AS $$
-    SELECT pg_temp.tipg_tproperties(pg_class) FROM pg_class WHERE oid=tabl::regclass;
+    SELECT pg_temp.tipg_tproperties(pg_class, spatial_extent, datetime_extent) FROM pg_class WHERE oid=tabl::regclass;
 $$ LANGUAGE SQL;
 
 CREATE OR REPLACE FUNCTION pg_temp.tipg_fun_defaults(defaults pg_node_tree) RETURNS text[] AS $$
@@ -235,11 +243,13 @@ CREATE OR REPLACE FUNCTION pg_temp.tipg_catalog(
     functions text[] DEFAULT NULL,
     exclude_functions text[] DEFAULT NULL,
     exclude_function_schemas text[] DEFAULT NULL,
-    spatial boolean DEFAULT FALSE
+    spatial boolean DEFAULT FALSE,
+    spatial_extent boolean DEFAULT TRUE,
+    datetime_extent boolean DEFAULT TRUE
 ) RETURNS SETOF jsonb AS $$
     WITH a AS (
         SELECT
-            pg_temp.tipg_tproperties(c) as meta
+            pg_temp.tipg_tproperties(c, spatial_extent, datetime_extent) as meta
         FROM pg_class c, pg_temp.tipg_get_schemas(schemas,exclude_table_schemas) s
         WHERE
             c.relnamespace=s