Raise a helpful error if Natural Earth data is not imported #1220
Comments
|
We could also extend the yaml files to say which tables or functions each layer expects to be present in the DB before it is imported. This way we can auto-generate the same checks for all layers, and prepend them to the sql files. |
|
Hi, does openmaptiles/openmaptiles-tools#370 actually fix this issue? Or are more changes needed on the openmaptiles side to update various yaml files with the Natural Earth dependencies? |
|
No this is not fixed. We provided only the funcunality now we need to add the required things in the layer.yaml |
|
@TomPohys please re-open ticket. |
|
@nyurik now we had added a check for the required tables / functions but it is still no helpful error message: It would be better if we show a message like |
|
Good point @Falke-Design, i guess we could add a generic error message at the top (simpler than to have a help text for each required table, and deal with duplicate messages, etc). requires:
helpText: "This layer requires tables generated with 'make import-data' command."
tables:
- osm_ocean_polygon
...I guess we could wrap the currently-generated code with something like this: do $$
begin
SELECT 'osm_ocean_polygon'::REGCLASS;
exception when others then -- I think we should use a specific error instead of "others" here
RAISE EXCEPTION SQLERRM USING HINT = 'This layer requires tables generated with "make import-data" command.' ;
end;
$$ language 'plpgsql';I think SQLERRM is what contains statement-specific error, and HINT will help with additional information. I haven't tested the above. Also note that hint will have to be quote-escaped. P.S. Maybe it is better to use |
Add `helpText` to `layer.requires` like discussed in openmaptiles/openmaptiles#1220 I had to change from `SELECT 'osm_ocean_polygon'::regclass;` to `PERFORM 'osm_ocean_polygon'::regclass;` because plpgsql needs a return value if `SELECT` is used. Also added an error if a function has no arguments: ``` when invalid_text_representation then RAISE EXCEPTION '%! The arguments of the required function "osmFunc" of the layer "water" are missing. Example: "osmFunc(text)"', SQLERRM; ``` Example: ``` layer: id: "water" requires: helpText: 'This is a text with "quotes"' functions: "osmFunc" tables: "osm_ocean_polygon" ``` SQL: ``` -- Assert osm_ocean_polygon exists do $$ begin PERFORM 'osm_ocean_polygon'::regclass; exception when undefined_table then RAISE EXCEPTION '%! This is error text with "quotes"', SQLERRM; end; $$ language 'plpgsql'; -- Assert osmFunc exists do $$ begin PERFORM 'osmFunc'::regprocedure; exception when undefined_function then RAISE EXCEPTION '%! This is a text with "quotes"', SQLERRM; when invalid_text_representation then RAISE EXCEPTION '%! The arguments of the required function "osmFunc" of the layer "water" are missing. Example: "osmFunc(text)"', SQLERRM; end; $$ language 'plpgsql'; ``` Result of `make import-sql`: > psql:/sql/parallel/water__waterway.sql:10: ERROR: relation "osm_ocean_polygon2" does not exist! This is a text with "quotes" Co-authored-by: Yuri Astrakhan <YuriAstrakhan@gmail.com>
|
@lazaa32 this is not fixed. The functions are now available but the error / help messages are still missing |
|
@Falke-Design sorry, weird, closed by accident when syncing my fork. Reopening. |
**NOTE** this can only be merged after the next tools version is released. Added required Postgres tables to the `<layer>.yaml` definition. Close: #1220 PR of tools: openmaptiles/openmaptiles-tools#370
During testing of #1213, it was noted that running
make import-sqlwithout having previously runmake import-datacauses a somewhat cryptic error message. Instead, we can add a check to the top of the SQL to verify that the Natural Earth tables are present, and raise a more helpful error message if they're missing.The text was updated successfully, but these errors were encountered: