Issue 54 location generic geometry by perrymanmd · Pull Request #151 · HydrologicEngineeringCenter/cwms-database

perrymanmd · 2026-05-12T13:55:47Z

PR Notes

Closes #54

TABLES

Addtional table AT_LOCATION_GEOMETRY

Column_Name	Data_Type	Nullable	Comments
LOCATION_CODE	NUMBER(14)	No	References location in AT_PHYSICAL_LOCATION table
GEOMETRY	SDO_GEOMETRY	No	Geometry of location¹
GEOMETRY_TYPE	NUMBER(2)	Yes	Type of geometry^{2, 3}
LATITUDE	NUMBER	Yes	Latitude if geometry type is 1, otherwise NULL^{2, 4}
LONGITUDE	NUMBER	Yes	Longitude if geometry type is 1, otherwise NULL^{2, 4}

¹ All GEOMETRY values are WGS 84 2-dimensional (SRID 4326).

² These fields are populated by trigger AT_LOCATION_GEOMETRY_T01.

³ Value will be one of:

Value	Description
1	GEOMETRY is a single point
2	GEOMETRY is a single line string
3	GEOMETRY is a single polygon
4	GEOMETRY is a heterogeneous collection of elements
5	GEOMETRY is multiple points
6	GEOMETRY is multiple line strings
7	GEOMETRY is multiple disjoint polygons

⁴ Values are in the datum specified in AT_PHYSICAL_LOCATION.HORIZONTAL_DATUM, if recognized. Otherwise they will be in WGS 84.

Modified table AT_PHYSICAL_LOCATION

The columns LATITUDE and LONGITUDE are removed
Trigger AT_PHYSICAL_LOCATION_T02 is dropped; it's function (populating COUNTY_CODE, NATION_CODE, NEAREST_CITY and OFFICE_CODE from LATITUDE and LONGITUDE) is replaced by trigger AT_LOCATION_GEOMETRY_T01

VIEWS

AV_LOC

Added columns GEOMETRY and GEOMETRY_TYPE (from AT_LOCATION_GEOMETRY) at end. Columns LATITUDE and LONGITUDE are NULL if GEOMETRY_TYPE is NULL or != 1
AV_LOC2

Added columns GEOMETRY and GEOMETRY_TYPE (from AT_LOCATION_GEOMETRY) at end. Columns LATITUDE and LONGITUDE are NULL if GEOMETRY_TYPE is NULL or != 1

TYPES

Modified LOCATION_OBJ_T

Removed LATITUDE and LONGITUDE fields
Added GEOMETRY and GEOMETRY_TYPE fields

PACKAGE SPECIFICATIONS

CWMS_LOC

Added STORE_LOCATION3 procedure which replaces the P_LATITUDE and P_LONGITUDE parameters of STORE_LOCATION2 with a single P_GEOMETRY parameter
Added RETRIEVE_LOCATION3 procedure which replaces the P_LATITUDE and P_LONGITUDE parameters of STORE_LOCATION2 with a single P_GEOMETRY parameter

Added STORE_GEOMETRY procedures

  procedure store_geometry(
      p_location_code  in number,
      p_geometry       in sdo_geometry,
      p_fail_if_exists in varchar2 default 'T');

  procedure store_geometry(
      p_location_id    in varchar2,
      p_geometry       in sdo_geometry,
      p_fail_if_exists in varchar2 default 'T',
      p_db_office_id   in varchar2);

Added RETRIEVE_GEOMETRY functions

  function retrieve_geometry(
      p_location_code in number)
      return sdo_geometry;

  function retrieve_geometry(
      p_location_id  in varchar2,
      p_db_office_id in varchar2)
      return sdo_geometry;

Added DELETE_GEOMETRY procedures

  procedure delete_geometry(
      p_location_code in number);

  procedure delete_geometry(
      p_location_id  in varchar2,
      p_db_office_id in varchar2);

Added GET_LOCATION_SRID function to retrieve a location's SRID based on its hoizontal datum (returns NULL if not recognized)
```
  function get_location_srid(
      p_location_code in number)
      return number;
```

Added GET_LOCATION_LAT_LON procedure, and GET_LOCATION_LAT and GET_LOCATION_LON functions to retrieve location latitude/longitude in various contexts.

  procedure get_location_lat_lon(
      p_lat in out nocopy at_location_geometry.latitude%type,
      p_lon in out nocopy at_location_geometry.latitude%type,
      p_location_code in number);

  function get_location_lat(
      p_location_code in at_physical_location.location_code%type)
      return at_location_geometry.latitude%type deterministic;

  function get_location_lon(
      p_location_code in at_physical_location.location_code%type)
      return at_location_geometry.latitude%type deterministic;

PACKAGE BODIES

CWMS_CAT

Modified query for CAT_LOCATION procedure
Modified query for CAT_LOCATION2 procedure

CWMS_EMBANK

Modified query for CAT_EMBANKMENT procedure

CWMS_LOC

Modified code in CREATE_LOCATION_RAW2 procedure
Modified code in UPDATE_LOCATION procedure
Modified code in UPDATE_LOCATION2 procedure
Modified code in RETRIEVE_LOCATION procedure
Modified code in RETRIEVE_LOCATION2 procedure
Modified code in RETRIEVE_LOCATIONS procedure
Modified code in GET_BOUNDING_OFC_CODE_FOR_LOC function
Modified code in GET_COUNTY_CODE_FOR_LOC function
Modified code in GET_NATION_ID_FOR_LOC function
Modified code in GET_NEAREST_CITY_FOR_LOC function
Modified code in GET_VERTICAL_DATUM_INFO procedure
Modified code in GET_VERTICAL_DATUM_OFFSET procedure
Added STORE_LOCATION3 procedure
Added RETRIEVE_LOCATION3 procedure
Added STORE_GEOMETRY procedures
Added RETRIEVE_GEOMETRY functions
Added DELETE_GEOMETRY procedures
Added GET_LOCATION_LAT_LON procedure
Added GET_LOCATION_LAT function
Added GET_LOCATION_LON function
Added GET_LOCATION_SRID function

CWMS_LOCK

Modified query for CAT_LOCK procedure
Modified code in RETRIEVE_LOCK_OLD procedure

CWMS_PROJECT

Modified query for CAT_PROJECT procedure
Modified code in RETRIEVE_PROJECT procedure

Update Script

Unlike a version update script, this one does not verify or update the CWMS schema version

The update script will transfer all LATITUDE and LONGITUDE values in the AT_PHYSICAL_LOCATION table to GEOMETRY values in the AT_LOCATION_GEOMETRY table.

If the LATITUDE or LONGITUDE value is null, the location will not have an entry in AT_LOCATION_GEOMETRY
If AT_PHYSICAL_LOCATION.HORIZONTAL_DATUM is recognized as valid, the GEOMETRY value will be properly converted to WGS 84.
If AT_PHYSICAL_LOCATION.HORIZONTAL_DATUM is NULL or not recognized, the GEOMETRY value will be created as if LATITUDE and LONGITUDE are in WGS 84.
The script stores a conversion note in AT_LATLON_CONVERSION, which can be dropped when it is no longer needed

The script outputs (via dbms_output) a summary of the conversions, similar to:

Latitude/Longitude to Geometry Conversion Results
================================================================================
  3988 locations	[okay   ] Already in WGS 84 (4326) - no conversion necessary
  1072 locations	[warning] No lat/long - geometry not created
   616 locations	[okay   ] Converted from NAD83 (4269) to WGS 84 (4326)
   588 locations	[warning] No horizontal datum - created geometry as WGS 84 (4326)
   429 locations	[okay   ] Converted from NAD27 (4267) to WGS 84 (4326)
    19 locations	[warning] Unknown horizontal datum (WSG84) - created geometry as WGS 84 (4326)
     1 locations	[warning] Unknown horizontal datum (WGS 83) - created geometry as WGS 84 (4326)

See table AT_LATLON_CONVERSION for details

Signed-off-by: mperryman2 <MPerryman@geiconsultants.com>

* fix spurious ', ' if null city or state * delete geometries of base locations to prevent non-null inheritance

…etry

…ests

…eric_geometry

Add conversion notes to update script

MikeNeilson

I have a few comments.

Going to need to come back to it later though... that was long.

MikeNeilson · 2026-05-12T18:52:19Z

+   l_srid mdsys.sdo_coord_ref_sys.srid%type;
+   l_geometry sdo_geometry;
+begin
+   if :new.geometry is null then


the column is not null, shouldn't this just fail before it gets to here?

MikeNeilson · 2026-05-12T18:59:22Z

+   location_code number(14) not null,
+   geometry      sdo_geometry not null,
+   geometry_type number(2),
+   latitude      number,


would it be better, perhaps from a index perspective to duplicate the centroid, to another geometry object so 2nd spatial index could be used?

NOTE: I'm assuming this is duplicated/shortcutting so the lat/long rendering is easier in the view for the lat/long columsn, so maybe both, or likely just overthinking it.

MikeNeilson · 2026-05-12T19:00:17Z

+            :new.longitude := l_geometry.sdo_point.x;
+         end if;
+      else
+         ------------------------


wouldn't pulling out the centroid here still be useful to get the nearest city?

MikeNeilson · 2026-05-12T19:08:01Z

+           loc.search_doc,
+           nvl (ll.geometry,         bll.geometry)      as geometry,
+           nvl (ll.geometry_type,    bll.geometry_type) as geometry_type
    from  -- join the base location metadata (bas) with the location (loc)


Suggested change

from -- join the base location metadata (bas) with the location (loc)

from cwms_20.at_physical_location loc

-- join the base location metadata (bas) with the location (loc)

left join cwms_20.at_physical_location bas on ( bas.location_code = loc.base_location_code )

left join cwms_20.at_base_location blo on ( blo.base_location_code = loc.base_location_code )

left outer join cwms_20.at_location_geometry ll on ( ll.location_code = loc.location_code )

left outer join cwms_20.at_location_geometry bll on ( bll.location_code = loc.base_location_code)

That was rather difficult to reason about with the joins all basically inline.

adamkorynta · 2026-05-15T16:57:14Z

-         and bp.base_parameter_id = 'Elev'
-         and u.unit_code = bp.unit_code;
-
+      select project_office_id,   -- varchar2(57)   the parent project's location id


missing db_office_id

adamkorynta · 2026-05-15T17:04:05Z

+                          v.nation_id,
+                          v.nearest_city
+                   FROM   av_loc v
+                  WHERE   v.db_office_id = l_db_office_id


Missing sub_location_id is NULL

adamkorynta · 2026-05-15T17:04:49Z

+                    AND   v.db_office_id = l_db_office_id
+                    AND   v.location_code = g.location_code
+                    AND   v.unit_system = 'SI' 
+                    AND   v.sub_location_id is null


this branch should not filter out base loc only

adamkorynta · 2026-05-15T17:09:56Z

+         p_db_office_id          => p_db_office_id);
+
+      if not cwms_util.return_true_or_false(p_ignorenulls) or p_geometry is not null then
+         store_geometry(


if ignore nulls is true and geometry is null, this will try to store a null geometry when the column is not nullable. Use probably intends to delete the geometry in this case.

adamkorynta · 2026-05-15T17:12:59Z

   county_name          VARCHAR2 (60),
   time_zone_name       VARCHAR2 (28),
   location_type        VARCHAR2 (32),
+   geometry             SDO_GEOMETRY,


move new fields to the end to avoid jOOQ codegen compatibility break or maybe overload?

adamkorynta · 2026-05-15T17:30:47Z

      END IF;

------------------------------------------
-- get the conversion factor and offset --


is the caching in cwms_util now faster than doing this join even with the pl/sql context switching?

adamkorynta · 2026-05-15T17:36:06Z

+                       l_geometry
+                      );
+         end;
+      end if;


Shouldn't the else case delete the geometry if not ignoring nulls?

adamkorynta · 2026-05-15T17:40:58Z

+           loc.search_doc,
+           nvl (ll.geometry,         bll.geometry)      as geometry,
+           nvl (decode(ll.geometry_type,  1,'POINT', 2,'LINE', 3,'POLYGON', 4,'COLLECTION', 5,'MULTIPOINT', 6,'MULTILINE', 7,'MULTIPOLYGON'),
+                decode(bll.geometry_type, 1,'POINT', 2,'LINE', 3,'POLYGON', 4,'COLLECTION', 5,'MULTIPOINT', 6,'MULTILINE', 7,'MULTIPOLYGON')) as geometry_type


confusing that geometry_type here is text, but at_location_geometry.geometry_type is numeric. might want to swap the table to be geometry_type_code or something similar

adamkorynta · 2026-05-15T17:46:40Z

+   --------------------------------------------------------------------------------
+   -- FUNCTION get_location_srid
+   --------------------------------------------------------------------------------
+   function get_location_srid(


can we cache the mapping of datum to srid?

adamkorynta · 2026-05-15T17:47:56Z

+                  geometry
+                 )
+          values (p_location_code,
+                  sdo_cs.transform(p_geometry, 4326)


does sdo_cs short circuit if srid is already 4326?

mperryman2 added 15 commits April 21, 2026 22:07

First cut of generic geometry with existing API

4b0e866

Signed-off-by: mperryman2 <MPerryman@geiconsultants.com>

Tweaks:

ceefc1f

* fix spurious ', ' if null city or state * delete geometries of base locations to prevent non-null inheritance

Work on catalogs

7c3c872

Add test for CWMS_LOCK.CAT_LOCK

596f33d

uncomment deleting locations when done with test

c16ad66

Test non-point geometries, Fix lat/lon inheritance for non-point geom…

60cc6af

…etry

Add store/retrieve_location3 routines (geom instead of lat/lon) and t…

4212359

…ests

add local overrides file to .gitignore

d0d4944

First cut at update script

bd1c257

fix typos in update script

d83872e

add spatial index on at_location_geometry to update script

892b4ad

bugfixes in update script

1a4d4e1

Merge remote-tracking branch 'origin/main' into issue_54-location_gen…

1d3b07f

…eric_geometry

Convert geometry to/from lat/lon using horizontal datum if possible

714a460

Add conversion notes to update script

Merge branch 'main' into issue_54-location_generic_geometry

53402b6

perrymanmd marked this pull request as draft May 12, 2026 13:55

mperryman2 added 2 commits May 12, 2026 15:02

Fix return type in GET_LOCATION_SRID

4f1a716

Fix typo in update script

3b2c828

perrymanmd marked this pull request as ready for review May 12, 2026 16:44

perrymanmd requested review from MikeNeilson and adamkorynta May 12, 2026 16:44

mperryman2 added 2 commits May 12, 2026 19:04

Merge branch 'main' into issue_54-location_generic_geometry

92fce6b

Change GEOMETRY_TYPE in AV_LOC and AV_LOC2 from integer to text

60ca141

MikeNeilson reviewed May 12, 2026

View reviewed changes

adamkorynta requested changes May 15, 2026

View reviewed changes

-    from  -- join the base location metadata (bas) with the location (loc)
+    from cwms_20.at_physical_location loc
+    -- join the base location metadata (bas) with the location (loc)
+    left join cwms_20.at_physical_location bas on ( bas.location_code = loc.base_location_code )
+    left join cwms_20.at_base_location blo on ( blo.base_location_code = loc.base_location_code )
+    left outer join cwms_20.at_location_geometry ll  on ( ll.location_code = loc.location_code )
+    left outer join cwms_20.at_location_geometry bll on ( bll.location_code = loc.base_location_code)

Conversation

perrymanmd commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Notes

TABLES

VIEWS

TYPES

PACKAGE SPECIFICATIONS

CWMS_LOC

PACKAGE BODIES

CWMS_CAT

CWMS_EMBANK

CWMS_LOC

CWMS_LOCK

CWMS_PROJECT

Update Script

Uh oh!

MikeNeilson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

perrymanmd commented May 12, 2026 •

edited

Loading